OpenShift CLI Operations is capable of performing all basic and advanced configuration, management, addition, and deployment of applications.
We can perform different kinds of operations using OC commands. This client helps you develop, build, deploy, and run your applications on any OpenShift or Kubernetes compatible platform. It also includes the administrative commands for managing a cluster under the ‘arm’s subcommand.
Basic Commands Of OpenShift CLI Operations
The following table lists the basic OC commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | types introduction to concepts and type |
| 2 | log in log in to a server |
| 3 | new-project request a new project |
| 4 | new-app Create a new application |
| 5 | Status Show an overview of the current project |
| 6 | Project Switch to another project |
| 7 | Projects Display existing projects |
| 8 | Explain Documentation of resources |
| 9 | Cluster Start and stop OpenShift cluster |
Login
Log in to your server and save the login for subsequent use. First-time users of the client should run this command to connect to a server, establish an authenticated session, and save a connection to the configuration file. The default configuration will be saved to your home directory under “.kube/config”.
The information required to log in — like username and password, a session token, or the server details can be provided through flags. If not provided, the command will prompt for user input as needed.
Usage
oc login [URL] [options]
Example
# Log in interactively oc login # Log in to the given server with the given certificate authority file oc login localhost:8443 --certificate-authority = /path/to/cert.crt # Log in to the given server with the given credentials (will not prompt interactively) oc login localhost:8443 --username = myuser --password=mypass
Options −
-p, –password = “ − Password, will prompt if not provided
-u, –username = “ − Username, will prompt if not provided
–certificate-authority = “ − Path to a cert. file for the certificate authority
–insecure-skip-tls-verify = false − If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure
–token = “ − Bearer token for authentication to the API server
To get the complete details regarding any command, use the oc <Command Name> –help command.
Build and Deploy Commands
The following table lists the build and deploys commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | RolloutManage a Kubernetes deployment or OpenShift deploy |
| 2 | Deploy View, start, cancel, or retry a deployment |
| 3 | Rollback Revert part of an application back to the previous state |
| 4 | new-build Create a new build configuration |
| 5 | start-build Start a new build |
| 6 | cancel-build Cancel running, pending, or new builds |
| 7 | import-image Imports images from a Docker registry |
| 8 | Tag the existing images into image streams |
Application Management Commands
The following table lists the application management commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | GetDisplay one or many resources |
| 2 | Describe Show details of a specific resource or a group of resources |
| 3 | Edit a resource on the server |
| 4 | set commands that help set specific features on objects |
| 5 | Labe update the labels on a resource |
| 6 | AnnotateUpdate the annotations on a resource |
| 7 | ExposeExpose a replicated application as a service or route |
| 8 | DeleteDelete one or more resources |
| 9 | ScaleChange the number of pods in a deployment |
| 10 | AutoscaleAutoscale a deployment config, deployment, replication, Controller or replica set |
| 11 | SecretsManage secrets |
| 12 | ServiceaccountsManage service accounts in your project |
Troubleshooting and Debugging Commands
The following table lists the troubleshooting and debugging commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | logsPrint the logs for a resource |
| 2 | Rsh Start a shell session in a pod |
| 3 | RsyncCopy files between the local filesystem and a pod |
| 4 | port-forward forward one or more local ports to a pod |
| 5 | DebugLaunch a new instance of a pod for debugging |
| 6 | ExecExecute a command in a container |
| 7 | Proxy Run a proxy to the Kubernetes API server |
| 9 | AttachAttach to a running container |
| 10 | Run a particular image on the cluster |
| 11 | Cp Copy files and directories to and from containers |
Advanced Commands
The following table lists the advanced commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | admTools for managing a cluster |
| 2 | create create a resource by filename or stdin |
| 3 | replace a resource by filename or stdin |
| 4 | apply a configuration to a resource by filename or stdin |
| 5 | patch update field(s) of a resource using strategic merge patch |
| 6 | process a template into list of resources |
| 7 | export resources so they can be used elsewhere |
| 8 | extractExtract secrets or config maps to disk |
| 9 | idleIdle scalable resources |
| 10 | observe changes to the resources and react to them (experimental) |
| 11 | policyManage authorization policy |
| 12 | auto inspect authorization |
| 13 | convert config files between different API versions |
| 14 | import commands that import applications |
Setting Commands
The following table lists the set commands.
| Sr.No. | Commands & Description |
|---|---|
| 1 | LogoutEnd the current server session |
| 2 | ConfigChange the configuration files for the client |
| 3 | WhoamiReturn information about the current session |
| 4 | CompletionOutput shell completion code for the specified shell (bash or zsh) |
Next Topic – Click Here
Pingback: OpenShift - CLI - Adglob Infosystem Pvt Ltd