Chapter 1. Getting started with the CLI

• Work directly with project source code.
• Script OpenShift Container Platform operations.
• Are restricted by bandwidth resources and can not use the web console.

Prerequisites

• You must have access to an OpenShift Container Platform cluster.
• You must have installed the CLI.

Procedure

• Log in to the CLI using the oc login command and enter the required information when prompted.

  $ oc login
  Server [https://localhost:8443]: https://openshift.example.com:6443 

  1

  
  The server uses a certificate signed by an unknown authority.
  You can bypass the certificate check, but any data you send to the server could be intercepted by others.
  Use insecure connections? (y/n): y 

  2

  
  
  Authentication required for https://openshift.example.com:6443 (openshift)
  Username: user1 

  3

  
  Password: 

  4

  
  Login successful.
  
  You don't have any projects. You can try to create a new project, by running
  
      oc new-project <projectname>
  
  Welcome! See 'oc help' to get started.

  Copy to Clipboard Toggle word wrap

  1

  Enter the OpenShift Container Platform server URL.

  2

  Enter whether to use insecure connections.

  3

  Enter the user name to log in as.

  4

  Enter the user’s password.

• Use oc help to get a list and description of all available CLI commands:

  Example: Get general help for the CLI

  $ oc help
  OpenShift Client
  
  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 'adm' subcommand.
  
  Usage:
    oc [flags]
  
  Basic Commands:
    login           Log in to a server
    new-project     Request a new project
    new-app         Create a new application
  
  ...

  Copy to Clipboard Toggle word wrap

• Use the --help flag to get help about a specific CLI command:

  Example: Get help for the oc create command

  $ oc create --help
  Create a resource by filename or stdin
  
  JSON and YAML formats are accepted.
  
  Usage:
    oc create -f FILENAME [flags]
  
  ...

  Copy to Clipboard Toggle word wrap

• Use the oc explain command to view the description and fields for a particular resource:

  Example: View documentation for the Pod resource

  $ oc explain pods
  KIND:     Pod
  VERSION:  v1
  
  DESCRIPTION:
       Pod is a collection of containers that can run on a host. This resource is
       created by clients and scheduled onto hosts.
  
  FIELDS:
     apiVersion	<string>
       APIVersion defines the versioned schema of this representation of an
       object. Servers should convert recognized schemas to the latest internal
       value, and may reject unrecognized values. More info:
       https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
  
  ...

  Copy to Clipboard Toggle word wrap

• Use the oc logout command.

  $ oc logout
  Logged "user1" out on "https://openshift.example.com"

  Copy to Clipboard Toggle word wrap