CLI リファレンス

例: Pod のドキュメントの表示

$ oc explain pods

例: 対話型ログイン

$ oc login

例: ユーザー名を指定したログイン

$ oc login -u user1

例: ローカル Git リポジトリーからの新規アプリケーションの作成

$ oc new-app .

例: リモート Git リポジトリーからの新規アプリケーションの作成

$ oc new-app https://github.com/sclorg/cakephp-ex

例: プライベートリモートリポジトリーからの新規アプリケーションの作成

$ oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret

例: 新規プロジェクトの作成

$ oc new-project myproject

例: 別のプロジェクトへの切り替え

$ oc project test-project

例: すべてのプロジェクトの一覧表示

$ oc projects

例: 現在のプロジェクトのステータスの表示

$ oc status

例：ビルドの取り消し

$ oc cancel-build python-1

例: python BuildConfig からの保留中のすべてのビルドの取り消し

$ oc cancel-build buildconfig/python --state=pending

例: 最新のイメージ情報のインポート

$ oc import-image my-ruby

例: ローカル Git リポジトリーからの BuildConfig の作成

$ oc new-build .

例: リモート Git リポジトリーからの BuildConfig の作成

$ oc new-build https://github.com/sclorg/cakephp-ex

例: 最後に成功したデプロイメントへのロールバック

$ oc rollback php

例: 特定バージョンへのロールバック

$ oc rollback php --to-version=3

例: 最後に成功したデプロイメントへのロールバック

$ oc rollout undo deploymentconfig/php

例: 最新状態の DeploymentConfig の新規ロールアウトの開始

$ oc rollout latest deploymentconfig/php

例: 指定された BuildConfig からのビルドの開始

$ oc start-build python

例: 以前のビルドからのビルドの開始

$ oc start-build --from-build=python-1

例: 現在のビルドに使用する環境変数の設定

$ oc start-build python --env=mykey=myvalue

例: ruby イメージの latest タグを 2.0 タグのイメージを参照するように設定する

$ oc tag ruby:latest ruby:2.0

例: アノテーションのルートへの追加

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"

例: ルートからのアノテーションの削除

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-

例: pod.json の設定の Pod への適用

$ oc apply -f pod.json

例: 最小の 2 つおよび最大の 5 つの Pod への自動スケーリング

$ oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5

例: pod.json の内容を使用した Pod の作成

$ oc create -f pod.json

例: parksmap-katacoda-1-qfqz4 という名前の Pod の削除

$ oc delete pod/parksmap-katacoda-1-qfqz4

例: app=parksmap-katacoda ラベルの付いたすべての Pod の削除

$ oc delete pods -l app=parksmap-katacoda

例: example という名前のデプロイメントの記述

$ oc describe deployment/example

例: すべての Pod の記述

$ oc describe pods

例: デフォルトエディターを使用した DeploymentConfig の編集

$ oc edit deploymentconfig/parksmap-katacoda

例: 異なるエディターを使用した DeploymentConfig の編集

$ OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda

例: JSON 形式の DeploymentConfig の編集

$ oc edit deploymentconfig/parksmap-katacoda -o json

例: サービスの公開

$ oc expose service/parksmap-katacoda

例: サービスの公開およびホスト名の指定

$ oc expose service/parksmap-katacoda --hostname=www.my-host.com

例: default namespace の Pod の一覧表示

$ oc get pods -n default

例: JSON 形式の python DeploymentConfig についての詳細の取得

$ oc get deploymentconfig/python -o json

例: python-1-mz2rf Pod の unhealthy に設定されたラベル status での更新

$ oc label pod/python-1-mz2rf status=unhealthy

例: ruby-app DeploymentConfig の 3 つの Pod へのスケーリング

$ oc scale deploymentconfig/ruby-app --replicas=3

例: my-pull-secret の、default サービスアカウントによるイメージプルシークレットとしての使用を許可

$ oc secrets link default my-pull-secret --for=pull

例: default サービスアカウントに割り当てられたトークンの取得

$ oc serviceaccounts get-token default

例: BuildConfig でのシークレットの名前の設定

$ oc set build-secret --source buildconfig/mybc mysecret

例: Pod python-1-mz2rf の python コンテナーからの出力の取得

$ oc attach python-1-mz2rf -c python

例: python-1-mz2rf Pod からローカルファイルシステムへのファイルのコピー

$ oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.

例: python デプロイメントのデバッグ

$ oc debug deploymentconfig/python

例: ls コマンドの Pod python-1-mz2rf の python コンテナーでの実行

$ oc exec python-1-mz2rf -c python ls

例: python DeploymentConfig からの最新ログのストリーミング

$ oc logs -f deploymentconfig/python

例: ポート 8888 でのローカルのリッスンおよび Pod のポート 5000 への転送

$ oc port-forward python-1-mz2rf 8888:5000

例: ./local/www/ から静的コンテンツを提供するポート 8011 の API サーバーに対するプロキシーの実行

$ oc proxy --port=8011 --www=./local/www/

例: python-1-mz2rf Pod の最初のコンテナーでシェルセッションを開く

$ oc rsh python-1-mz2rf

例: ローカルディレクトリーのファイルの Pod ディレクトリーとの同期

$ oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/

例: 3 つのレプリカを持つ perl イメージのインスタンスの開始

$ oc run my-test --image=perl --replicas=3

例: python-1-mz2rf Pod の削除の待機

$ oc wait --for=delete pod/python-1-mz2rf

例: サポートされている API リソースの一覧表示

$ oc api-resources

例: サポートされている API バージョンの一覧表示

$ oc api-versions

例: 現行ユーザーが Pod ログを読み取ることができるかどうかのチェック

$ oc auth can-i get pods --subresource=log

