CLI ツール

出力例

Now using project "my-project" on server "https://openshift.example.com:6443".

出力例

--> Found image 40de956 (9 days old) in imagestream "openshift/php" under tag "7.2" for "php"

...

    Run 'oc status' to view your app.

出力例

NAME                  READY   STATUS      RESTARTS   AGE     IP            NODE                           NOMINATED NODE
cakephp-ex-1-build    0/1     Completed   0          5m45s   10.131.0.10   ip-10-0-141-74.ec2.internal    <none>
cakephp-ex-1-deploy   0/1     Completed   0          3m44s   10.129.2.9    ip-10-0-147-65.ec2.internal    <none>
cakephp-ex-1-ktz97    1/1     Running     0          3m33s   10.128.2.11   ip-10-0-168-105.ec2.internal   <none>

出力例

--> Scaling cakephp-ex-1 to 1
--> Success

出力例

Using project "my-project" on server "https://openshift.example.com:6443".

出力例

In project my-project on server https://openshift.example.com:6443

svc/cakephp-ex - 172.30.236.80 ports 8080, 8443
  dc/cakephp-ex deploys istag/cakephp-ex:latest <-
    bc/cakephp-ex source builds https://github.com/sclorg/cakephp-ex on openshift/php:7.2
    deployment #1 deployed 2 minutes ago - 1 pod

3 infos identified, use 'oc status --suggest' to see details.

出力例

NAME                                  SHORTNAMES       APIGROUP                              NAMESPACED   KIND
bindings                                                                                     true         Binding
componentstatuses                     cs                                                     false        ComponentStatus
configmaps                            cm                                                     true         ConfigMap
...

例: 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 ビルド設定からの保留中のすべてのビルドの取り消し

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

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

$ oc import-image my-ruby

例: ローカル Git リポジトリーからのビルド設定の作成

$ oc new-build .

例: リモート Git リポジトリーからのビルド設定の作成

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

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

$ oc rollback php

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

$ oc rollback php --to-version=3

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

$ oc rollout undo deploymentconfig/php

例: 最新状態のデプロイメントの新規ロールアウトの開始

$ oc rollout latest deploymentconfig/php

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

$ 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

例: デフォルトエディターを使用したデプロイメントの編集

$ oc edit deploymentconfig/parksmap-katacoda

例: 異なるエディターを使用したデプロイメントの編集

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

例: JSON 形式のデプロイメントの編集

$ 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 デプロイメントについての詳細の取得

$ oc get deploymentconfig/python -o json

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

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

例: ruby-app デプロイメントの 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

例: ビルド設定でのシークレットの名前の設定

$ 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 デプロイメントからの最新ログのストリーミング

$ 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/

例: perl イメージを実行する Pod の起動

$ oc run my-test --image=perl

例: 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 設定マップの内容の現行ディレクトリーへのダウンロード

$ oc extract configmap/ruby-1-ca

