Get Started with the CLI

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Overview

The OKD CLI exposes commands for managing your applications, as well as lower level tools to interact with each component of your system. This topic guides you through getting started with the CLI, including installation and logging in to create your first project.

Prerequisites

Certain operations require Git to be locally installed on a client. For example, the command to create an application using a remote Git repository:

  1. $ oc new-app https://github.com/<your_user>/<your_git_repo>

Before proceeding, install Git on your workstation. See the official Git documentation for instructions per your workstation’s operating system.

Installing the CLI

The easiest way to download the CLI is by accessing the About page on the web console if your cluster administrator has enabled the download links:

Command Line Tools

Installation options for the CLI vary depending on your operating system.

To log in using the CLI, collect your token from the web console’s Command Line page, which is accessed from Command Line Tools in the Help menu. The token is hidden, so you must click the copy to clipboard button at the end of the oc login line on the Command Line Tools page, then paste the copied contents to show the token.

For Windows

The CLI for Windows is provided as a zip archive; you can download it from the Releases page of the OpenShift Origin source repository on GitHub:

Download the CLI from GitHub Alternatively, if the cluster administrator has enabled it, you can download and unpack the CLI from the About page on the web console.

Then, unzip the archive with a ZIP program and move the oc binary to a directory on your PATH. To check your PATH, open the Command Prompt and run:

  1. C:\> path

For Mac OS X

The CLI for Mac OS X is provided as a zip archive; you can download it from the Releases page of the OpenShift Origin source repository on GitHub:

Download the CLI from GitHub

Alternatively, if the cluster administrator has enabled it, you can download and unpack the CLI from the About page on the web console.

Then, unzip the archive with a ZIP program and move the oc binary to a directory on your PATH. To check your PATH, open a Terminal window and run:

  1. $ echo $PATH

Alternatively, Mac OS X users can install the CLI using Homebrew:

  1. $ brew install openshift-cli

For Linux

The CLI for Linux is provided as a tar.gz archive; you can download it from the Releases page of the OpenShift Origin source repository on GitHub:

Download the CLI from GitHub

Alternatively, if the cluster administrator has enabled it, you can download and unpack the CLI from the About page on the web console.

Then, unpack the archive and move the oc binary to a directory on your PATH. To check your path, run:

  1. $ echo $PATH

To unpack the archive:

  1. $ tar -xf <file>

If you do not use RHEL or Fedora, ensure that libc is installed in a directory on your library path. If libc is not available, you might see the following error when you run CLI commands:

  1. oc: No such file or directory

Basic Setup and Login

The oc login command is the best way to initially set up the CLI, and it serves as the entry point for most users. The interactive flow helps you establish a session to an OKD server with the provided credentials. The information is automatically saved in a CLI configuration file that is then used for subsequent commands.

The following example shows the interactive setup and login using the oc login command:

Example 1. Initial CLI Setup

  1. $ oc login
  2. OpenShift server [https://localhost:8443]: https://openshift.example.com (1)
  4. Username: alice (2)
  5. Authentication required for https://openshift.example.com (openshift)
  6. Password: ******
  7. Login successful. (3)
  9. You don't have any projects. You can try to create a new project, by running
  11.     $ oc new-project <projectname> (4)
  13. Welcome to OpenShift! See 'oc help' to get started.
1The command prompts for the OKD server URL.
2The command prompts for login credentials: a user name and password.
3A session is established with the server, and a session token is received.
4If you do not have a project, information is given on how to create one.

When you have completed the CLI configuration, subsequent commands use the configuration file for the server, session token, and project information.

You can log out of CLI using the oc logout command:

  1. $ oc logout
  2. User, alice, logged out of https://openshift.example.com

If you log in after creating or being granted access to a project, a project you have access to is automatically set as the current default, until switching to another one:

  1. $ oc login
  2. Username: alice
  3. Authentication required for https://openshift.example.com (openshift)
  4. Password:
  5. Login successful.
  7. Using project "aliceproject".

Additional options are also available for the oc login command.

If you have access to administrator credentials but are no longer logged in as the default system user system:admin, you can log back in as this user at any time as long as the credentials are still present in your CLI configuration file. The following command logs in and switches to the default project:

  1. $ oc login -u system:admin -n default

CLI Configuration Files

A CLI configuration file permanently stores oc options and contains a series of authentication mechanisms and OKD server connection information associated with nicknames.

As described in the previous section, the oc login command automatically creates and manages CLI configuration files. All information gathered by the command is stored in a configuration file located in ~/.kube/config. The current CLI configuration can be viewed using the following command:

Example 2. Viewing the CLI Configuration

  1. $ oc config view
  2. apiVersion: v1
  3. clusters:
  4. - cluster:
  5.     server: https://openshift.example.com
  6.   name: openshift
  7. contexts:
  8. - context:
  9.     cluster: openshift
  10.     namespace: aliceproject
  11.     user: alice
  12.   name: alice
  13. current-context: alice
  14. kind: Config
  15. preferences: {}
  16. users:
  17. - name: alice
  18.   user:
  19.     token: NDM2N2MwODgtNjI1Yy10N3VhLTg1YmItYzI4NDEzZDUyYzVi

CLI configuration files can be used to setup multiple CLI profiles using various OKD servers, namespaces, and users so that you can switch easily between them. The CLI can support multiple configuration files; they are loaded at runtime and merged together along with any override options specified from the command line.

Projects

A project in OKD contains multiple objects to make up a logical application.

Most oc commands run in the context of a project. The oc login selects a default project during initial setup to be used with subsequent commands. Use the following command to display the project currently in use:

  1. $ oc project

If you have access to multiple projects, use the following syntax to switch to a particular project by specifying the project name:

  1. $ oc project <project_name>

For example:

  1. $ oc project project02
  2. Now using project 'project02'.
  4. $ oc project project03
  5. Now using project 'project03'.
  7. $ oc project
  8. Using project 'project03'.

The oc status command shows a high level overview of the project currently in use, with its components and their relationships, as shown in the following example:

  1. $ oc status
  2. In project OpenShift 3 Sample (test)
  4. service database-test (172.30.17.113:6434 -> 3306)
  5.   database-test deploys docker.io/library/mysql:latest
  6.     #1 deployed 47 hours ago
  8. service frontend-test (172.30.17.236:5432 -> 8080)
  9.   frontend-test deploys origin-ruby-sample:test <-
  10.     builds https://github.com/openshift/ruby-hello-world with docker.io/openshift/ruby-20-centos7:latest
  11.     not built yet
  12.     #1 deployment waiting on image
  14. To see more information about a service or deployment config, use 'oc describe service <name>' or 'oc describe dc <name>'.
  15. You can use 'oc get pods,svc,dc,bc,builds' to see lists of each of the types described above.

What’s Next?

After you have logged in, you can create a new application and explore some common CLI operations.