OPENSHIFT ADMIN GROUPS(1)

NAME

openshift admin groups prune - Prune OpenShift groups referencing missing records on an external provider.

SYNOPSIS

openshift admin groups prune [OPTIONS]

DESCRIPTION

Prune OpenShift Groups referencing missing records on from an external provider.

In order to prune OpenShift Group records using those from an external provider, determine which Groups you wish to prune. For instance, all or some groups may be selected from the current Groups stored in OpenShift that have been synced previously. Any combination of a literal whitelist, a whitelist file and a blacklist file is supported. The path to a sync configuration file that was used for syncing the groups in question is required in order to describe how data is requested from the external record store. Default behavior is to indicate all OpenShift groups for which the external record does not exist, to run the pruning process and commit the results, use the --confirm flag.

OPTIONS

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

--confirm=false
    if true, modify OpenShift groups; if false, display groups

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

--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.

--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.

--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

      # Prune all orphaned groups
      openshift admin groups prune --sync-config=/path/to/ldap-sync-config.yaml --confirm
      # Prune all orphaned groups except the ones from the blacklist file
      openshift admin groups prune --blacklist=/path/to/blacklist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
      # Prune all orphaned groups from a list of specific groups specified in a whitelist file
      openshift admin groups prune --whitelist=/path/to/whitelist.txt --sync-config=/path/to/ldap-sync-config.yaml --confirm
      # Prune all orphaned groups from a list of specific groups specified in a whitelist
      openshift admin groups prune groups/group_name groups/other_name --sync-config=/path/to/ldap-sync-config.yaml --confirm

SEE ALSO

openshift-admin-groups(1),

HISTORY

June 2016, Ported from the Kubernetes man-doc generator