例: ruby-1-ca 設定マップの内容の標準出力 (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

例: OpenShift API サーバークラスター Operator のデバッグデータの収集

$ oc adm inspect clusteroperator/openshift-apiserver

例: デバッグ情報の収集

$ 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

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

$ oc adm prune builds --orphans

例: 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.6.0-rc.7-x86_64 \
    quay.io/openshift-release-dev/ocp-release:4.6.4-x86_64 \
    > 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

出力例:

NAME                       URL                             SECURE
DefaultDevfileRegistry     https://registry.devfile.io     No

出力例:

$ odo registry add StageRegistry https://registry.stage.devfile.io
New registry successfully added

出力例:

$ odo registry delete StageRegistry
? Are you sure you want to delete registry "StageRegistry" Yes
Successfully deleted registry

出力例:

 $ odo registry update MyRegistry https://otherregistry.example.com --token <other_access_token>
 ? Are you sure you want to update registry "MyRegistry" Yes
 Successfully updated registry

出力例

$ odo catalog list services
Services available through Operators
NAME                      CRDs
redis-operator.v0.8.0     RedisCluster, Redis

$ odo service create redis-operator.v0.8.0/Redis my-redis-service
Successfully added service to the configuration; do 'odo push' to create service on the cluster

出力例

 apiVersion: redis.redis.opstreelabs.in/v1beta1
 kind: Redis
 metadata:
   name: my-redis-service
 spec:
   kubernetesConfig:
     image: quay.io/opstree/redis:v6.2.5
     imagePullPolicy: IfNotPresent
     resources:
       limits:
         cpu: 101m
         memory: 128Mi
       requests:
         cpu: 101m
         memory: 128Mi
     serviceType: ClusterIP
   redisExporter:
     enabled: false
     image: quay.io/opstree/redis-exporter:1.0
   storage:
     volumeClaimTemplate:
       spec:
         accessModes:
         - ReadWriteOnce
         resources:
           requests:
             storage: 1Gi

コマンドの例

$ cat devfile.yaml

出力例

[...]
components:
- kubernetes:
    uri: kubernetes/odo-service-my-redis-service.yaml
  name: my-redis-service
[...]

出力例

$ odo service list
NAME                       MANAGED BY ODO     STATE               AGE
Redis/my-redis-service     Yes (api)          Deleted locally     5m39s

出力例

$ odo service list
NAME                       MANAGED BY ODO     STATE             AGE
Redis/my-redis-service-1   Yes (api)          Not pushed
Redis/my-redis-service-2   Yes (api)          Pushed            52s
Redis/my-redis-service-3   Yes (api)          Deleted locally   1m22s

出力例

$ odo service describe Redis/my-redis-service
Version: redis.redis.opstreelabs.in/v1beta1
Kind: Redis
Name: my-redis-service
Parameters:
NAME                           VALUE
kubernetesConfig.image         quay.io/opstree/redis:v6.2.5
kubernetesConfig.serviceType   ClusterIP
redisExporter.image            quay.io/opstree/redis-exporter:1.0

出力例:

$ odo storage create store --path /data --size 1Gi
✓  Added storage store to nodejs-project-ufyy

$ odo storage create tempdir --path /tmp --size 2Gi --ephemeral
✓  Added storage tempdir to nodejs-project-ufyy

Please use `odo push` command to make the storage accessible to the component

出力例:

$ odo storage list
The component 'nodejs-project-ufyy' has the following storage attached:
NAME      SIZE     PATH      STATE
store     1Gi      /data     Not Pushed
tempdir   2Gi      /tmp      Not Pushed

出力例:

$ odo storage delete store -f
Deleted storage store from nodejs-project-ufyy

Please use `odo push` command to delete the storage from the cluster

出力例:

$ odo storage create store --path /data --size 1Gi --container nodejs2
✓  Added storage store to nodejs-testing-xnfg

Please use `odo push` command to make the storage accessible to the component

出力例:

The component 'nodejs-testing-xnfg' has the following storage attached:
NAME      SIZE     PATH      CONTAINER     STATE
store     1Gi      /data     nodejs2       Not Pushed

例: すべてのオプションの表示

$ tkn

例: bash シェルの補完コード

$ tkn completion bash

例: tkn バージョンの確認

$ tkn version

例: ヘルプの表示

$ tkn pipeline --help

例: namespace からの mypipeline Pipeline の削除

$ tkn pipeline delete mypipeline -n myspace

例: mypipeline Pipeline の記述

$ tkn pipeline describe mypipeline

例: Pipeline の一覧を表示します。

$ tkn pipeline list

例: mypipeline Pipeline のライブログのストリーミング

$ tkn pipeline logs -f mypipeline

例: mypipeline Pipeline の開始

$ tkn pipeline start mypipeline

例: ヘルプの表示

$ tkn pipelinerun -h

例: namespace からの mypipelinerun PipelineRun の取り消し

$ tkn pipelinerun cancel mypipelinerun -n myspace

例: namespace からの PipelineRun の削除

$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace

例: namespace の mypipelinerun PipelineRun の記述

$ tkn pipelinerun describe mypipelinerun -n myspace

例: namespace の PipelineRun の一覧表示

$ tkn pipelinerun list -n myspace

例: namespace のすべてのタスクおよび手順を含む mypipelinerun PipelineRun のログの表示

$ tkn pipelinerun logs mypipelinerun -a -n myspace

例: ヘルプの表示

$ tkn task -h

例: namespace からの mytask1 および mytask2 Task の削除

$ tkn task delete mytask1 mytask2 -n myspace

例: namespace の mytask Task の記述

$ tkn task describe mytask -n myspace

例: namespace のすべての Task の一覧表示

$ tkn task list -n myspace

例: mytask Task の mytaskrun TaskRun のログの表示

$ tkn task logs mytask mytaskrun -n myspace

例: namespace の mytask Task の開始

$ tkn task start mytask -s <ServiceAccountName> -n myspace

例: ヘルプの表示

$ tkn taskrun -h

例: namespace からの mytaskrun TaskRun の取り消し

$ tkn taskrun cancel mytaskrun -n myspace

例: namespace からの mytaskrun1 および mytaskrun2 TaskRun の取り消し

$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace

例: namespace の mytaskrun TaskRun の記述

$ tkn taskrun describe mytaskrun -n myspace

例: namespace のすべての TaskRun の一覧表示

$ tkn taskrun list -n myspace

例: namespace での mytaskrun TaskRun のライブログの表示

$ tkn taskrun logs -f mytaskrun -n myspace

例: ヘルプの表示

$ tkn condition --help

例: namespace からの mycondition1 条件の削除

$ tkn condition delete mycondition1 -n myspace

例: namespace での mycondition1 条件の記述

$ tkn condition describe mycondition1 -n myspace

例: namespace での条件の一覧表示

$ tkn condition list -n myspace

例: ヘルプの表示

$ tkn resource -h

例: namespace での Pipeline リソースの作成

$ tkn resource create -n myspace

例: namespace から myresource Pipeline リソースを削除します。

$ tkn resource delete myresource -n myspace

例: myresource Pipeline リソースの記述

$ tkn resource describe myresource -n myspace

例: namespace のすべての Pipeline リソースの一覧表示

$ tkn resource list -n myspace

例: ヘルプの表示

$ tkn clustertask --help

例: mytask1 および mytask2 ClusterTask の削除

$ tkn clustertask delete mytask1 mytask2

例: mytask ClusterTask の記述

$ tkn clustertask describe mytask1

例: ClusterTask の一覧表示

$ tkn clustertask list

例: mytask ClusterTask の開始

$ tkn clustertask start mytask

例: ヘルプの表示

$ tkn eventlistener -h

例: namespace の mylistener1 および mylistener2 EventListener の削除

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace

例: namespace の mylistener EventListener の記述

$ tkn eventlistener describe mylistener -n myspace

例: namespace のすべての EventListener の一覧表示

$ tkn eventlistener list -n myspace

例: TriggerBindings ヘルプの表示

$ tkn triggerbinding -h

例: namespace の mybinding1 および mybinding2 TriggerBinding の削除

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace

例: namespace の mybinding TriggerBinding の記述

$ tkn triggerbinding describe mybinding -n myspace

例: namespace のすべての TriggerBinding の一覧表示

$ tkn triggerbinding list -n myspace

例: TriggerTemplate ヘルプの表示

$ tkn triggertemplate -h

例: namespace の mytemplate1 および mytemplate2 TriggerTemplate の削除

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`

例: namespace の mytemplate TriggerTemplate の記述

$ tkn triggertemplate describe mytemplate -n `myspace`

例: namespace のすべての TriggerTemplate の一覧表示

$ tkn triggertemplate list -n myspace

例: ClusterTriggerBinding のヘルプの表示

$ tkn clustertriggerbinding -h

例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding の削除

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2

例: myclusterbinding ClusterTriggerBinding の記述

$ tkn clustertriggerbinding describe myclusterbinding

例: すべての ClusterTriggerBinding の一覧表示

$ tkn clustertriggerbinding list