OADM GROUPS(1)

NAME

oadm groups sync - Sync OpenShift groups with records from an external provider.

SYNOPSIS

oadm groups sync [OPTIONS]

DESCRIPTION

Sync OpenShift Groups with records from an external provider.

In order to sync OpenShift Group records with those from an external provider, determine which Groups you wish to sync and where their records live. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously, or similarly all or some groups may be selected from those stored on an LDAP server. The path to a sync configuration file is required in order to describe how data is requested from the external record store and migrated to OpenShift records. Default behavior is to do a dry-run without changing OpenShift records. Passing '--confirm' will sync all groups from the LDAP server returned by the LDAP query templates.

OPTIONS

--allow-missing-template-keys=true
    If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

--blacklist=""
    path to the group blacklist file

--confirm=false
    if true, modify OpenShift groups; if false, display results of a dry-run

--no-headers=false
    When using the default or custom-column output format, don't print headers.

-o, --output="yaml"
    Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [ ⟨http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns⟩], golang template [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩] and jsonpath template [ ⟨http://kubernetes.io/docs/user-guide/jsonpath⟩].

--output-version=""
    Output the formatted object with the given group version (for ex: 'extensions/v1beta1').

-a, --show-all=false
    When printing, show all resources (default hide terminated pods.)

--show-labels=false
    When printing, show all labels as the last column (default hide labels column)

--sort-by=""
    If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.

--sync-config=""
    path to the sync config

--template=""
    Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].

--type="ldap"
    which groups white- and blacklist entries refer to: ldap,openshift

--whitelist=""
    path to the group whitelist file

OPTIONS INHERITED FROM PARENT COMMANDS

--api-version=""
    DEPRECATED: The API version to use when talking to the server

--as=""
    Username to impersonate for the operation

--azure-container-registry-config=""
    Path to the file container Azure container registry configuration information.

--certificate-authority=""
    Path to a cert. file for the certificate authority

--client-certificate=""
    Path to a client certificate file for TLS

--client-key=""
    Path to a client key file for TLS

--cluster=""
    The name of the kubeconfig cluster to use

--config=""
    Path to the config file to use for CLI requests.

--context=""
    The name of the kubeconfig context to use

--google-json-key=""
    The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false
    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--log-flush-frequency=0
    Maximum number of seconds between log flushes

--match-server-version=false
    Require server version to match client version

-n, --namespace=""
    If present, the namespace scope for this CLI request

--request-timeout="0"
    The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

--server=""
    The address and port of the Kubernetes API server

--token=""
    Bearer token for authentication to the API server

--user=""
    The name of the kubeconfig user to use

EXAMPLE

      # Sync all groups from an LDAP server
      oadm groups sync --sync-config=/path/to/ldap-sync-config.yaml --confirm

      # Sync all groups except the ones from the blacklist file from an LDAP server
      oadm groups sync --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm

      # Sync specific groups specified in a whitelist file with an LDAP server
      oadm groups sync --whitelist=/path/to/whitelist.txt --sync-config=/path/to/sync-config.yaml --confirm

      # Sync all OpenShift Groups that have been synced previously with an LDAP server
      oadm groups sync --type=openshift --sync-config=/path/to/ldap-sync-config.yaml --confirm

      # Sync specific OpenShift Groups if they have been synced previously with an LDAP server
      oadm groups sync groups/group1 groups/group2 groups/group3 --sync-config=/path/to/sync-config.yaml --confirm

SEE ALSO

oadm-groups(1),

HISTORY

June 2016, Ported from the Kubernetes man-doc generator