例: ファイルの RBAC ロールおよびパーミッションの調整

$ oc auth reconcile -f policy.json

例: クラスター情報の表示

$ oc cluster-info

例: pod.yaml の最新バージョンへの変換

$ oc convert -f pod.yaml

例: ruby-1-ca ConfigMap の内容の現行ディレクトリーへのダウンロード

$ oc extract configmap/ruby-1-ca

例: ruby-1-ca ConfigMap の内容の標準出力 (stdout) への出力

$ oc extract configmap/ruby-1-ca --to=-

例: ruby-app サービスのアイドリング

$ oc idle ruby-app

例: イメージの別のタグへのコピー

$ oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable

例: サービスへの変更の監視

$ oc observe services

例: ノード node1 の spec.unschedulable フィールドの true への更新

$ oc patch node/node1 -p '{"spec":{"unschedulable":true}}'

例: edit ロールの現在のプロジェクトの user1 への追加

$ oc policy add-role-to-user edit user1

例: template.json をリソース一覧に変換し、 oc create に渡す

$ oc process -f template.json | oc create -f -

例: 統合レジストリーについての情報の表示

$ oc registry info

例: pod.json の内容を使用した Pod の更新

$ oc replace -f pod.json

例: Bash の補完コードの表示

$ oc completion bash

例: 現在の設定の表示

$ oc config view

例: 別のコンテキストへの切り替え

$ oc config use-context test-context

例: 現行セッションの終了

$ oc logout

例: 現行の認証ユーザーの表示

$ oc whoami

例: 利用可能なコマンドの表示

$ oc help

例: new-project コマンドのヘルプの表示

$ oc help new-project

例: 利用可能なプラグインの一覧表示

$ oc plugin list

例: バージョン情報の表示

$ oc version

例: デバッグ情報の収集

$ oc adm must-gather

例: Pod の CPU およびメモリーの使用状況の表示

$ oc adm top pods

例: イメージの使用状況の統計の表示

$ oc adm top images

例: node1 にスケジュール対象外のマークを付ける

$ oc adm cordon node1

例: node1 のドレイン (解放)

$ oc adm drain node1

例: NetworkManager のログの取得

$ oc adm node-logs --role master -u NetworkManager.service

例: ユーザーのセットに対してノードを専用に割り当てるためのテイントの追加

$ oc adm taint nodes node1 dedicated=groupName:NoSchedule

例: ノード node1 からキー dedicated のあるテイントを削除する

$ oc adm taint nodes node1 dedicated-

例: node1 にスケジュール対象のマークを付ける

$ oc adm uncordon node1

例: CSR の承認

$ oc adm certificate approve csr-sqgzp

例: 新規グループの作成

$ oc adm groups new my-group

例: ノードセレクターを使用した新規プロジェクトの作成

$ oc adm new-project myproject --node-selector='type=user-node,region=east'

例: project1 および project2 を他の非グローバルプロジェクトから分離する

$ oc adm pod-network isolate-projects project1 project2

例: すべてのプロジェクトについて edit ロールを user1 に追加する

$ oc adm policy add-cluster-role-to-user edit user1

例: privileged SCC (security context constraint) のサービスアカウントへの追加

$ oc adm policy add-scc-to-user privileged -z myserviceaccount

例: 保存されたすべてのオブジェクトの更新の実行

$ oc adm migrate storage

例: Pod のみの更新の実行

$ oc adm migrate storage --include=pods

例: BuildConfigs がすでに存在しないビルドを含む、古いビルドのプルーニング

$ oc adm prune builds --orphans

例: プロキシーのクライアント証明書の生成

$ oc adm create-api-client-config \
  --certificate-authority='/etc/origin/master/proxyca.crt' \
  --client-dir='/etc/origin/master/proxy' \
  --signer-cert='/etc/origin/master/proxyca.crt' \
  --signer-key='/etc/origin/master/proxyca.key' \
  --signer-serial='/etc/origin/master/proxyca.serial.txt' \
  --user='system:proxy'

例: デフォルトブートストラップポリシーでの policy.json ファイルの作成

$ oc adm create-bootstrap-policy-file --filename=policy.json

例: YAML 形式でのブートストラッププロジェクトテンプレートの標準出力 (stdout) への出力

$ oc adm create-bootstrap-project-template -o yaml

例: エラーページのテンプレートの標準出力 (stdout) への出力

$ oc adm create-error-template

例: 提供されるクライアント証明書を使用した .kubeconfig ファイルの作成

$ oc adm create-kubeconfig \
  --client-certificate=/path/to/client.crt \
  --client-key=/path/to/client.key \
  --certificate-authority=/path/to/ca.crt

例: ログインページのテンプレートの標準出力 (stdout) への出力

$ oc adm create-login-template

例: プロバイダー選択ページのテンプレートの標準出力 (stdout) への出力

$ oc adm create-provider-selection-template

例: perl イメージストリームの依存関係の出力

$ oc adm build-chain perl

例: Bash の oc adm 補完コードの表示

$ oc adm completion bash

例: 現在の設定の表示

$ oc adm config view

例: 別のコンテキストへの切り替え

$ oc adm config use-context test-context

例: 2 つのリリース間の変更ログの生成および changelog.md への保存

$ oc adm release info --changelog=/tmp/git \
    quay.io/openshift-release-dev/ocp-release:4.1.0-rc.7 \
    quay.io/openshift-release-dev/ocp-release:4.1.0 \
    > changelog.md

例: nodejs イメージ署名の検証

$ oc adm verify-image-signature \
    sha256:2bba968aedb7dd2aafe5fa8c7453f5ac36a0b9639f1bf5b03f95de325238b288 \
    --expected-identity 172.30.1.1:5000/openshift/nodejs:latest \
    --public-key /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release \
    --save