Red Hat SummitThis documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Este conteúdo não está disponível no idioma selecionado.
Chapter 5. Administrator CLI Operations
5.1. Overview
This topic provides information on the administrator CLI operations and their syntax. You must setup and login with the CLI before you can perform these operations.
The openshift command is used for starting services that make up the OpenShift Container Platform cluster. For example, openshift start [master|node]. However, it is also an all-in-one command that can perform all the same actions as the oc and oc adm commands via openshift cli and openshift admin respectively.
The administrator CLI differs from the normal set of commands under the developer CLI, which uses the oc command, and is used more for project-level operations.
5.2. Common Operations
The administrator CLI allows interaction with the various objects that are managed by OpenShift Container Platform. Many common oc adm operations are invoked using the following syntax:
oc adm <action> <option>
$ oc adm <action> <option>This specifies:
-
An
<action>to perform, such asnew-projectorgroups. -
An available
<option>to perform the action on as well as a value for the option. Options include--output.
When running oc adm commands, you should run them only from the first master listed in the Ansible host inventory file, by default /etc/ansible/hosts.
5.3. Basic CLI Operations
5.3.1. new-project
Creates a new project:
oc adm new-project <project_name>
$ oc adm new-project <project_name>5.3.2. policy
Manages authorization policies:
oc adm policy
$ oc adm policy5.3.3. groups
Manages groups:
oc adm groups
$ oc adm groups5.4. Install CLI Operations
5.4.1. router
Installs a router:
ocadm router <router_name>
$ ocadm router <router_name>5.4.2. ipfailover
Installs an IP failover group for a set of nodes:
oc adm ipfailover <ipfailover_config>
$ oc adm ipfailover <ipfailover_config>5.4.3. registry
Installs an integrated container registry:
oc adm registry
$ oc adm registry5.5. Maintenance CLI Operations
5.5.1. build-chain
Outputs the inputs and dependencies of any builds:
oc adm build-chain <image_stream>[:<tag>]
$ oc adm build-chain <image_stream>[:<tag>]5.5.2. manage-node
Manages nodes. For example, list or evacuate pods, or mark them ready:
oc adm manage-node
$ oc adm manage-node5.5.3. prune
Removes older versions of resources from the server:
oc adm prune
$ oc adm prune5.6. Settings CLI Operations
5.6.1. config
Changes kubelet configuration files:
oc adm config <subcommand>
$ oc adm config <subcommand>5.6.2. create-kubeconfig
Creates a basic .kubeconfig file from client certificates:
oc adm create-kubeconfig
$ oc adm create-kubeconfig5.6.3. create-api-client-config
Creates a configuration file for connecting to the server as a user:
oc adm create-api-client-config
$ oc adm create-api-client-config5.7. Advanced CLI Operations
5.7.1. create-bootstrap-project-template
Creates a bootstrap project template:
oc adm create-bootstrap-project-template
$ oc adm create-bootstrap-project-template5.7.2. create-bootstrap-policy-file
Creates the default bootstrap policy:
oc adm create-bootstrap-policy-file
$ oc adm create-bootstrap-policy-file5.7.3. create-login-template
Creates a login template:
oc adm create-login-template
$ oc adm create-login-template5.7.4. overwrite-policy
Resets the policy to the default values:
oc adm overwrite-policy
$ oc adm overwrite-policy5.7.5. create-node-config
Creates a configuration bundle for a node:
oc adm create-node-config
$ oc adm create-node-config5.7.6. ca
Manages certificates and keys:
oc adm ca
$ oc adm ca5.8. Other CLI Operations
5.8.1. version
Displays the version of the indicated object:
oc adm version
$ oc adm version5.8.2. help
Displays help about any command:
oc adm help <command>
$ oc adm help <command>
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}