Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

CLI ツール

OpenShift Container Platform 4.5

OpenShift Container Platform コマンドラインツールの使用方法

概要

本書では、OpenShift Container Platform コマンドラインツールのインストール、設定および使用について説明します。また、CLI コマンドの参照情報およびそれらの使用方法についての例も記載しています。

第1章 OpenShift CLI (oc)
リンクのコピー

1.1. CLI の使用方法
リンクのコピー

1.1.1. CLI について
リンクのコピー

OpenShift Container Platform のコマンドラインインターフェイス (CLI) を使用すると、ターミナルからアプリケーションを作成し、OpenShift Container Platform プロジェクトを管理できます。CLI の使用は、以下の場合に適しています。

  • プロジェクトのソースコードを直接使用している。
  • OpenShift Container Platform の操作をスクリプト化する。
  • 帯域幅リソースの制限下にあり、Web コンソールを使用できない。

1.1.2. CLI のインストール
リンクのコピー

OpenShift CLI(oc) をインストールするには、バイナリーをダウンロードするか、RPM を使用します。

1.1.2.1. バイナリーのダウンロードによる CLI のインストール
リンクのコピー

コマンドラインインターフェイスを使用して OpenShift Container Platform と対話するために CLI (oc) をインストールすることができます。oc は Linux、Windows、または macOS にインストールできます。

重要

以前のバージョンの oc をインストールしている場合、これを使用して OpenShift Container Platform 4.5 のすべてのコマンドを実行することはできません。新規バージョンの oc をダウンロードし、インストールします。

1.1.2.1.1. Linux への CLI のインストール
リンクのコピー

以下の手順を使用して、OpenShift CLI (oc) バイナリーを Linux にインストールできます。

手順

  1. Red Hat OpenShift Cluster Manager サイトの Infrastructure Provider ページに移動します。
  2. インフラストラクチャープロバイダーを選択し、(該当する場合は) インストールタイプを選択します。
  3. Command-line interface セクションで、ドロップダウンメニューの Linux を選択し、Download command-line tools をクリックします。

  4. アーカイブを展開します。 

    $ tar xvzf <file>
    Copy to Clipboard Toggle word wrap

  5. oc バイナリーを、PATH にあるディレクトリーに配置します。

    PATH を確認するには、以下のコマンドを実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、oc コマンドを使用して利用できます。 

$ oc <command>
Copy to Clipboard Toggle word wrap
1.1.2.1.2. Windows での CLI のインストール
リンクのコピー

以下の手順を使用して、OpenShift CLI (oc) バイナリーを Windows にインストールできます。

手順

  1. Red Hat OpenShift Cluster Manager サイトの Infrastructure Provider ページに移動します。
  2. インフラストラクチャープロバイダーを選択し、(該当する場合は) インストールタイプを選択します。
  3. Command-line interface セクションで、ドロップダウンメニューの Windows を選択し、Download command-line tools をクリックします。
  4. ZIP プログラムでアーカイブを解凍します。

  5. oc バイナリーを、PATH にあるディレクトリーに移動します。

    PATH を確認するには、コマンドプロンプトを開いて以下のコマンドを実行します。 

    C:\> path
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、oc コマンドを使用して利用できます。 

C:\> oc <command>
Copy to Clipboard Toggle word wrap
1.1.2.1.3. macOS への CLI のインストール
リンクのコピー

以下の手順を使用して、OpenShift CLI (oc) バイナリーを macOS にインストールできます。

手順

  1. Red Hat OpenShift Cluster Manager サイトの Infrastructure Provider ページに移動します。
  2. インフラストラクチャープロバイダーを選択し、(該当する場合は) インストールタイプを選択します。
  3. Command-line interface セクションで、ドロップダウンメニューの MacOS を選択し、Download command-line tools をクリックします。
  4. アーカイブを展開し、解凍します。

  5. oc バイナリーをパスにあるディレクトリーに移動します。

    PATH を確認するには、ターミナルを開き、以下のコマンドを実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、oc コマンドを使用して利用できます。 

$ oc <command>
Copy to Clipboard Toggle word wrap
1.1.2.2. RPM を使用した CLI のインストール
リンクのコピー

Red Hat Enterprise Linux (RHEL) の場合、Red Hat アカウントに有効な OpenShift Container Platform サブスクリプションがある場合は、OpenShift CLI (oc) を RPM としてインストールできます。

前提条件

  • root または sudo の権限が必要です。

手順

  1. Red Hat Subscription Manager に登録します。 

    # subscription-manager register
    Copy to Clipboard Toggle word wrap

  2. 最新のサブスクリプションデータをプルします。 

    # subscription-manager refresh
    Copy to Clipboard Toggle word wrap

  3. 利用可能なサブスクリプションを一覧表示します。 

    # subscription-manager list --available --matches '*OpenShift*'
    Copy to Clipboard Toggle word wrap

  4. 直前のコマンドの出力で、OpenShift Container Platform サブスクリプションのプール ID を見つけ、これを登録されたシステムにアタッチします。 

    # subscription-manager attach --pool=<pool_id>
    Copy to Clipboard Toggle word wrap

  5. OpenShift Container Platform 4.5 で必要なリポジトリーを有効にします。

    • Red Hat Enterprise Linux 8 の場合: 

      # subscription-manager repos --enable="rhocp-4.5-for-rhel-8-x86_64-rpms"
      Copy to Clipboard Toggle word wrap

    • Red Hat Enterprise Linux 7 の場合: 

      # subscription-manager repos --enable="rhel-7-server-ose-4.5-rpms"
      Copy to Clipboard Toggle word wrap

  6. openshift-clients パッケージをインストールします。 

    # yum install openshift-clients
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、oc コマンドを使用して利用できます。 

$ oc <command>
Copy to Clipboard Toggle word wrap

1.1.3. CLI へのログイン
リンクのコピー

oc CLI にログインしてクラスターにアクセスし、これを管理できます。

前提条件

  • OpenShift Container Platform クラスターへのアクセスがあること。
  • CLI をインストールしていること。
注記

HTTP プロキシーサーバー上でのみアクセスできるクラスターにアクセスするには、HTTP_PROXY、HTTPS_PROXY および NO_PROXY 変数を設定できます。これらの環境変数は、クラスターとのすべての通信が HTTP プロキシーを経由するように oc CLI で使用されます。

手順

  • oc login コマンドを使用して CLI にログインし、プロンプトが出されたら必要な情報を入力します。 

    $ oc login
    Copy to Clipboard Toggle word wrap

    出力例

    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
    OpenShift Container Platform サーバー URL を入力します。
    2
    非セキュアな接続を使用するかどうかを入力します。
    3
    ログインに使用するユーザー名を入力します。
    4
    ユーザーのパスワードを入力します。

これで、プロジェクトを作成でき、クラスターを管理するための他のコマンドを実行することができます。

1.1.4. CLI の使用
リンクのコピー

以下のセクションで、CLI を使用して一般的なタスクを実行する方法を確認します。

1.1.4.1. プロジェクトの作成
リンクのコピー

新規プロジェクトを作成するには、oc new-project コマンドを使用します。 

$ oc new-project my-project
Copy to Clipboard Toggle word wrap

出力例

Now using project "my-project" on server "https://openshift.example.com:6443".
Copy to Clipboard Toggle word wrap

1.1.4.2. 新しいアプリケーションの作成
リンクのコピー

新規アプリケーションを作成するには、oc new-app コマンドを使用します。 

$ oc new-app https://github.com/sclorg/cakephp-ex
Copy to Clipboard Toggle word wrap

出力例

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

...

    Run 'oc status' to view your app.
Copy to Clipboard Toggle word wrap

1.1.4.3. Pod の表示
リンクのコピー

現在のプロジェクトの Pod を表示するには、oc get pods コマンドを使用します。 

$ oc get pods -o wide
Copy to Clipboard Toggle word wrap

出力例

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>
Copy to Clipboard Toggle word wrap

1.1.4.4. Pod ログの表示
リンクのコピー

特定の Pod のログを表示するには、oc logs コマンドを使用します。 

$ oc logs cakephp-ex-1-deploy
Copy to Clipboard Toggle word wrap

出力例

--> Scaling cakephp-ex-1 to 1
--> Success
Copy to Clipboard Toggle word wrap

1.1.4.5. 現在のプロジェクトの表示
リンクのコピー

現在のプロジェクトを表示するには、oc project コマンドを使用します。 

$ oc project
Copy to Clipboard Toggle word wrap

出力例

Using project "my-project" on server "https://openshift.example.com:6443".
Copy to Clipboard Toggle word wrap

1.1.4.6. 現在のプロジェクトのステータスの表示
リンクのコピー

サービス、デプロイメント、およびビルド設定などの現在のプロジェクトについての情報を表示するには、oc status コマンドを使用します。 

$ oc status
Copy to Clipboard Toggle word wrap

出力例

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.
Copy to Clipboard Toggle word wrap

1.1.4.7. サポートされる API のリソースの一覧表示
リンクのコピー

サーバー上でサポートされる API リソースの一覧を表示するには、oc api-resources コマンドを使用します。 

$ oc api-resources
Copy to Clipboard Toggle word wrap

出力例

NAME                                  SHORTNAMES       APIGROUP                              NAMESPACED   KIND
bindings                                                                                     true         Binding
componentstatuses                     cs                                                     false        ComponentStatus
configmaps                            cm                                                     true         ConfigMap
...
Copy to Clipboard Toggle word wrap

1.1.5. ヘルプの表示
リンクのコピー

CLI コマンドおよび OpenShift Container Platform リソースに関するヘルプを以下の方法で表示することができます。

  • 利用可能なすべての CLI コマンドの一覧および説明を表示するには、oc help を使用します。

    例: CLI についての一般的なヘルプの表示

    $ oc help
    Copy to Clipboard Toggle word wrap

    出力例

    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

  • 特定の CLI コマンドについてのヘルプを表示するには、--help フラグを使用します。

    例: oc create コマンドについてのヘルプの表示

    $ oc create --help
    Copy to Clipboard Toggle word wrap

    出力例

    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

  • 特定リソースについての説明およびフィールドを表示するには、oc explain コマンドを使用します。

    例: Pod リソースのドキュメントの表示

    $ oc explain pods
    Copy to Clipboard Toggle word wrap

    出力例

    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

1.1.6. CLI からのログアウト
リンクのコピー

CLI からログアウトし、現在のセッションを終了することができます。

  • oc logout コマンドを使用します。 

    $ oc logout
    Copy to Clipboard Toggle word wrap

    出力例

    Logged "user1" out on "https://openshift.example.com"
    Copy to Clipboard Toggle word wrap

これにより、サーバーから保存された認証トークンが削除され、設定ファイルから除去されます。

1.2. CLI の設定
リンクのコピー

1.2.1. タブ補完の有効化
リンクのコピー

oc CLI ツールをインストールした後に、タブ補完を有効にして oc コマンドの自動補完を実行するか、または Tab キーを押す際にオプションの提案が表示されるようにできます。

前提条件

  • oc CLI ツールをインストールしていること。
  • bash-completion パッケージがインストールされている。

手順

以下の手順では、Bash のタブ補完を有効にします。

  1. Bash 補完コードをファイルに保存します。 

    $ oc completion bash > oc_bash_completion
    Copy to Clipboard Toggle word wrap

  2. ファイルを /etc/bash_completion.d/ にコピーします。 

    $ sudo cp oc_bash_completion /etc/bash_completion.d/
    Copy to Clipboard Toggle word wrap

    さらにファイルをローカルディレクトリーに保存した後に、これを .bashrc ファイルから取得できるようにすることができます。

タブ補完は、新規ターミナルを開くと有効にされます。

1.3. プラグインによる CLI の拡張
リンクのコピー

デフォルトの oc コマンドを拡張するためにプラグインを作成およびインストールし、これを使用して OpenShift Container Platform CLI で新規および追加の複雑なタスクを実行できます。

1.3.1. CLI プラグインの作成
リンクのコピー

コマンドラインのコマンドを作成できる任意のプログラミング言語またはスクリプトで、OpenShift Container Platform CLI のプラグインを作成できます。既存の oc コマンドを上書きするプラグインを使用することはできない点に注意してください。

重要

現時点で OpenShift CLI プラグインはテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。これらの機能は、近々発表予定の製品機能をリリースに先駆けてご提供することにより、お客様は機能性をテストし、開発プロセス中にフィードバックをお寄せいただくことができます。

詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

手順

以下の手順では、oc foo コマンドの実行時にターミナルにメッセージを出力する単純な Bash プラグインを作成します。

  1. oc-foo というファイルを作成します。

    プラグインファイルの名前を付ける際には、以下の点に留意してください。

    • プログインとして認識されるように、ファイルの名前は oc- または kubectl- で開始する必要があります。
    • ファイル名は、プラグインを起動するコマンドを判別するものとなります。たとえば、ファイル名が oc-foo-bar のプラグインは、oc foo bar のコマンドで起動します。また、コマンドにダッシュを含める必要がある場合には、アンダースコアを使用することもできます。たとえば、ファイル名が oc-foo_bar のプラグインは oc foo-bar のコマンドで起動できます。

  2. 以下の内容をファイルに追加します。 

    #!/bin/bash

# optional argument handling
if [[ "$1" == "version" ]]
then
    echo "1.0.0"
    exit 0
fi

# optional argument handling
if [[ "$1" == "config" ]]
then
    echo $KUBECONFIG
    exit 0
fi

echo "I am a plugin named kubectl-foo"
    Copy to Clipboard Toggle word wrap

OpenShift Container Platform CLI のこのプラグインをインストールした後に、oc foo コマンドを使用してこれを起動できます。

関連情報

1.3.2. CLI プラグインのインストールおよび使用
リンクのコピー

OpenShift Container Platform CLI のカスタムプラグインの作成後に、これが提供する機能を使用できるようインストールする必要があります。

重要

現時点で OpenShift CLI プラグインはテクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。これらの機能は、近々発表予定の製品機能をリリースに先駆けてご提供することにより、お客様は機能性をテストし、開発プロセス中にフィードバックをお寄せいただくことができます。

詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

前提条件

  • oc CLI ツールをインストールしていること。
  • oc- または kubectl- で始まる CLI プラグインファイルがあること。

手順

  1. 必要に応じて、プラグインファイルを実行可能な状態になるように更新します。 

    $ chmod +x <plugin_file>
    Copy to Clipboard Toggle word wrap

  2. ファイルを PATH の任意の場所に置きます (例: /usr/local/bin/)。 

    $ sudo mv <plugin_file> /usr/local/bin/.
    Copy to Clipboard Toggle word wrap

  3. oc plugin list を実行し、プラグインが一覧表示されることを確認します。 

    $ oc plugin list
    Copy to Clipboard Toggle word wrap

    出力例

    The following compatible plugins are available:

/usr/local/bin/<plugin_file>
    Copy to Clipboard Toggle word wrap

    プラグインがここに一覧表示されていない場合、ファイルが oc- または kubectl- で開始されるものであり、実行可能な状態で PATH 上にあることを確認します。

  4. プラグインによって導入される新規コマンドまたはオプションを起動します。

    たとえば、kubectl-ns プラグインを サンプルのプラグインリポジトリー からビルドし、インストールしている場合、以下のコマンドを使用して現在の namespace を表示できます。 

    $ oc ns
    Copy to Clipboard Toggle word wrap

    プラグインを起動するためのコマンドはプラグインファイル名によって異なることに注意してください。たとえば、ファイル名が oc-foo-bar のプラグインは oc foo bar コマンドによって起動します。

1.4. 開発者の CLI コマンド
リンクのコピー

1.4.1. 基本的な CLI コマンド
リンクのコピー

1.4.1.1. explain
リンクのコピー

特定リソースのドキュメントを表示します。

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

$ oc explain pods
Copy to Clipboard Toggle word wrap

1.4.1.2. login
リンクのコピー

OpenShift Container Platform サーバーにログインし、後続の使用のためにログイン情報を保存します。

例: 対話型ログイン

$ oc login
Copy to Clipboard Toggle word wrap

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

$ oc login -u user1
Copy to Clipboard Toggle word wrap

1.4.1.3. new-app
リンクのコピー

ソースコード、テンプレート、またはイメージを指定して新規アプリケーションを作成します。

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

$ oc new-app .
Copy to Clipboard Toggle word wrap

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

$ oc new-app https://github.com/sclorg/cakephp-ex
Copy to Clipboard Toggle word wrap

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

$ oc new-app https://github.com/youruser/yourprivaterepo --source-secret=yoursecret
Copy to Clipboard Toggle word wrap

1.4.1.4. new-project
リンクのコピー

新規プロジェクトを作成し、設定のデフォルトのプロジェクトとしてこれに切り替えます。

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

$ oc new-project myproject
Copy to Clipboard Toggle word wrap

1.4.1.5. project
リンクのコピー

別のプロジェクトに切り替えて、これを設定でデフォルトにします。

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

$ oc project test-project
Copy to Clipboard Toggle word wrap

1.4.1.6. projects
リンクのコピー

現在のアクティブなプロジェクトおよびサーバー上の既存プロジェクトについての情報を表示します。

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

$ oc projects
Copy to Clipboard Toggle word wrap

1.4.1.7. status
リンクのコピー

現在のプロジェクトのハイレベルの概要を表示します。

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

$ oc status
Copy to Clipboard Toggle word wrap

1.4.2. CLI コマンドのビルドおよびデプロイ
リンクのコピー

1.4.2.1. cancel-build
リンクのコピー

実行中、保留中、または新規のビルドを取り消します。

例: ビルドの取り消し

$ oc cancel-build python-1
Copy to Clipboard Toggle word wrap

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

$ oc cancel-build buildconfig/python --state=pending
Copy to Clipboard Toggle word wrap

1.4.2.2. import-image
リンクのコピー

イメージリポジトリーから最新のタグおよびイメージ情報をインポートします。

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

$ oc import-image my-ruby
Copy to Clipboard Toggle word wrap

1.4.2.3. new-build
リンクのコピー

ソースコードから新規のビルド設定を作成します。

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

$ oc new-build .
Copy to Clipboard Toggle word wrap

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

$ oc new-build https://github.com/sclorg/cakephp-ex
Copy to Clipboard Toggle word wrap

1.4.2.4. rollback
リンクのコピー

アプリケーションを以前のデプロイメントに戻します。

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

$ oc rollback php
Copy to Clipboard Toggle word wrap

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

$ oc rollback php --to-version=3
Copy to Clipboard Toggle word wrap

1.4.2.5. rollout
リンクのコピー

新規ロールアウトを開始し、そのステータスまたは履歴を表示するか、またはアプリケーションの以前のバージョンにロールバックします。

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

$ oc rollout undo deploymentconfig/php
Copy to Clipboard Toggle word wrap

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

$ oc rollout latest deploymentconfig/php
Copy to Clipboard Toggle word wrap

1.4.2.6. start-build
リンクのコピー

ビルド設定からビルドを開始するか、または既存ビルドをコピーします。

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

$ oc start-build python
Copy to Clipboard Toggle word wrap

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

$ oc start-build --from-build=python-1
Copy to Clipboard Toggle word wrap

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

$ oc start-build python --env=mykey=myvalue
Copy to Clipboard Toggle word wrap

1.4.2.7. tag
リンクのコピー

既存のイメージをイメージストリームにタグ付けします。

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

$ oc tag ruby:latest ruby:2.0
Copy to Clipboard Toggle word wrap

1.4.3. アプリケーション管理 CLI コマンド
リンクのコピー

1.4.3.1. annotate
リンクのコピー

1 つ以上のリソースでアノテーションを更新します。

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

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist="192.168.1.10"
Copy to Clipboard Toggle word wrap

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

$ oc annotate route/test-route haproxy.router.openshift.io/ip_whitelist-
Copy to Clipboard Toggle word wrap

1.4.3.2. apply
リンクのコピー

JSON または YAML 形式のファイル名または標準入力 (stdin) 別に設定をリソースに適用します。

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

$ oc apply -f pod.json
Copy to Clipboard Toggle word wrap

1.4.3.3. autoscale
リンクのコピー

デプロイメントまたはレプリケーションコントローラーの自動スケーリングを実行します。

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

$ oc autoscale deploymentconfig/parksmap-katacoda --min=2 --max=5
Copy to Clipboard Toggle word wrap

1.4.3.4. create
リンクのコピー

JSON または YAML 形式のファイル名または標準入力 (stdin) 別にリソースを作成します。

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

$ oc create -f pod.json
Copy to Clipboard Toggle word wrap

1.4.3.5. delete
リンクのコピー

リソースを削除します。

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

$ oc delete pod/parksmap-katacoda-1-qfqz4
Copy to Clipboard Toggle word wrap

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

$ oc delete pods -l app=parksmap-katacoda
Copy to Clipboard Toggle word wrap

1.4.3.6. describe
リンクのコピー

特定のオブジェクトに関する詳細情報を返します。

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

$ oc describe deployment/example
Copy to Clipboard Toggle word wrap

例: すべての Pod の記述

$ oc describe pods
Copy to Clipboard Toggle word wrap

1.4.3.7. edit
リンクのコピー

リソースを編集します。

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

$ oc edit deploymentconfig/parksmap-katacoda
Copy to Clipboard Toggle word wrap

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

$ OC_EDITOR="nano" oc edit deploymentconfig/parksmap-katacoda
Copy to Clipboard Toggle word wrap

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

$ oc edit deploymentconfig/parksmap-katacoda -o json
Copy to Clipboard Toggle word wrap

1.4.3.8. expose
リンクのコピー

ルートとしてサービスを外部に公開します。

例: サービスの公開

$ oc expose service/parksmap-katacoda
Copy to Clipboard Toggle word wrap

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

$ oc expose service/parksmap-katacoda --hostname=www.my-host.com
Copy to Clipboard Toggle word wrap

1.4.3.9. get
リンクのコピー

1 つ以上のリソースを表示します。

例: default namespace の Pod の一覧表示

$ oc get pods -n default
Copy to Clipboard Toggle word wrap

例: JSON 形式の python デプロイメントについての詳細の取得

$ oc get deploymentconfig/python -o json
Copy to Clipboard Toggle word wrap

1.4.3.10. label
リンクのコピー

1 つ以上のリソースでラベルを更新します。

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

$ oc label pod/python-1-mz2rf status=unhealthy
Copy to Clipboard Toggle word wrap

1.4.3.11. scale
リンクのコピー

レプリケーションコントローラーまたはデプロイメントの必要なレプリカ数を設定します。

例: ruby-app デプロイメントの 3 つの Pod へのスケーリング

$ oc scale deploymentconfig/ruby-app --replicas=3
Copy to Clipboard Toggle word wrap

1.4.3.12. secrets
リンクのコピー

プロジェクトのシークレットを管理します。

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

$ oc secrets link default my-pull-secret --for=pull
Copy to Clipboard Toggle word wrap

1.4.3.13. serviceaccounts
リンクのコピー

サービスアカウントに割り当てられたトークンを取得するか、またはサービスアカウントの新規トークンまたは kubeconfig ファイルを作成します。

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

$ oc serviceaccounts get-token default
Copy to Clipboard Toggle word wrap

1.4.3.14. set
リンクのコピー

既存のアプリケーションリソースを設定します。

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

$ oc set build-secret --source buildconfig/mybc mysecret
Copy to Clipboard Toggle word wrap

1.4.4. CLI コマンドのトラブルシューティングおよびデバッグ
リンクのコピー

1.4.4.1. attach
リンクのコピー

実行中のコンテナーにシェルを割り当てます。

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

$ oc attach python-1-mz2rf -c python
Copy to Clipboard Toggle word wrap

1.4.4.2. cp
リンクのコピー

ファイルおよびディレクトリーのコンテナーへの/からのコピーを実行します。

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

$ oc cp default/python-1-mz2rf:/opt/app-root/src/README.md ~/mydirectory/.
Copy to Clipboard Toggle word wrap

1.4.4.3. debug
リンクのコピー

コマンドシェルを起動して、実行中のアプリケーションをデバッグします。

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

$ oc debug deploymentconfig/python
Copy to Clipboard Toggle word wrap

1.4.4.4. exec
リンクのコピー

コンテナーでコマンドを実行します。

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

$ oc exec python-1-mz2rf -c python ls
Copy to Clipboard Toggle word wrap

1.4.4.5. logs
リンクのコピー

特定のビルド、ビルド設定、デプロイメント、または Pod のログ出力を取得します。

例: python デプロイメントからの最新ログのストリーミング

$ oc logs -f deploymentconfig/python
Copy to Clipboard Toggle word wrap

1.4.4.6. port-forward
リンクのコピー

1 つ以上のポートを Pod に転送します。

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

$ oc port-forward python-1-mz2rf 8888:5000
Copy to Clipboard Toggle word wrap

1.4.4.7. proxy
リンクのコピー

Kubernetes API サーバーに対してプロキシーを実行します。

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

$ oc proxy --port=8011 --www=./local/www/
Copy to Clipboard Toggle word wrap

1.4.4.8. rsh
リンクのコピー

コンテナーへのリモートシェルセッションを開きます。

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

$ oc rsh python-1-mz2rf
Copy to Clipboard Toggle word wrap

1.4.4.9. rsync
リンクのコピー

ディレクトリーの内容の実行中の Pod コンテナーへの/からのコピーを実行します。変更されたファイルのみが、オペレーティングシステムから rsync コマンドを使用してコピーされます。

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

$ oc rsync ~/mydirectory/ python-1-mz2rf:/opt/app-root/src/
Copy to Clipboard Toggle word wrap

1.4.4.10. run
リンクのコピー

特定のイメージを実行する Pod を作成します。

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

$ oc run my-test --image=perl
Copy to Clipboard Toggle word wrap

1.4.4.11. wait
リンクのコピー

1 つ以上のリソースの特定の条件を待機します。

注記

このコマンドは実験的なもので、通知なしに変更される可能性があります。

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

$ oc wait --for=delete pod/python-1-mz2rf
Copy to Clipboard Toggle word wrap

1.4.5. 上級開発者の CLI コマンド
リンクのコピー

1.4.5.1. api-resources
リンクのコピー

サーバーがサポートする API リソースの詳細の一覧を表示します。

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

$ oc api-resources
Copy to Clipboard Toggle word wrap

1.4.5.2. api-versions
リンクのコピー

サーバーがサポートする API バージョンの詳細の一覧を表示します。

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

$ oc api-versions
Copy to Clipboard Toggle word wrap

1.4.5.3. auth
リンクのコピー

パーミッションを検査し、RBAC ロールを調整します。

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

$ oc auth can-i get pods --subresource=log
Copy to Clipboard Toggle word wrap

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

$ oc auth reconcile -f policy.json
Copy to Clipboard Toggle word wrap

1.4.5.4. cluster-info
リンクのコピー

マスターおよびクラスターサービスのアドレスを表示します。

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

$ oc cluster-info
Copy to Clipboard Toggle word wrap

1.4.5.5. convert
リンクのコピー

YAML または JSON 設定ファイルを異なる API バージョンに変換し、標準出力 (stdout) に出力します。

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

$ oc convert -f pod.yaml
Copy to Clipboard Toggle word wrap

1.4.5.6. extract
リンクのコピー

設定マップまたはシークレットの内容を抽出します。設定マップまたはシークレットのそれぞれのキーがキーの名前を持つ別個のファイルとして作成されます。

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

$ oc extract configmap/ruby-1-ca
Copy to Clipboard Toggle word wrap

例: ruby-1-ca 設定マップの内容の標準出力 (stdout) への出力

$ oc extract configmap/ruby-1-ca --to=-
Copy to Clipboard Toggle word wrap

1.4.5.7. idle
リンクのコピー

スケーラブルなリソースをアイドリングします。アイドリングされたサービスは、トラフィックを受信するとアイドリング解除されます。 これは oc scale コマンドを使用して手動でアイドリング解除することもできます。

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

$ oc idle ruby-app
Copy to Clipboard Toggle word wrap

1.4.5.8. image
リンクのコピー

OpenShift Container Platform クラスターでイメージを管理します。

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

$ oc image mirror myregistry.com/myimage:latest myregistry.com/myimage:stable
Copy to Clipboard Toggle word wrap

1.4.5.9. observe
リンクのコピー

リソースの変更を監視し、それらの変更に対するアクションを取ります。

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

$ oc observe services
Copy to Clipboard Toggle word wrap

1.4.5.10. patch
リンクのコピー

JSON または YAML 形式のストテラテジーに基づくマージパッチを使用してオブジェクトの 1 つ以上のフィールドを更新します。

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

$ oc patch node/node1 -p '{"spec":{"unschedulable":true}}'
Copy to Clipboard Toggle word wrap

注記

カスタムリソース定義 (Custom Resource Definition) のパッチを適用する必要がある場合、コマンドに --type merge オプションを含める必要があります。

1.4.5.11. policy
リンクのコピー

認可ポリシーを管理します。

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

$ oc policy add-role-to-user edit user1
Copy to Clipboard Toggle word wrap

1.4.5.12. process
リンクのコピー

リソースの一覧に対してテンプレートを処理します。

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

$ oc process -f template.json | oc create -f -
Copy to Clipboard Toggle word wrap

1.4.5.13. registry
リンクのコピー

OpenShift Container Platform で統合レジストリーを管理します。

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

$ oc registry info
Copy to Clipboard Toggle word wrap

1.4.5.14. replace
リンクのコピー

指定された設定ファイルに基づいて既存オブジェクトを変更します。

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

$ oc replace -f pod.json
Copy to Clipboard Toggle word wrap

1.4.6. CLI コマンドの設定
リンクのコピー

1.4.6.1. completion
リンクのコピー

指定されたシェルのシェル補完コードを出力します。

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

$ oc completion bash
Copy to Clipboard Toggle word wrap

1.4.6.2. config
リンクのコピー

クライアント設定ファイルを管理します。

例: 現在の設定の表示

$ oc config view
Copy to Clipboard Toggle word wrap

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

$ oc config use-context test-context
Copy to Clipboard Toggle word wrap

1.4.6.3. logout
リンクのコピー

現行のセッションからログアウトします。

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

$ oc logout
Copy to Clipboard Toggle word wrap

1.4.6.4. whoami
リンクのコピー

現行セッションに関する情報を表示します。

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

$ oc whoami
Copy to Clipboard Toggle word wrap

1.4.7. 他の開発者 CLI コマンド
リンクのコピー

1.4.7.1. help
リンクのコピー

CLI の一般的なヘルプ情報および利用可能なコマンドの一覧を表示します。

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

$ oc help
Copy to Clipboard Toggle word wrap

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

$ oc help new-project
Copy to Clipboard Toggle word wrap

1.4.7.2. plugin
リンクのコピー

ユーザーの PATH に利用可能なプラグインを一覧表示します。

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

$ oc plugin list
Copy to Clipboard Toggle word wrap

1.4.7.3. version
リンクのコピー

oc クライアントおよびサーバーのバージョンを表示します。

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

$ oc version
Copy to Clipboard Toggle word wrap

クラスター管理者の場合、OpenShift Container Platform サーバーバージョンも表示されます。

1.5. 管理者 CLI コマンド
リンクのコピー

1.5.1. クラスター管理 CLI コマンド
リンクのコピー

1.5.1.1. inspect
リンクのコピー

特定のリソースについてのデバッグ情報を収集します。

注記

このコマンドは実験的なもので、通知なしに変更される可能性があります。

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

$ oc adm inspect clusteroperator/openshift-apiserver
Copy to Clipboard Toggle word wrap

1.5.1.2. must-gather
リンクのコピー

問題のデバッグに必要なクラスターの現在の状態についてのデータを一括収集します。

注記

このコマンドは実験的なもので、通知なしに変更される可能性があります。

例: デバッグ情報の収集

$ oc adm must-gather
Copy to Clipboard Toggle word wrap

1.5.1.3. top
リンクのコピー

サーバー上のリソースの使用状況についての統計を表示します。

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

$ oc adm top pods
Copy to Clipboard Toggle word wrap

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

$ oc adm top images
Copy to Clipboard Toggle word wrap

1.5.2. ノード管理 CLI コマンド
リンクのコピー

1.5.2.1. cordon
リンクのコピー

ノードにスケジュール対象外 (unschedulable) のマークを付けます。ノードにスケジュール対象外のマークを手動で付けると、いずれの新規 Pod もノードでスケジュールされなくなりますが、ノード上の既存の Pod にはこれによる影響がありません。

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

$ oc adm cordon node1
Copy to Clipboard Toggle word wrap

1.5.2.2. drain
リンクのコピー

メンテナーンスの準備のためにノードをドレイン (解放) します。

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

$ oc adm drain node1
Copy to Clipboard Toggle word wrap

1.5.2.3. node-logs
リンクのコピー

ノードのログを表示し、フィルターします。

例: NetworkManager のログの取得

$ oc adm node-logs --role master -u NetworkManager.service
Copy to Clipboard Toggle word wrap

1.5.2.4. taint
リンクのコピー

1 つ以上のノードでテイントを更新します。

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

$ oc adm taint nodes node1 dedicated=groupName:NoSchedule
Copy to Clipboard Toggle word wrap

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

$ oc adm taint nodes node1 dedicated-
Copy to Clipboard Toggle word wrap

1.5.2.5. uncordon
リンクのコピー

ノードにスケジュール対象 (schedulable) のマークを付けます。

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

$ oc adm uncordon node1
Copy to Clipboard Toggle word wrap

1.5.3. セキュリティーおよびポリシー CLI コマンド
リンクのコピー

1.5.3.1. certificate
リンクのコピー

証明書署名要求 (CSR) を承認するか、または拒否します。

例: CSR の承認

$ oc adm certificate approve csr-sqgzp
Copy to Clipboard Toggle word wrap

1.5.3.2. groups
リンクのコピー

クラスター内のグループを管理します。

例: 新規グループの作成

$ oc adm groups new my-group
Copy to Clipboard Toggle word wrap

1.5.3.3. new-project
リンクのコピー

新規プロジェクトを作成し、管理オプションを指定します。

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

$ oc adm new-project myproject --node-selector='type=user-node,region=east'
Copy to Clipboard Toggle word wrap

1.5.3.4. pod-network
リンクのコピー

クラスター内の Pod ネットワークを管理します。

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

$ oc adm pod-network isolate-projects project1 project2
Copy to Clipboard Toggle word wrap

1.5.3.5. policy
リンクのコピー

クラスター上のロールおよびポリシーを管理します。

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

$ oc adm policy add-cluster-role-to-user edit user1
Copy to Clipboard Toggle word wrap

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

$ oc adm policy add-scc-to-user privileged -z myserviceaccount
Copy to Clipboard Toggle word wrap

1.5.4. メンテナーンス CLI コマンド
リンクのコピー

1.5.4.1. migrate
リンクのコピー

使用されるサブコマンドに応じて、クラスターのリソースを新規バージョンまたはフォーマットに移行します。

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

$ oc adm migrate storage
Copy to Clipboard Toggle word wrap

例: Pod のみの更新の実行

$ oc adm migrate storage --include=pods
Copy to Clipboard Toggle word wrap

1.5.4.2. prune
リンクのコピー

サーバーから古いバージョンのリソースを削除します。

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

$ oc adm prune builds --orphans
Copy to Clipboard Toggle word wrap

1.5.5. 設定 CLI コマンド
リンクのコピー

1.5.5.1. create-bootstrap-project-template
リンクのコピー

ブートストラッププロジェクトテンプレートを作成します。

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

$ oc adm create-bootstrap-project-template -o yaml
Copy to Clipboard Toggle word wrap

1.5.5.2. create-error-template
リンクのコピー

エラーページをカスタマイズするためのテンプレートを作成します。

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

$ oc adm create-error-template
Copy to Clipboard Toggle word wrap

1.5.5.3. create-kubeconfig
リンクのコピー

クライアント証明書から基本的な .kubeconfig ファイルを作成します。

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

$ oc adm create-kubeconfig \
  --client-certificate=/path/to/client.crt \
  --client-key=/path/to/client.key \
  --certificate-authority=/path/to/ca.crt
Copy to Clipboard Toggle word wrap

1.5.5.4. create-login-template
リンクのコピー

ログインページをカスタマイズするためのテンプレートを作成します。

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

$ oc adm create-login-template
Copy to Clipboard Toggle word wrap

1.5.5.5. create-provider-selection-template
リンクのコピー

プロバイダー選択ページをカスタマイズするためのテンプレートを作成します。

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

$ oc adm create-provider-selection-template
Copy to Clipboard Toggle word wrap

1.5.6. 他の管理者 CLI コマンド
リンクのコピー

1.5.6.1. build-chain
リンクのコピー

ビルドの入力と依存関係を出力します。

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

$ oc adm build-chain perl
Copy to Clipboard Toggle word wrap

1.5.6.2. completion
リンクのコピー

指定されたシェルについての oc adm コマンドのシェル補完コードを出力します。

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

$ oc adm completion bash
Copy to Clipboard Toggle word wrap

1.5.6.3. config
リンクのコピー

クライアント設定ファイルを管理します。このコマンドは、oc config コマンドと同じ動作を実行します。

例: 現在の設定の表示

$ oc adm config view
Copy to Clipboard Toggle word wrap

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

$ oc adm config use-context test-context
Copy to Clipboard Toggle word wrap

1.5.6.4. release
リンクのコピー

リリースについての情報の表示、またはリリースの内容の検査などの OpenShift Container Platform リリースプロセスの様々な側面を管理します。

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

$ oc adm release info --changelog=/tmp/git \
    quay.io/openshift-release-dev/ocp-release:4.5.0-rc.7-x86_64 \
    quay.io/openshift-release-dev/ocp-release:4.5.4-x86_64 \
    > changelog.md
Copy to Clipboard Toggle word wrap

1.5.6.5. verify-image-signature
リンクのコピー

ローカルのパブリック GPG キーを使用して内部レジストリーにインポートされたイメージのイメージ署名を検証します。

例: 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
Copy to Clipboard Toggle word wrap

1.6. oc および kubectl コマンドの使用
リンクのコピー

Kubernetes のコマンドラインインターフェイス (CLI) kubectl は、Kubernetes クラスターに対してコマンドを実行するために使用されます。OpenShift Container Platform は認定 Kubernetes ディストリビューションであるため、OpenShift Container Platform に同梱されるサポート対象の kubectl バイナリーを使用するか、または oc バイナリーを使用して拡張された機能を取得できます。

1.6.1. oc バイナリー
リンクのコピー

oc バイナリーは kubectl バイナリーと同じ機能を提供しますが、これは、以下を含む OpenShift Container Platform 機能をネイティブにサポートするように拡張されています。

  • OpenShift Container Platform リソースの完全サポート

    DeploymentConfig、 BuildConfig、Route、ImageStream、および ImageStreamTag オブジェクトなどのリソースは OpenShift Container Platform ディストリビューションに固有のリソースであり、標準の Kubernetes プリミティブにビルドされます。

  • 認証

    oc バイナリーは、認証を可能にするビルトインの login コマンドを提供し、Kubernetes namespace を認証ユーザーにマップする OpenShift Container Platform プロジェクトを使って作業できるようにします。詳細は、Understanding authentication を参照してください。

  • 追加コマンド

    追加コマンドの oc new-app などは、既存のソースコードまたは事前にビルドされたイメージを使用して新規アプリケーションを起動することを容易にします。同様に、追加コマンドの oc new-project により、デフォルトとして切り替えることができるプロジェクトを簡単に開始できるようになります。

1.6.2. kubectl バイナリー
リンクのコピー

kubectl バイナリーは、標準の Kubernetes 環境を使用する新規 OpenShift Container Platform ユーザー、または kubectl CLI を優先的に使用するユーザーの既存ワークフローおよびスクリプトをサポートする手段として提供されます。kubectl の既存ユーザーはバイナリーを引き続き使用し、OpenShift Container Platform クラスターへの変更なしに Kubernetes のプリミティブと対話できます。

CLI のインストール の手順に従って、サポートされている kubectl バイナリーをインストールできます。kubectl バイナリーは、バイナリーをダウンロードする場合にアーカイブに含まれます。または RPM を使用して CLI のインストール時にインストールされます。

詳細は、kubectl のドキュメント を参照してください。

第2章 Developer CLI (odo)
リンクのコピー

2.1. odo について
リンクのコピー

odo は、OpenShift Container Platform および Kubernetes でアプリケーションを作成するための CLI ツールです。odo を使用すると、クラスター自体を管理する必要なしに、クラスターでアプリケーションを作成し、ビルドし、デバッグできます。デプロイメント設定、ビルド設定、サービスルートおよび他の OpenShift Container Platform または Kubernetes 要素の作成は、すべて odo によって自動化されます。

oc などの既存ツールは操作に重点が置かれ、Kubernetes および OpenShift Container Platform の概念の深い理解が必要です。odo は、複雑な Kubernetes および OpenShift Container Platform の概念を抽象化し、開発者が最も重要なコードにフォーカスできるようにします。

2.1.1. 主な特長
リンクのコピー

odo は、以下の主な特長によって単純化および簡潔化されるように設計されています。

  • プロジェクト、アプリケーションおよびコンポーネントなどの開発者にとって馴染みのある概念を中心とした単純な構文および設計。
  • 完全にクライアントベースである。デプロイメントに OpenShift Container Platform 以外のサーバーは必要ありません。
  • Node.js および Java コンポーネントの正式なサポート。
  • Ruby、Perl、PHP、Python などの言語およびフレームワークとの部分的な互換性。
  • ローカルコードの変更を検出し、これをクラスターに自動的にデプロイ。これにより、変更を検証するためのインスタントフィードバックがリアルタイムに提供されます。
  • クラスターのすべての利用可能なコンポーネントおよびサービスを一覧表示。

2.1.2. コアとなる概念
リンクのコピー

Project
Project (プロジェクト) は、別個の単一の単位で編成されるソースコード、テスト、ライブラリーです。
Application
Application (アプリケーション) は、エンドユーザー向けに設計されたプログラムです。アプリケーションは、アプリケーション全体を構築するために個別に動作する複数のマイクロサービスまたはコンポーネントで設定されます。アプリケーションの例: ビデオゲーム、メディアプレイヤー、Web ブラウザー。
Component
コンポーネントとは、コードまたはデータをホストする Kubernetes リソースのセットです。各コンポーネントは個別に実行され、デプロイできます。コンポーネントの例: Node.js、Perl、PHP、Python、Ruby
サービス
Service (サービス) は、コンポーネントのリンク先となるか、またはコンポーネントが依存するソフトウェアです。サービスの例: MariaDB、Jenkins、MySQLodo では、サービスは OpenShift Service Catalog からプロビジョニングされ、クラスター内で有効にされる必要があります。
2.1.2.1. 正式にサポートされる言語と対応するコンテナーイメージ
リンクのコピー
Expand
表2.1 サポートされる言語、コンテナーイメージ、パッケージマネージャー、およびプラットフォーム
言語コンテナーイメージパッケージマネージャープラットフォーム

Node.js

rhscl/nodejs-10-rhel7

NPM

amd64、s390x、ppc64le

 

rhscl/nodejs-12-rhel7

NPM

amd64、s390x、ppc64le

Java

redhat-openjdk-18/openjdk18-openshift

Maven、Gradle

amd64、s390x、ppc64le

 

openjdk/openjdk-11-rhel8

Maven、Gradle

amd64、s390x、ppc64le

 

openjdk/openjdk-11-rhel7

Maven、Gradle

amd64、s390x、ppc64le

2.1.2.1.1. 利用可能なコンテナーイメージの一覧表示
リンクのコピー
注記

利用可能なコンテナーイメージの一覧は、クラスターの内部コンテナーレジストリーおよびクラスターに関連付けられた外部レジストリーから取得されます。

利用可能なコンポーネントおよびクラスターの関連付けられたコンテナーイメージを一覧表示するには、以下を実行します。

  1. odo でクラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. 利用可能な odo がサポートするコンポーネントとサポートしないコンポーネント、および対応するコンテナーイメージを一覧表示します。 

    $ odo catalog list components
    Copy to Clipboard Toggle word wrap

    出力例

    Odo Devfile Components:
NAME                 DESCRIPTION                            REGISTRY
java-maven           Upstream Maven and OpenJDK 11          DefaultDevfileRegistry
java-openliberty     Open Liberty microservice in Java      DefaultDevfileRegistry
java-quarkus         Upstream Quarkus with Java+GraalVM     DefaultDevfileRegistry
java-springboot      Spring Boot® using Java                DefaultDevfileRegistry
nodejs               Stack with NodeJS 12                   DefaultDevfileRegistry

Odo OpenShift Components:
NAME        PROJECT       TAGS                                                                           SUPPORTED
java        openshift     11,8,latest                                                                    YES
dotnet      openshift     2.1,3.1,latest                                                                 NO
golang      openshift     1.13.4-ubi7,1.13.4-ubi8,latest                                                 NO
httpd       openshift     2.4-el7,2.4-el8,latest                                                         NO
nginx       openshift     1.14-el7,1.14-el8,1.16-el7,1.16-el8,latest                                     NO
nodejs      openshift     10-ubi7,10-ubi8,12-ubi7,12-ubi8,latest                                         NO
perl        openshift     5.26-el7,5.26-ubi8,5.30-el7,latest                                             NO
php         openshift     7.2-ubi7,7.2-ubi8,7.3-ubi7,7.3-ubi8,latest                                     NO
python      openshift     2.7-ubi7,2.7-ubi8,3.6-ubi7,3.6-ubi8,3.8-ubi7,3.8-ubi8,latest                   NO
ruby        openshift     2.5-ubi7,2.5-ubi8,2.6-ubi7,2.6-ubi8,2.7-ubi7,latest                            NO
wildfly     openshift     10.0,10.1,11.0,12.0,13.0,14.0,15.0,16.0,17.0,18.0,19.0,20.0,8.1,9.0,latest     NO
    Copy to Clipboard Toggle word wrap

    TAGS コラムは利用可能なイメージバージョンを表します (例: 10 は rhoar-nodejs/nodejs-10 コンテナーイメージを表します)。

2.2. odo アーキテクチャー
リンクのコピー

このセクションでは、odo アーキテクチャーについて説明し、odo によるリソースのクラスターでの管理方法について説明します。

2.2.1. 開発者の設定
リンクのコピー

odo を使用すると、ターミナルを使って OpenShift Container Platform クラスターでアプリケーションを作成し、デプロイできます。コードエディタープラグインは、ユーザーがそれぞれの IDE ターミナルから OpenShift Container Platform クラスターと対話することを可能にする odo を使用します。odo を使用するプラグインの例: VS Code Openshift Connector、OpenShift Connector for Intellij、Codewind for Eclipse Che。

odo は Windows、macOS、および Linux のオペレーティングシステムで機能し、すべてのターミナルから使用できます。odo は bash および zsh コマンドラインシェルの自動補完を提供します。

odo は Node.js および Java コンポーネントをサポートします。

2.2.2. OpenShift Source-to-Image
リンクのコピー

OpenShift Source-to-Image (S2I) はオープンソースプロジェクトであり、ソースコードからアーティファクトをビルドし、これらをコンテナーイメージに挿入するのに役立ちます。S2I は、Dockerfile なしにソースコードをビルドすることで、実行可能なイメージを生成します。odo は、コンテナー内で開発者ソースコードを実行するために S2I ビルダーイメージを使用します。

2.2.3. OpenShift クラスターオブジェクト
リンクのコピー

2.2.3.1. Init コンテナー
リンクのコピー

init コンテナーはアプリケーションコンテナーが起動する前に実行される特殊なコンテナーであり、アプリケーションコンテナーの実行に必要な環境を設定します。init コンテナーには、アプリケーションイメージにないファイル (設定スクリプトなど) を含めることができます。Init コンテナーは常に完了するまで実行され、Init コンテナーのいずれかに障害が発生した場合にはアプリケーションコンテナーは起動しません。

odo によって作成された Pod は 2 つの Init コンテナーを実行します。

  • copy-supervisord Init コンテナー。
  • copy-files-to-volume Init コンテナー。
2.2.3.1.1. copy-supervisord
リンクのコピー

copy-supervisord Init コンテナーは必要なファイルを emptyDir ボリュームにコピーします。メインのアプリケーションコンテナーはこれらのファイルを emptyDir ボリュームから使用します。

emptyDir ボリュームにコピーされるファイル:

  • バイナリー:

    • go-init は最小限の init システムです。アプリケーションコンテナー内の最初のプロセス (PID 1) として実行されます。go-init は、開発者コードを実行する SupervisorD デーモンを起動します。go-init は、孤立したプロセスを処理するために必要です。
    • SupervisorD はプロセス制御システムです。これは設定されたプロセスを監視し、それらが実行中であることを確認します。また、必要に応じてサービスを再起動します。odo の場合、SupervisorD は開発者コードを実行し、監視します。

  • 設定ファイル:

    • supervisor.conf は、SupervisorD デーモンの起動に必要な設定ファイルです。

  • スクリプト:

    • assemble-and-restart は、ユーザーソースコードをビルドし、デプロイするための OpenShift S2I の概念です。assemble-and-restart スクリプトは、まずアプリケーションコンテナー内でユーザーソースコードをアセンブルしてから、ユーザーの変更を有効にするために SupervisorD を再起動します。
    • Run は、アセンブルされたソースコードを実行することに関連した OpenShift S2I の概念です。run スクリプトは assemble-and-restart スクリプトで作成されたアセンブルされたコードを実行します。
    • s2i-setup は、assemble-and-restart および run スクリプトが正常に実行されるために必要なファイルおよびディレクトリーを作成するスクリプトです。このスクリプトは、アプリケーションのコンテナーが起動されるたびに実行されます。

  • ディレクトリー:

    • language-scripts: OpenShift S2I はカスタムの assemble および run スクリプトを許可します。language-scripts ディレクトリーにいくつかの言語固有のカスタムスクリプトがあります。カスタムスクリプトは、odo のデバッグを機能させる追加の設定を提供します。

emtpyDir ボリュームは、Init コンテナーとアプリケーションコンテナーの両方の /opt/odo マウントポイントにマウントされます。

2.2.3.1.2. copy-files-to-volume
リンクのコピー

copy-files-to-volume Init コンテナーは、S2I ビルダーイメージの /opt/app-root にあるファイルを永続ボリュームにコピーします。次に、ボリュームはアプリケーションコンテナーの同じ場所 (/opt/app-root) にマウントされます。

永続ボリュームが /opt/app-root にないと、このディレクトリーのデータは、永続ボリューム要求 (PVC) が同じ場所にマウントされる際に失われます。

PVC は、Init コンテナー内の /mnt マウントポイントにマウントされます。

2.2.3.2. アプリケーションコンテナー
リンクのコピー

アプリケーションコンテナーは、ユーザーソースコードが実行されるメインコンテナーです。

アプリケーションコンテナーは、以下の 2 つのボリュームでマウントされます。

  • emptyDir ボリュームは /opt/odo にマウントされます。
  • 永続ボリュームは /opt/app-root にマウントされます。

go-init はアプリケーションコンテナー内の最初のプロセスとして実行されます。次に、go-init プロセスは SupervisorD を起動します。

SupervisorD は、ユーザーのアセンブルされたソースコードを実行し、監視します。ユーザープロセスがクラッシュすると、SupervisorD がこれを再起動します。

2.2.3.3. 永続ボリュームおよび永続ボリューム要求 (PVC)
リンクのコピー

永続ボリューム要求 (PVC) は、永続ボリュームをプロビジョニングする Kubernetes のボリュームタイプです。永続ボリュームのライフサイクルは Pod ライフサイクルとは異なります。永続ボリュームのデータは Pod の再起動後も永続します。

copy-files-to-volume Init コンテナーは、必要なファイルを永続ボリュームにコピーします。メインアプリケーションコンテナーは、実行時にこれらのファイルを使用します。

永続ボリュームの命名規則は <component_name>-s2idata です。

Expand
コンテナーPVC のマウント先

copy-files-to-volume

/mnt

アプリケーションコンテナー

/opt/app-root

2.2.3.4. emptyDir ボリューム
リンクのコピー

emptyDir ボリュームは、Pod がノードに割り当てられている際に作成され、Pod がノードで実行されている限り存在します。コンテナーが再起動または移動すると、emptyDir の内容は削除され、Init コンテナーはデータを emptyDir に復元します。emptyDir の初期状態は空です。

copy-supervisord Init コンテナーは必要なファイルを emptyDir ボリュームにコピーします。これらのファイルは、実行時にメインアプリケーションコンテナーによって使用されます。

Expand
コンテナーemptyDir volume のマウント先

copy-supervisord

/opt/odo

アプリケーションコンテナー

/opt/odo

2.2.3.5. サービス
リンクのコピー

サービスは、一連の Pod と通信する方法を抽象化する Kubernetes の概念です。

odo はすべてのアプリケーション Pod についてサービスを作成し、これを通信用にアクセス可能にします。

2.2.4. odo push のワークフロー
リンクのコピー

このセクションでは、odo push ワークフローについて説明します。odo push は必要なすべての OpenShift Container Platform リソースを使って OpenShift Container Platform クラスターにユーザーコードをデプロイします。

  1. リソースの作成

    まだ作成されていない場合には、odo push は以下の OpenShift Container Platform リソースを作成します。

    • DeploymentConfig オブジェクト:

      • 2 つの init コンテナー copy-supervisord および copy-files-to-volume が実行されます。init コンテナーはファイルを emptyDir と PersistentVolume タイプのボリュームのそれぞれにコピーします。
      • アプリケーションコンテナーが起動します。アプリケーションコンテナーの最初のプロセスは、PID=1 の go-init プロセスです。

      • go-init プロセスは SupervisorD デーモンを起動します。

        注記

        ユーザーアプリケーションコードはアプリケーションコンテナーにコピーされていないため、SupervisorD デーモンは run スクリプトを実行しません。

    • Service オブジェクト
    • Secret オブジェクト
    • PersistentVolumeClaim オブジェクト

  2. ファイルのインデックス設定

    • ファイルインデックサーは、ソースコードディレクトリーのファイルをインデックス化します。インデックサーはソースコードディレクトリー間を再帰的に移動し、作成、削除、または名前が変更されたファイルを検出します。
    • ファイルインデックサーは、.odo ディレクトリー内の odo インデックスファイルにインデックス化された情報を維持します。
    • odo インデックスファイルが存在しない場合、ファイルインデックサーの初回の実行時であることを意味し、新規の odo インデックス JSON ファイルが作成されます。odo index JSON ファイルにはファイルマップが含まれます。移動したファイルの相対パスと、変更され、削除されたファイルの絶対パスが含まれます。

  3. コードのプッシュ

    ローカルコードは、通常は /tmp/src の下にあるアプリケーションコンテナーにコピーされます。

  4. assemble-and-restart の実行

    ソースコードのコピーに成功すると、assemble-and-restart スクリプトは実行中のアプリケーションコンテナー内で実行されます。

2.3. odo のインストール
リンクのコピー

以下のセクションでは、CLI を使用して各種の異なるプラットフォームに odo をインストールする方法を説明します。

注記

現時点では、odo はネットワークが制限された環境でのインストールをサポートしていません。

また、OpenShift Container Platform Web コンソールから最新のバイナリーへの URL を見つけるには、右上隅の ? アイコンをクリックし、Command Line Tools を選択します。

2.3.1. odo の Linux へのインストール
リンクのコピー

2.3.1.1. バイナリーインストール
リンクのコピー

手順

  1. バイナリーを取得します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap
2.3.1.2. tarball インストール
リンクのコピー

手順

  1. tarball を取得します。 

    # sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz | gzip -d > /usr/local/bin/odo'
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

2.3.2. odo の IBM Power の Linux へのインストール
リンクのコピー

2.3.2.1. バイナリーインストール
リンクのコピー

手順

  1. バイナリーを取得します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-ppc64le -o /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap
2.3.2.2. tarball インストール
リンクのコピー

手順

  1. tarball を取得します。 

    # sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-ppc64le.tar.gz | gzip -d > /usr/local/bin/odo'
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

2.3.3. odo の IBM Z および LinuxONE の Linux へのインストール
リンクのコピー

2.3.3.1. バイナリーインストール
リンクのコピー

手順

  1. バイナリーを取得します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-s390x -o /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap
2.3.3.2. tarball インストール
リンクのコピー

手順

  1. tarball を取得します。 

    # sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-s390x.tar.gz | gzip -d > /usr/local/bin/odo'
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

2.3.4. odo の Windows へのインストール
リンクのコピー

2.3.4.1. バイナリーインストール
リンクのコピー
  1. 最新の odo.exe ファイルをダウンロードします。
  2. odo.exe の場所を GOPATH/bin ディレクトリーに追加します。
Windows 7/8 の PATH 変数の設定

以下の例は、パス変数の設定方法を示しています。バイナリーは任意の場所に配置することができますが、この例では C:\go-bin を場所に使用します。

  1. C:\go-bin にフォルダーを作成します。
  2. Start を右クリックし、Control Panel をクリックします。
  3. System and Security を選択してから System をクリックします。
  4. 左側のメニューから、Advanced systems settings を選択し、下部にある Environment Variables ボタンをクリックします。
  5. Variable セクションから Path を選択し、Edit をクリックします。
  6. New をクリックしてフィールドに C:\go-bin を入力するか、または Browse をクリックしてディレクトリーを選択してから OK をクリックします。
Windows 10 の PATH 変数の設定

検索機能を使用して 環境変数 を編集します。

  1. Search クリックして、env または environment を入力します。
  2. Edit environment variables for your account を選択します。
  3. Variable セクションから Path を選択し、Edit をクリックします。
  4. New をクリックしてフィールドに C:\go-bin を入力するか、または Browse をクリックしてディレクトリーを選択してから OK をクリックします。

2.3.5. odo の macOS へのインストール
リンクのコピー

2.3.5.1. バイナリーインストール
リンクのコピー

手順

  1. バイナリーを取得します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap
2.3.5.2. tarball インストール
リンクのコピー

手順

  1. tarball を取得します。 

    # sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz | gzip -d > /usr/local/bin/odo'
    Copy to Clipboard Toggle word wrap

  2. ファイルのパーミッションを変更します。 

    # chmod +x /usr/local/bin/odo
    Copy to Clipboard Toggle word wrap

2.4. 制限された環境での odo の使用
リンクのコピー

2.4.1. 制限された環境での odo について
リンクのコピー

odo を非接続のクラスター、または制限された環境でプロビジョニングされたクラスターで実行するには、クラスター管理者がミラーリングされたレジストリーでクラスターを作成していることを確認する必要があります。

非接続クラスターで作業を開始するには、まず odo init イメージをクラスターのレジストリーにプッシュし、ODO_BOOTSTRAPPER_IMAGE 環境変数を使用して odo init イメージパスを上書きする必要があります。

odo init イメージのプッシュ後に、レジストリーから サポートされているビルダーイメージをミラーリングし、ミラーレジストリーを上書き した後に アプリケーションを作成する 必要があります。ビルダーイメージは、アプリケーションのランタイム環境を設定するために必要であり、これにはアプリケーションのビルドに必要なビルドツールが含まれます (例: Node.js の場合は npm、Java の場合は Maven)。ミラーレジストリーには、アプリケーションに必要なすべての依存関係が含まれます。

関連情報

2.4.2. odo init イメージの制限されたクラスターレジストリーへのプッシュ
リンクのコピー

クラスターおよびオペレーティングシステムの設定に応じて、odo init イメージをミラーレジストリーにプッシュするか、または内部レジストリーに直接プッシュできます。

2.4.2.1. 前提条件
リンクのコピー
  • クライアントオペレーティングシステムに oc をインストールします。
  • odo をクライアントオペレーティングシステムにインストールします。
  • 内部レジストリーまたはミラーレジストリーが設定された制限付きクラスターへのアクセス。
2.4.2.2. odo init イメージのミラーレジストリーへのプッシュ
リンクのコピー

オペレーティングシステムによっては、以下のように odo init イメージをミラーレジストリーを持つクラスターにプッシュできます。

2.4.2.2.1. init イメージを Linux のミラーレジストリーにプッシュする
リンクのコピー

手順

  1. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    $ echo <content_of_additional_ca> | base64 --decode > disconnect-ca.crt
    Copy to Clipboard Toggle word wrap

  2. エンコーディングされたルート CA 証明書を適切な場所にコピーします。 

    $ sudo cp ./disconnect-ca.crt /etc/pki/ca-trust/source/anchors/<mirror-registry>.crt
    Copy to Clipboard Toggle word wrap

  3. クライアントプラットフォームで CA を信頼し、OpenShift Container Platform ミラーレジストリーにログインします。 

    $ sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart / docker && docker login <mirror-registry>:5000 -u <username> -p <password>
    Copy to Clipboard Toggle word wrap

  4. odo init イメージをミラーリングします。 

    $ oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  5. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    $ export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap
2.4.2.2.2. init イメージを MacOS のミラーレジストリーにプッシュする
リンクのコピー

手順

  1. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    $ echo <content_of_additional_ca> | base64 --decode > disconnect-ca.crt
    Copy to Clipboard Toggle word wrap

  2. エンコーディングされたルート CA 証明書を適切な場所にコピーします。

    1. Docker UI を使用して Docker を再起動します。

    2. 以下のコマンドを実行します。 

      $ docker login <mirror-registry>:5000 -u <username> -p <password>
      Copy to Clipboard Toggle word wrap

  3. odo init イメージをミラーリングします。 

    $ oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  4. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    $ export ODO_BOOTSTRAPPER_IMAGE=<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap
2.4.2.2.3. Windows のミラーレジストリーに init イメージをプッシュする
リンクのコピー

手順

  1. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    PS C:\> echo <content_of_additional_ca> | base64 --decode > disconnect-ca.crt
    Copy to Clipboard Toggle word wrap

  2. 管理者として、以下のコマンドを実行して、エンコーディングされたルート CA 証明書を適切な場所にコピーします。 

    PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" disconnect-ca.crt
    Copy to Clipboard Toggle word wrap

  3. クライアントプラットフォームで CA を信頼し、OpenShift Container Platform ミラーレジストリーにログインします。

    1. Docker UI を使用して Docker を再起動します。

    2. 以下のコマンドを実行します。 

      PS C:\WINDOWS\system32> docker login <mirror-registry>:5000 -u <username> -p <password>
      Copy to Clipboard Toggle word wrap

  4. odo init イメージをミラーリングします。 

    PS C:\> oc image mirror registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  5. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<mirror-registry>:5000/openshiftdo/odo-init-image-rhel7:<tag>"
    Copy to Clipboard Toggle word wrap
2.4.2.3. odo init イメージを内部レジストリーに直接プッシュする
リンクのコピー

クラスターでイメージを内部レジストリーに直接プッシュできるようにする場合、以下のように odo init イメージをレジストリーにプッシュします。

2.4.2.3.1. init イメージを Linux 上で直接プッシュする
リンクのコピー

手順

  1. デフォルトのルートを有効にします。 

    $ oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registry
    Copy to Clipboard Toggle word wrap

  2. ワイルドカードルート CA を取得します。 

    $ oc get secret router-certs-default -n openshift-ingress -o yaml
    Copy to Clipboard Toggle word wrap

    出力例

    apiVersion: v1
data:
  tls.crt: **************************
  tls.key: ##################
kind: Secret
metadata:
  [...]
type: kubernetes.io/tls
    Copy to Clipboard Toggle word wrap

  3. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    $ echo <tls.crt> | base64 --decode > ca.crt
    Copy to Clipboard Toggle word wrap

  4. クライアントプラットフォームで CA を信頼します。 

    $ sudo cp ca.crt  /etc/pki/ca-trust/source/anchors/externalroute.crt && sudo update-ca-trust enable && sudo systemctl daemon-reload && sudo systemctl restart docker
    Copy to Clipboard Toggle word wrap

  5. 内部レジストリーにログインします。 

    $ oc get route -n openshift-image-registry
NAME       HOST/PORT    PATH   SERVICES     PORT  TERMINATION   WILDCARD
default-route   <registry_path>          image-registry   <all>   reencrypt     None

$ docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
    Copy to Clipboard Toggle word wrap

  6. odo init イメージをプッシュします。 

    $ docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag>

$ docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>

$ docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  7. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    $ export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1
    Copy to Clipboard Toggle word wrap
2.4.2.3.2. init イメージを MacOS 上で直接プッシュする
リンクのコピー

手順

  1. デフォルトのルートを有効にします。 

    $ oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registry
    Copy to Clipboard Toggle word wrap

  2. ワイルドカードルート CA を取得します。 

    $ oc get secret router-certs-default -n openshift-ingress -o yaml
    Copy to Clipboard Toggle word wrap

    出力例

    apiVersion: v1
data:
  tls.crt: **************************
  tls.key: ##################
kind: Secret
metadata:
  [...]
type: kubernetes.io/tls
    Copy to Clipboard Toggle word wrap

  3. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    $ echo <tls.crt> | base64 --decode > ca.crt
    Copy to Clipboard Toggle word wrap

  4. クライアントプラットフォームで CA を信頼します。 

    $ sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ca.crt
    Copy to Clipboard Toggle word wrap

  5. 内部レジストリーにログインします。 

    $ oc get route -n openshift-image-registry
NAME       HOST/PORT    PATH   SERVICES     PORT  TERMINATION   WILDCARD
default-route   <registry_path>          image-registry   <all>   reencrypt     None

$ docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
    Copy to Clipboard Toggle word wrap

  6. odo init イメージをプッシュします。 

    $ docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag>

$ docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>

$ docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  7. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    $ export ODO_BOOTSTRAPPER_IMAGE=<registry_path>/openshiftdo/odo-init-image-rhel7:1.0.1
    Copy to Clipboard Toggle word wrap
2.4.2.3.3. init イメージを Windows 上で直接プッシュする
リンクのコピー

手順

  1. デフォルトのルートを有効にします。 

    PS C:\> oc patch configs.imageregistry.operator.openshift.io cluster -p '{"spec":{"defaultRoute":true}}' --type='merge' -n openshift-image-registry
    Copy to Clipboard Toggle word wrap

  2. ワイルドカードルート CA を取得します。 

    PS C:\> oc get secret router-certs-default -n openshift-ingress -o yaml
    Copy to Clipboard Toggle word wrap

    出力例

    apiVersion: v1
data:
  tls.crt: **************************
  tls.key: ##################
kind: Secret
metadata:
  [...]
type: kubernetes.io/tls
    Copy to Clipboard Toggle word wrap

  3. base64 を使用してミラーレジストリーのルート認証局 (CA) コンテンツをエンコードします。 

    PS C:\> echo <tls.crt> | base64 --decode > ca.crt
    Copy to Clipboard Toggle word wrap

  4. 管理者として、以下のコマンドを実行して、クライアントプラットフォームの CA を信頼します。 

    PS C:\WINDOWS\system32> certutil -addstore -f "ROOT" ca.crt
    Copy to Clipboard Toggle word wrap

  5. 内部レジストリーにログインします。 

    PS C:\> oc get route -n openshift-image-registry
NAME       HOST/PORT    PATH   SERVICES     PORT  TERMINATION   WILDCARD
default-route   <registry_path>          image-registry   <all>   reencrypt     None

PS C:\> docker login <registry_path> -u kubeadmin -p $(oc whoami -t)
    Copy to Clipboard Toggle word wrap

  6. odo init イメージをプッシュします。 

    PS C:\> docker pull registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag>

PS C:\> docker tag registry.access.redhat.com/openshiftdo/odo-init-image-rhel7:<tag> <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>

PS C:\> docker push <registry_path>/openshiftdo/odo-init-image-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  7. ODO_BOOTSTRAPPER_IMAGE 環境変数を設定してデフォルトの odo init イメージパスを上書きします。 

    PS C:\> $env:ODO_BOOTSTRAPPER_IMAGE="<registry_path>/openshiftdo/odo-init-image-rhel7:<tag>"
    Copy to Clipboard Toggle word wrap

2.4.3. コンポーネントの作成および非接続クラスターへのデプロイ
リンクのコピー

ミラーリングされたレジストリーを持つクラスターに init イメージをプッシュした後に、アプリケーションでサポートされるビルダーイメージを oc ツールでミラーリングし、環境変数を使用してミラーレジストリーを上書きし、コンポーネントを作成する必要があります。

2.4.3.1. 前提条件
リンクのコピー
2.4.3.2. サポートされるビルダーイメージのミラーリング
リンクのコピー

Node.js の依存関係に npm パッケージを使用し、Java の依存関係に Maven パッケージを使用し、アプリケーションのランタイム環境を設定するには、ミラーレジストリーから適切なビルダーイメージをミラーリングする必要があります。

手順

  1. 必要なイメージタグがインポートされていないことを確認します。 

    $ oc describe is nodejs -n openshift
    Copy to Clipboard Toggle word wrap

    出力例

    Name:                   nodejs
Namespace:              openshift
[...]

10
  tagged from <mirror-registry>:<port>/rhoar-nodejs/nodejs-10
    prefer registry pullthrough when referencing this tag

  Build and run Node.js 10 applications on RHEL 7. For more information about using this builder image, including OpenShift considerations, see https://github.com/nodeshift/centos7-s2i-nodejs.
  Tags: builder, nodejs, hidden
  Example Repo: https://github.com/sclorg/nodejs-ex.git

  ! error: Import failed (NotFound): dockerimage.image.openshift.io "<mirror-registry>:<port>/rhoar-nodejs/nodejs-10:latest" not found
      About an hour ago

10-SCL (latest)
  tagged from <mirror-registry>:<port>/rhscl/nodejs-10-rhel7
    prefer registry pullthrough when referencing this tag

  Build and run Node.js 10 applications on RHEL 7. For more information about using this builder image, including OpenShift considerations, see https://github.com/nodeshift/centos7-s2i-nodejs.
  Tags: builder, nodejs
  Example Repo: https://github.com/sclorg/nodejs-ex.git

  ! error: Import failed (NotFound): dockerimage.image.openshift.io "<mirror-registry>:<port>/rhscl/nodejs-10-rhel7:latest" not found
      About an hour ago

[...]
    Copy to Clipboard Toggle word wrap

  2. サポートされるイメージタグをプライベートレジストリーに対してミラーリングします。 

    $ oc image mirror registry.access.redhat.com/rhscl/nodejs-10-rhel7:<tag> <private_registry>/rhscl/nodejs-10-rhel7:<tag>
    Copy to Clipboard Toggle word wrap

  3. イメージをインポートします。 

    $ oc tag <mirror-registry>:<port>/rhscl/nodejs-10-rhel7:<tag> nodejs-10-rhel7:latest --scheduled
    Copy to Clipboard Toggle word wrap

    イメージを定期的に再インポートする必要があります。--scheduled フラグは、イメージの自動再インポートを有効にします。

  4. 指定されたタグを持つイメージがインポートされていることを確認します。 

    $ oc describe is nodejs -n openshift
    Copy to Clipboard Toggle word wrap

    出力例

    Name:                   nodejs
[...]
10-SCL (latest)
  tagged from <mirror-registry>:<port>/rhscl/nodejs-10-rhel7
    prefer registry pullthrough when referencing this tag

  Build and run Node.js 10 applications on RHEL 7. For more information about using this builder image, including OpenShift considerations, see https://github.com/nodeshift/centos7-s2i-nodejs.
  Tags: builder, nodejs
  Example Repo: https://github.com/sclorg/nodejs-ex.git

  * <mirror-registry>:<port>/rhscl/nodejs-10-rhel7@sha256:d669ecbc11ac88293de50219dae8619832c6a0f5b04883b480e073590fab7c54
      3 minutes ago

[...]
    Copy to Clipboard Toggle word wrap

2.4.3.3. ミラーレジストリーの上書き
リンクのコピー

Node.js の依存関係用の npm パッケージおよび Java の依存関係用の Maven パッケージをプライベートミラーレジストリーからダウンロードするには、クラスター上にミラー npm または Maven レジストリーを作成し、設定する必要があります。その後、既存のコンポーネントで、または新規コンポーネントの作成時にミラーレジストリーを上書きできます。

手順

  • 既存のコンポーネントでミラーレジストリーを上書きするには、以下を実行します。 

    $ odo config set --env NPM_MIRROR=<npm_mirror_registry>
    Copy to Clipboard Toggle word wrap

  • コンポーネントの作成時にミラーレジストリーを上書きするには、以下を実行します。 

    $ odo component create nodejs --env NPM_MIRROR=<npm_mirror_registry>
    Copy to Clipboard Toggle word wrap
2.4.3.4. odo を使用した Node.js アプリケーションの作成
リンクのコピー

Node.js コンポーネントを作成するには、Node.js アプリケーションをダウンロードし、odo でソースコードをクラスターにプッシュします。

手順

  1. 現在のディレクトリーをアプリケーションのあるディレクトリーに切り替えます。 

    $ cd <directory_name>
    Copy to Clipboard Toggle word wrap

  2. Node.js タイプのコンポーネントをアプリケーションに追加します。 

    $ odo create nodejs
    Copy to Clipboard Toggle word wrap
    注記

    デフォルトで、最新イメージが使用されます。また、odo create openshift/nodejs:8 を使用してイメージのバージョンを明示的に指定できます。

  3. 初期ソースコードをコンポーネントにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    これで、コンポーネントは OpenShift Container Platform にデプロイされます。

  4. URL を作成し、以下のようにローカル設定ファイルにエントリーを追加します。 

    $ odo url create --port 8080
    Copy to Clipboard Toggle word wrap

  5. 変更をプッシュします。これにより、URL がクラスターに作成されます。 

    $ odo push
    Copy to Clipboard Toggle word wrap

  6. コンポーネントに必要な URL を確認するために URL を一覧表示します。 

    $ odo url list
    Copy to Clipboard Toggle word wrap

  7. 生成された URL を使用してデプロイされたアプリケーションを表示します。 

    $ curl <url>
    Copy to Clipboard Toggle word wrap

2.5. odo を使用した単一コンポーネントアプリケーションの作成
リンクのコピー

odo を使用すると、クラスターでアプリケーションを作成し、デプロイできます。

2.5.1. 前提条件
リンクのコピー

  • odo がインストールされている。
  • 実行中のクラスターがある。CodeReady Containers (CRC) を使用して、ローカルクラスターを迅速にデプロイできます。

2.5.2. プロジェクトの作成
リンクのコピー

プロジェクトを作成し、別個の単一の単位で編成されるソースコード、テスト、ライブラリーを維持します。

手順

  1. OpenShift Container Platform クラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. プロジェクトを作成します。 

    $ odo project create myproject
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Project 'myproject' is ready for use
 ✓  New project created and now using project : myproject
    Copy to Clipboard Toggle word wrap

2.5.3. odo を使用した Node.js アプリケーションの作成
リンクのコピー

Node.js コンポーネントを作成するには、Node.js アプリケーションをダウンロードし、odo でソースコードをクラスターにプッシュします。

手順

  1. コンポーネントの新規ディレクトリーを作成します。 

    $ mkdir my_components && cd my_components
    Copy to Clipboard Toggle word wrap

  2. Node.js アプリケーションのサンプルをダウンロードします。 

    $ git clone https://github.com/openshift/nodejs-ex
    Copy to Clipboard Toggle word wrap

  3. 現在のディレクトリーをアプリケーションのあるディレクトリーに切り替えます。 

    $ cd <directory_name>
    Copy to Clipboard Toggle word wrap

  4. Node.js タイプのコンポーネントをアプリケーションに追加します。 

    $ odo create nodejs
    Copy to Clipboard Toggle word wrap
    注記

    デフォルトで、最新イメージが使用されます。また、odo create openshift/nodejs:8 を使用してイメージのバージョンを明示的に指定できます。

  5. 初期ソースコードをコンポーネントにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    これで、コンポーネントは OpenShift Container Platform にデプロイされます。

  6. URL を作成し、以下のようにローカル設定ファイルにエントリーを追加します。 

    $ odo url create --port 8080
    Copy to Clipboard Toggle word wrap

  7. 変更をプッシュします。これにより、URL がクラスターに作成されます。 

    $ odo push
    Copy to Clipboard Toggle word wrap

  8. コンポーネントに必要な URL を確認するために URL を一覧表示します。 

    $ odo url list
    Copy to Clipboard Toggle word wrap

  9. 生成された URL を使用してデプロイされたアプリケーションを表示します。 

    $ curl <url>
    Copy to Clipboard Toggle word wrap

2.5.4. アプリケーションコードの変更
リンクのコピー

アプリケーションコードを変更し、それらの変更を OpenShift Container Platform のアプリケーションに適用します。

  1. 選択するテキストエディターで、Node.js ディレクトリー内のレイアウトファイルのいずれかを編集します。

  2. コンポーネントを更新します。 

    $ odo push
    Copy to Clipboard Toggle word wrap
  3. ブラウザーでアプリケーションを更新し、変更を確認します。

2.5.5. ストレージのアプリケーションコンポーネントへの追加
リンクのコピー

永続ストレージは、odo を再起動してもデータを利用可能な状態に維持します。odo storage コマンドを使用して、永続データをアプリケーションに追加します。永続化する必要のあるデータの例には、.m2 Maven ディレクトリーなどのデータベースファイル、依存関係、およびビルドアーティファクトが含まれます。

手順

  1. ストレージをコンポーネントに追加します。 

    $ odo storage create <storage_name> --path=<path_to_the_directory> --size=<size>
    Copy to Clipboard Toggle word wrap

  2. ストレージをクラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

  3. コンポーネント内のすべてのストレージを一覧表示して、ストレージがコンポーネントに割り当てられていることを確認します。 

    $ odo storage list
    Copy to Clipboard Toggle word wrap

    出力例

    The component 'nodejs' has the following storage attached:
NAME           SIZE     PATH      STATE
mystorage      1Gi      /data     Pushed
    Copy to Clipboard Toggle word wrap

  4. コンポーネントからストレージを削除します。 

    $ odo storage delete <storage_name>
    Copy to Clipboard Toggle word wrap

  5. すべてのストレージを一覧表示して、ストレージの状態が Locally Deletedd (ローカルに削除) であることを確認します。 

    $ odo storage list
    Copy to Clipboard Toggle word wrap

    出力例

    The component 'nodejs' has the following storage attached:
NAME           SIZE     PATH      STATE
mystorage      1Gi      /data     Locally Deleted
    Copy to Clipboard Toggle word wrap

  6. 変更をクラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

2.5.6. ビルドイメージを指定するためのカスタムビルダーの追加
リンクのコピー

OpenShift Container Platform では、カスタムイメージの作成ごとに発生する差を埋めるカスタムイメージを追加できます。

以下の例は、redhat-openjdk-18 イメージの正常なインポートおよび使用方法について示しています。

前提条件

  • OpenShift CLI (oc) がインストールされている。

手順

  1. イメージを OpenShift Container Platform にインポートします。 

    $ oc import-image openjdk18 \
--from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift \
--confirm
    Copy to Clipboard Toggle word wrap

  2. イメージにタグを付け、odo からアクセスできるようにします。 

    $ oc annotate istag/openjdk18:latest tags=builder
    Copy to Clipboard Toggle word wrap

  3. odo でイメージをデプロイします。 

    $ odo create openjdk18 --git \
https://github.com/openshift-evangelists/Wild-West-Backend
    Copy to Clipboard Toggle word wrap

2.5.7. OpenShift Service Catalog を使用したアプリケーションの複数サービスへの接続
リンクのコピー

OpenShift サービスカタログは、Kubernetes 用の Open Service Broker API (OSB API) の実装です。これを使用すると、OpenShift Container Platform にデプロイされているアプリケーションをさまざまなサービスに接続できます。

前提条件

  • OpenShift Container Platform クラスターが実行中である。
  • サービスカタログがクラスターにインストールされ、有効にされている。

手順

  • サービスを一覧表示するには、以下を使用します。 

    $ odo catalog list services
    Copy to Clipboard Toggle word wrap

  • サービスカタログ関連の操作を使用するには、以下を実行します。 

    $ odo service <verb> <service_name>
    Copy to Clipboard Toggle word wrap

2.5.8. アプリケーションの削除
リンクのコピー

重要

アプリケーションを削除すると、アプリケーションに関連付けられたすべてのコンポーネントが削除されます。

手順

  1. 現在のプロジェクトのアプリケーションを一覧表示します。 

    $ odo app list
    Copy to Clipboard Toggle word wrap

    出力例

        The project '<project_name>' has the following applications:
    NAME
    app
    Copy to Clipboard Toggle word wrap

  2. アプリケーションに関連付けられたコンポーネントを一覧表示します。これらのコンポーネントはアプリケーションと共に削除されます。 

    $ odo component list
    Copy to Clipboard Toggle word wrap

    出力例

        APP     NAME                      TYPE       SOURCE        STATE
    app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed
    Copy to Clipboard Toggle word wrap

  3. アプリケーションを削除します。 

    $ odo app delete <application_name>
    Copy to Clipboard Toggle word wrap

    出力例

        ? Are you sure you want to delete the application: <application_name> from project: <project_name>
    Copy to Clipboard Toggle word wrap

  4. Y で削除を確定します。-f フラグを使用すると、確認プロンプトを非表示にできます。

2.6. odo を使用したマルチコンポーネントアプリケーションの作成
リンクのコピー

odo を使用すると、簡単かつ自動化された方法でマルチコンポーネントアプリケーションを作成し、変更し、そのコンポーネントをリンクすることができます。

この例では、マルチコンポーネントアプリケーション (シューティングゲーム) をデプロイする方法について説明します。アプリケーションはフロントエンド Node.js コンポーネントとバックエンド Java コンポーネントで設定されます。

2.6.1. 前提条件
リンクのコピー

  • odo がインストールされている。
  • 実行中のクラスターがある。開発者は、CodeReady Containers (CRC) を使用して、ローカルクラスターを迅速にデプロイできます。
  • Maven がインストールされている。

2.6.2. プロジェクトの作成
リンクのコピー

プロジェクトを作成し、別個の単一の単位で編成されるソースコード、テスト、ライブラリーを維持します。

手順

  1. OpenShift Container Platform クラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. プロジェクトを作成します。 

    $ odo project create myproject
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Project 'myproject' is ready for use
 ✓  New project created and now using project : myproject
    Copy to Clipboard Toggle word wrap

2.6.3. バックエンドコンポーネントのデプロイ
リンクのコピー

Java コンポーネントを作成するには、Java ビルダーイメージをインポートし、Java アプリケーションをダウンロードし、odo でソースコードをクラスターにプッシュします。

手順

  1. openjdk18 をクラスターにインポートします。 

    $ oc import-image openjdk18 \
--from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift --confirm
    Copy to Clipboard Toggle word wrap

  2. イメージに builder のタグを付け、イメージが odo でアクセスできるようにします。 

    $ oc annotate istag/openjdk18:latest tags=builder
    Copy to Clipboard Toggle word wrap

  3. odo catalog list components を実行し、作成されたイメージを表示します。 

    $ odo catalog list components
    Copy to Clipboard Toggle word wrap

    出力例

    Odo Devfile Components:
NAME                 DESCRIPTION                            REGISTRY
java-maven           Upstream Maven and OpenJDK 11          DefaultDevfileRegistry
java-openliberty     Open Liberty microservice in Java      DefaultDevfileRegistry
java-quarkus         Upstream Quarkus with Java+GraalVM     DefaultDevfileRegistry
java-springboot      Spring Boot® using Java                DefaultDevfileRegistry
nodejs               Stack with NodeJS 12                   DefaultDevfileRegistry

Odo OpenShift Components:
NAME        PROJECT       TAGS                                                                           SUPPORTED
java        openshift     11,8,latest                                                                    YES
dotnet      openshift     2.1,3.1,latest                                                                 NO
golang      openshift     1.13.4-ubi7,1.13.4-ubi8,latest                                                 NO
httpd       openshift     2.4-el7,2.4-el8,latest                                                         NO
nginx       openshift     1.14-el7,1.14-el8,1.16-el7,1.16-el8,latest                                     NO
nodejs      openshift     10-ubi7,10-ubi8,12-ubi7,12-ubi8,latest                                         NO
perl        openshift     5.26-el7,5.26-ubi8,5.30-el7,latest                                             NO
php         openshift     7.2-ubi7,7.2-ubi8,7.3-ubi7,7.3-ubi8,latest                                     NO
python      openshift     2.7-ubi7,2.7-ubi8,3.6-ubi7,3.6-ubi8,3.8-ubi7,3.8-ubi8,latest                   NO
ruby        openshift     2.5-ubi7,2.5-ubi8,2.6-ubi7,2.6-ubi8,2.7-ubi7,latest                            NO
wildfly     openshift     10.0,10.1,11.0,12.0,13.0,14.0,15.0,16.0,17.0,18.0,19.0,20.0,8.1,9.0,latest     NO
    Copy to Clipboard Toggle word wrap

  4. コンポーネントの新規ディレクトリーを作成します。 

    $ mkdir my_components && cd my_components
    Copy to Clipboard Toggle word wrap

  5. バックエンドアプリケーションのサンプルをダウンロードします。 

    $ git clone https://github.com/openshift-evangelists/Wild-West-Backend backend
    Copy to Clipboard Toggle word wrap

  6. バックエンドソースディレクトリーに移動します。 

    $ cd backend
    Copy to Clipboard Toggle word wrap

  7. ディレクトリーに正しいファイルがあることを確認します。 

    $ ls
    Copy to Clipboard Toggle word wrap

    出力例

    debug.sh  pom.xml  src
    Copy to Clipboard Toggle word wrap

  8. バックエンドのソースファイルを Maven でビルドし、JAR ファイルを作成します。 

    $ mvn package
    Copy to Clipboard Toggle word wrap

    出力例

    ...
[INFO] --------------------------------------
[INFO] BUILD SUCCESS
[INFO] --------------------------------------
[INFO] Total time: 2.635 s
[INFO] Finished at: 2019-09-30T16:11:11-04:00
[INFO] Final Memory: 30M/91M
[INFO] --------------------------------------
    Copy to Clipboard Toggle word wrap

  9. backend という Java コンポーネントタイプのコンポーネント設定を作成します。 

    $ odo create openjdk18 backend --binary target/wildwest-1.0.jar
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Validating component [1ms]
 Please use `odo push` command to create the component with source deployed
    Copy to Clipboard Toggle word wrap

    設定ファイルの config.yaml は、デプロイ用のコンポーネントについての情報が含まれるバックエンドコンポーネントのローカルディレクトリーに置かれます。

  10. 以下を使用して config.yaml ファイルでバックエンドコンポーネントの設定内容を確認します。 

    $ odo config view
    Copy to Clipboard Toggle word wrap

    出力例

    COMPONENT SETTINGS
------------------------------------------------
PARAMETER         CURRENT_VALUE
Type              openjdk18
Application       app
Project           myproject
SourceType        binary
Ref
SourceLocation    target/wildwest-1.0.jar
Ports             8080/TCP,8443/TCP,8778/TCP
Name              backend
MinMemory
MaxMemory
DebugPort
Ignore
MinCPU
MaxCPU
    Copy to Clipboard Toggle word wrap

  11. コンポーネントを OpenShift Container Platform クラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    出力例

    Validation
 ✓  Checking component [6ms]

Configuration changes
 ✓  Initializing component
 ✓  Creating component [124ms]

Pushing to component backend of type binary
 ✓  Checking files for pushing [1ms]
 ✓  Waiting for component to start [48s]
 ✓  Syncing files to the component [811ms]
 ✓  Building component [3s]
    Copy to Clipboard Toggle word wrap

    odo push を使用すると、OpenShift Container Platform はバックエンドコンポーネントをホストするためのコンテナーを作成し、そのコンテナーを OpenShift Container Platform クラスターで実行されている Pod にデプロイし、 backend コンポーネントを起動します。

  12. 以下を検証します。

    • odo でのアクションのステータス 

      $ odo log -f
      Copy to Clipboard Toggle word wrap

      出力例

      2019-09-30 20:14:19.738  INFO 444 --- [           main] c.o.wildwest.WildWestApplication         : Starting WildWestApplication v1.0 onbackend-app-1-9tnhc with PID 444 (/deployments/wildwest-1.0.jar started by jboss in /deployments)
      Copy to Clipboard Toggle word wrap

    • バックエンドコンポーネントのステータス 

      $ odo list
      Copy to Clipboard Toggle word wrap

      出力例

      APP     NAME        TYPE          SOURCE                             STATE
app     backend     openjdk18     file://target/wildwest-1.0.jar     Pushed
      Copy to Clipboard Toggle word wrap

2.6.4. フロントエンドコンポーネントのデプロイ
リンクのコピー

フロントエンドコンポーネントを作成およびデプロイするには、Node.js アプリケーションをダウンロードし、ソースコードを odo でクラスターにプッシュします。

手順

  1. フロントエンドアプリケーションのサンプルをダウンロードします。 

    $ git clone https://github.com/openshift/nodejs-ex frontend
    Copy to Clipboard Toggle word wrap

  2. 現在のディレクトリーをフロントエンドディレクトリーに切り替えます。 

    $ cd frontend
    Copy to Clipboard Toggle word wrap

  3. フロントエンドが Node.js アプリケーションであることを確認するために、ディレクトリーの内容を一覧表示します。 

    $ ls
    Copy to Clipboard Toggle word wrap

    出力例

    README.md       openshift       server.js       views
helm            package.json    tests
    Copy to Clipboard Toggle word wrap

    注記

    フロントエンドコンポーネントはインタプリター型言語で記述され (Node.js)、ビルドされる必要はありません。

  4. frontend という名前の Node.js コンポーネントタイプのコンポーネント設定を作成します。 

    $ odo create nodejs frontend
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Validating component [5ms]
Please use `odo push` command to create the component with source deployed
    Copy to Clipboard Toggle word wrap

  5. コンポーネントを実行中のコンテナーにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    出力例

    Validation
 ✓  Checking component [8ms]

Configuration changes
 ✓  Initializing component
 ✓  Creating component [83ms]

Pushing to component frontend of type local
 ✓  Checking files for pushing [2ms]
 ✓  Waiting for component to start [45s]
 ✓  Syncing files to the component [3s]
 ✓  Building component [18s]
 ✓  Changes successfully pushed to component
    Copy to Clipboard Toggle word wrap

2.6.5. 2 つのコンポーネントのリンク
リンクのコピー

クラスターで実行されるコンポーネントは、対話するために接続される必要があります。OpenShift Container Platform は、リンクの仕組みを提供し、プログラムからクライアントへの通信バインディングを公開します。

手順

  1. クラスターで実行されるすべてのコンポーネントの一覧を表示します。 

    $ odo list
    Copy to Clipboard Toggle word wrap

    出力例

    OpenShift Components:
APP     NAME         PROJECT     TYPE          SOURCETYPE     STATE
app     backend      testpro     openjdk18     binary         Pushed
app     frontend     testpro     nodejs        local          Pushed
    Copy to Clipboard Toggle word wrap

  2. 現在のフロントエンドコンポーネントをバックエンドにリンクします。 

    $ odo link backend --port 8080
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Component backend has been successfully linked from the component frontend

Following environment variables were added to frontend component:
- COMPONENT_BACKEND_HOST
- COMPONENT_BACKEND_PORT
    Copy to Clipboard Toggle word wrap

    バックエンドコンポーネントの設定情報がフロントエンドコンポーネントに追加され、フロントエンドコンポーネントが再起動します。

2.6.6. コンポーネントの公開
リンクのコピー

手順

  1. frontend ディレクトリーに移動します。 

    $ cd frontend
    Copy to Clipboard Toggle word wrap

  2. アプリケーションの外部 URL を作成します。 

    $ odo url create frontend --port 8080
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  URL frontend created for component: frontend

To create URL on the OpenShift  cluster, use `odo push`
    Copy to Clipboard Toggle word wrap

  3. 変更を適用します。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    出力例

    Validation
 ✓  Checking component [21ms]

Configuration changes
 ✓  Retrieving component data [35ms]
 ✓  Applying configuration [29ms]

Applying URL changes
 ✓  URL frontend: http://frontend-app-myproject.192.168.42.79.nip.io created

Pushing to component frontend of type local
 ✓  Checking file changes for pushing [1ms]
 ✓  No file changes detected, skipping build. Use the '-f' flag to force the build.
    Copy to Clipboard Toggle word wrap

  4. ブラウザーで URL を開き、アプリケーションを表示します。
注記

アプリケーションに OpenShift Container Platform namespace にアクセスし、アクティブな Pod を削除するのに有効なサービスアカウントのパーミッションが必要な場合、バックエンドコンポーネントから odo log を参照すると以下のエラーが発生する場合があります。

Message: Forbidden!Configured service account doesn't have access.Service account may have been revoked

このエラーを解決するには、サービスアカウントロールのパーミッションを追加します。 

$ oc policy add-role-to-group view system:serviceaccounts -n <project>
Copy to Clipboard Toggle word wrap 
$ oc policy add-role-to-group edit system:serviceaccounts -n <project>
Copy to Clipboard Toggle word wrap

これは実稼働クラスターでは実行しないでください。

2.6.7. 実行中のアプリケーションの変更
リンクのコピー

手順

  1. ローカルディレクトリーをフロントエンドディレクトリーに切り替えます。 

    $ cd frontend
    Copy to Clipboard Toggle word wrap

  2. 以下のコマンドを実行して、ファイルシステムで変更を監視します。 

    $ odo watch
    Copy to Clipboard Toggle word wrap

  3. index.html ファイルを編集して、ゲームの表示される名前を変更します。

    注記

    odo が変更を認識するまでに若干の遅延が発生する場合があります。

    odo は変更をフロントエンドコンポーネントにプッシュし、そのステータスをターミナルに印刷します。 

    File /root/frontend/index.html changed
File  changed
Pushing files...
 ✓  Waiting for component to start
 ✓  Copying files to component
 ✓  Building component
    Copy to Clipboard Toggle word wrap
  4. Web ブラウザーでアプリケーションページを更新します。これで新しい名前が表示されます。

2.6.8. アプリケーションの削除
リンクのコピー

重要

アプリケーションを削除すると、アプリケーションに関連付けられたすべてのコンポーネントが削除されます。

手順

  1. 現在のプロジェクトのアプリケーションを一覧表示します。 

    $ odo app list
    Copy to Clipboard Toggle word wrap

    出力例

        The project '<project_name>' has the following applications:
    NAME
    app
    Copy to Clipboard Toggle word wrap

  2. アプリケーションに関連付けられたコンポーネントを一覧表示します。これらのコンポーネントはアプリケーションと共に削除されます。 

    $ odo component list
    Copy to Clipboard Toggle word wrap

    出力例

        APP     NAME                      TYPE       SOURCE        STATE
    app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed
    Copy to Clipboard Toggle word wrap

  3. アプリケーションを削除します。 

    $ odo app delete <application_name>
    Copy to Clipboard Toggle word wrap

    出力例

        ? Are you sure you want to delete the application: <application_name> from project: <project_name>
    Copy to Clipboard Toggle word wrap

  4. Y で削除を確定します。-f フラグを使用すると、確認プロンプトを非表示にできます。

2.7. データベースと共にアプリケーションを作成する
リンクのコピー

以下の例では、データベースをフロントエンドアプリケーションにデプロイし、接続する方法を説明します。

2.7.1. 前提条件
リンクのコピー

  • odo がインストールされている。
  • oc クライアントがインストールされている。
  • 実行中のクラスターがある。開発者は、CodeReady Containers (CRC) を使用して、ローカルクラスターを迅速にデプロイできます。

  • サービスカタログがクラスターにインストールされ、有効にされている。

    注記

    サービスカタログは OpenShift Container Platform 4 以降では非推奨になっています。

2.7.2. プロジェクトの作成
リンクのコピー

プロジェクトを作成し、別個の単一の単位で編成されるソースコード、テスト、ライブラリーを維持します。

手順

  1. OpenShift Container Platform クラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. プロジェクトを作成します。 

    $ odo project create myproject
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Project 'myproject' is ready for use
 ✓  New project created and now using project : myproject
    Copy to Clipboard Toggle word wrap

2.7.3. フロントエンドコンポーネントのデプロイ
リンクのコピー

フロントエンドコンポーネントを作成およびデプロイするには、Node.js アプリケーションをダウンロードし、ソースコードを odo でクラスターにプッシュします。

手順

  1. フロントエンドアプリケーションのサンプルをダウンロードします。 

    $ git clone https://github.com/openshift/nodejs-ex frontend
    Copy to Clipboard Toggle word wrap

  2. 現在のディレクトリーをフロントエンドディレクトリーに切り替えます。 

    $ cd frontend
    Copy to Clipboard Toggle word wrap

  3. フロントエンドが Node.js アプリケーションであることを確認するために、ディレクトリーの内容を一覧表示します。 

    $ ls
    Copy to Clipboard Toggle word wrap

    出力例

    README.md       openshift       server.js       views
helm            package.json    tests
    Copy to Clipboard Toggle word wrap

    注記

    フロントエンドコンポーネントはインタプリター型言語で記述され (Node.js)、ビルドされる必要はありません。

  4. frontend という名前の Node.js コンポーネントタイプのコンポーネント設定を作成します。 

    $ odo create nodejs frontend
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Validating component [5ms]
Please use `odo push` command to create the component with source deployed
    Copy to Clipboard Toggle word wrap

  5. フロントエンドインターフェイスにアクセスするための URL を作成します。 

    $ odo url create myurl
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  URL myurl created for component: nodejs-nodejs-ex-pmdp
    Copy to Clipboard Toggle word wrap

  6. コンポーネントを OpenShift Container Platform クラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    出力例

    Validation
 ✓  Checking component [7ms]

 Configuration changes
 ✓  Initializing component
 ✓  Creating component [134ms]

 Applying URL changes
 ✓  URL myurl: http://myurl-app-myproject.192.168.42.79.nip.io created

 Pushing to component nodejs-nodejs-ex-mhbb of type local
 ✓  Checking files for pushing [657850ns]
 ✓  Waiting for component to start [6s]
 ✓  Syncing files to the component [408ms]
 ✓  Building component [7s]
 ✓  Changes successfully pushed to component
    Copy to Clipboard Toggle word wrap

2.7.4. 対話モードでデータベースをデプロイする
リンクのコピー

odo は、デプロイをシンプルにするコマンドラインの対話モードを提供します。

手順

  • 対話モードを実行し、プロンプトに対応します。 

    $ odo service create
    Copy to Clipboard Toggle word wrap

    出力例

    ? Which kind of service do you wish to create database
? Which database service class should we use mongodb-persistent
? Enter a value for string property DATABASE_SERVICE_NAME (Database Service Name): mongodb
? Enter a value for string property MEMORY_LIMIT (Memory Limit): 512Mi
? Enter a value for string property MONGODB_DATABASE (MongoDB Database Name): sampledb
? Enter a value for string property MONGODB_VERSION (Version of MongoDB Image): 3.2
? Enter a value for string property VOLUME_CAPACITY (Volume Capacity): 1Gi
? Provide values for non-required properties No
? How should we name your service  mongodb-persistent
? Output the non-interactive version of the selected options No
? Wait for the service to be ready No
 ✓  Creating service [32ms]
 ✓  Service 'mongodb-persistent' was created
Progress of the provisioning will not be reported and might take a long time.
You can see the current status by executing 'odo service list'
    Copy to Clipboard Toggle word wrap

注記

パスワードまたはユーザー名がフロントエンドアプリケーションに環境変数として渡されます。

2.7.5. データベースの手動デプロイ
リンクのコピー

  1. 利用可能なサービスを一覧表示します。 

    $ odo catalog list services
    Copy to Clipboard Toggle word wrap

    出力例

    NAME                         PLANS
django-psql-persistent       default
jenkins-ephemeral            default
jenkins-pipeline-example     default
mariadb-persistent           default
mongodb-persistent           default
mysql-persistent             default
nodejs-mongo-persistent      default
postgresql-persistent        default
rails-pgsql-persistent       default
    Copy to Clipboard Toggle word wrap

  2. サービスの mongodb-persistent タイプを選択し、必要なパラメーターを確認します。 

    $ odo catalog describe service mongodb-persistent
    Copy to Clipboard Toggle word wrap

    出力例

      ***********************        | *****************************************************
  Name                           | default
  -----------------              | -----------------
  Display Name                   |
  -----------------              | -----------------
  Short Description              | Default plan
  -----------------              | -----------------
  Required Params without a      |
  default value                  |
  -----------------              | -----------------
  Required Params with a default | DATABASE_SERVICE_NAME
  value                          | (default: 'mongodb'),
                                 | MEMORY_LIMIT (default:
                                 | '512Mi'), MONGODB_VERSION
                                 | (default: '3.2'),
                                 | MONGODB_DATABASE (default:
                                 | 'sampledb'), VOLUME_CAPACITY
                                 | (default: '1Gi')
  -----------------              | -----------------
  Optional Params                | MONGODB_ADMIN_PASSWORD,
                                 | NAMESPACE, MONGODB_PASSWORD,
                                 | MONGODB_USER
    Copy to Clipboard Toggle word wrap

  3. 必須のパラメーターをフラグとして渡し、データベースのデプロイを待機します。 

    $ odo service create mongodb-persistent --plan default --wait -p DATABASE_SERVICE_NAME=mongodb -p MEMORY_LIMIT=512Mi -p MONGODB_DATABASE=sampledb -p VOLUME_CAPACITY=1Gi
    Copy to Clipboard Toggle word wrap

2.7.6. データベースのフロントエンドアプリケーションへの接続
リンクのコピー

  1. データベースをフロントエンドサービスにリンクします。 

    $ odo link mongodb-persistent
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Service mongodb-persistent has been successfully linked from the component nodejs-nodejs-ex-mhbb

Following environment variables were added to nodejs-nodejs-ex-mhbb component:
- database_name
- password
- uri
- username
- admin_password
    Copy to Clipboard Toggle word wrap

  2. Pod のアプリケーションおよびデータベースの環境変数を確認します。

    1. Pod 名を取得します。 

      $ oc get pods
      Copy to Clipboard Toggle word wrap

      出力例

      NAME                                READY     STATUS    RESTARTS   AGE
mongodb-1-gsznc                     1/1       Running   0          28m
nodejs-nodejs-ex-mhbb-app-4-vkn9l   1/1       Running   0          1m
      Copy to Clipboard Toggle word wrap

    2. Pod に接続します。 

      $ oc rsh nodejs-nodejs-ex-mhbb-app-4-vkn9l
      Copy to Clipboard Toggle word wrap

    3. 環境変数を確認します。 

      sh-4.2$ env
      Copy to Clipboard Toggle word wrap

      出力例

      uri=mongodb://172.30.126.3:27017
password=dHIOpYneSkX3rTLn
database_name=sampledb
username=user43U
admin_password=NCn41tqmx7RIqmfv
      Copy to Clipboard Toggle word wrap

  3. ブラウザーで URL を開き、右下に表示されるデータベース設定を確認します。 

    $ odo url list
    Copy to Clipboard Toggle word wrap

    出力例

    Request information
Page view count: 24

DB Connection Info:
Type:	MongoDB
URL:	mongodb://172.30.126.3:27017/sampledb
    Copy to Clipboard Toggle word wrap

2.7.7. アプリケーションの削除
リンクのコピー

重要

アプリケーションを削除すると、アプリケーションに関連付けられたすべてのコンポーネントが削除されます。

手順

  1. 現在のプロジェクトのアプリケーションを一覧表示します。 

    $ odo app list
    Copy to Clipboard Toggle word wrap

    出力例

        The project '<project_name>' has the following applications:
    NAME
    app
    Copy to Clipboard Toggle word wrap

  2. アプリケーションに関連付けられたコンポーネントを一覧表示します。これらのコンポーネントはアプリケーションと共に削除されます。 

    $ odo component list
    Copy to Clipboard Toggle word wrap

    出力例

        APP     NAME                      TYPE       SOURCE        STATE
    app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed
    Copy to Clipboard Toggle word wrap

  3. アプリケーションを削除します。 

    $ odo app delete <application_name>
    Copy to Clipboard Toggle word wrap

    出力例

        ? Are you sure you want to delete the application: <application_name> from project: <project_name>
    Copy to Clipboard Toggle word wrap

  4. Y で削除を確定します。-f フラグを使用すると、確認プロンプトを非表示にできます。

2.8. odo での devfile の使用
リンクのコピー

重要

odo で devfile を使用したアプリケーションの作成はテクノロジープレビュー機能です。テクノロジープレビュー機能は Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲についての詳細は、https://access.redhat.com/ja/support/offerings/techpreview/ を参照してください。

2.8.1. odo での devfile について
リンクのコピー

devfile は、開発環境を記述する移植可能 (portable) ファイルです。devfile を使用すると、再設定をせずに移植可能な開発環境を定義できます。

devfile を使用すると、ソースコード、IDE ツール、アプリケーションランタイム、事前定義コマンドなどの開発環境を記述できます。devfile の詳細は、devfile ドキュメント を参照してください。

odo を使用して、devfile からコンポーネントを作成することができます。devfile を使用してコンポーネントを作成する場合、odo は devfile を OpenShift Container Platform、Kubernetes、または Docker で実行される複数のコンテナーで設定されるワークスペースに変換します。odo はデフォルトの devfile レジストリーを自動的に使用しますが、ユーザーは独自のレジストリーを追加できます。

2.8.2. devfile を使用した Java アプリケーションの作成
リンクのコピー

2.8.3. 前提条件
リンクのコピー

  • odo がインストールされている。
  • Ingress ドメインクラスター名を把握している必要がある。不明な場合は、クラスター管理者にお問い合わせください。たとえば、apps-crc.testing は Red Hat CodeReady コンテナー のクラスターのドメイン名です。

  • odo で実験モード (Experimental Mode) を有効にしている。

    • odo 設定で実験モードを有効にするには、odo preference set Experimental true を実行するか、または環境変数 odo config set --env ODO_EXPERIMENTAL=true を使用します。
2.8.3.1. プロジェクトの作成
リンクのコピー

プロジェクトを作成し、別個の単一の単位で編成されるソースコード、テスト、ライブラリーを維持します。

手順

  1. OpenShift Container Platform クラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. プロジェクトを作成します。 

    $ odo project create myproject
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Project 'myproject' is ready for use
 ✓  New project created and now using project : myproject
    Copy to Clipboard Toggle word wrap

2.8.3.2. 利用可能な devfile コンポーネントの一覧表示
リンクのコピー

odo を使用して、クラスター上で利用可能なすべてのコンポーネントを表示できます。利用可能なコンポーネントはクラスターの設定によって異なります。

手順

  1. クラスターで利用可能な devfile コンポーネントを一覧表示するには、以下を実行します。 

    $ odo catalog list components
    Copy to Clipboard Toggle word wrap

    出力には、利用可能な odo コンポーネントの一覧が表示されます。 

    Odo Devfile Components:
NAME                 DESCRIPTION                            REGISTRY
java-maven           Upstream Maven and OpenJDK 11          DefaultDevfileRegistry
java-openliberty     Open Liberty microservice in Java      DefaultDevfileRegistry
java-quarkus         Upstream Quarkus with Java+GraalVM     DefaultDevfileRegistry
java-springboot      Spring Boot® using Java                DefaultDevfileRegistry
nodejs               Stack with NodeJS 12                   DefaultDevfileRegistry

Odo OpenShift Components:
NAME        PROJECT       TAGS                                                                           SUPPORTED
java        openshift     11,8,latest                                                                    YES
dotnet      openshift     2.1,3.1,latest                                                                 NO
golang      openshift     1.13.4-ubi7,1.13.4-ubi8,latest                                                 NO
httpd       openshift     2.4-el7,2.4-el8,latest                                                         NO
nginx       openshift     1.14-el7,1.14-el8,1.16-el7,1.16-el8,latest                                     NO
nodejs      openshift     10-ubi7,10-ubi8,12-ubi7,12-ubi8,latest                                         NO
perl        openshift     5.26-el7,5.26-ubi8,5.30-el7,latest                                             NO
php         openshift     7.2-ubi7,7.2-ubi8,7.3-ubi7,7.3-ubi8,latest                                     NO
python      openshift     2.7-ubi7,2.7-ubi8,3.6-ubi7,3.6-ubi8,3.8-ubi7,3.8-ubi8,latest                   NO
ruby        openshift     2.5-ubi7,2.5-ubi8,2.6-ubi7,2.6-ubi8,2.7-ubi7,latest                            NO
wildfly     openshift     10.0,10.1,11.0,12.0,13.0,14.0,15.0,16.0,17.0,18.0,19.0,20.0,8.1,9.0,latest     NO
    Copy to Clipboard Toggle word wrap
2.8.3.3. devfile を使用した Java アプリケーションのデプロイ
リンクのコピー

このセクションでは、devfile を使用して Maven および Java 8 JDK を使用するサンプル Java プロジェクトをデプロイする方法を説明します。

手順

  1. コンポーネントのソースコードを保存するディレクトリーを作成します。 

    $ mkdir <directory-name>
    Copy to Clipboard Toggle word wrap

  2. myspring という名前の Spring Boot コンポーネントのコンポーネント設定を作成し、そのサンプルプロジェクトをダウンロードします。 

    $ odo create java-spring-boot myspring --starter
    Copy to Clipboard Toggle word wrap

    直前のコマンドにより、以下の出力が生成されます。 

    Experimental mode is enabled, use at your own risk

Validation
✓  Checking devfile compatibility [195728ns]
✓  Creating a devfile component from registry: DefaultDevfileRegistry [170275ns]
✓  Validating devfile component [281940ns]

Please use `odo push` command to create the component with source deployed
    Copy to Clipboard Toggle word wrap

    odo create コマンドは、記録された devfile レジストリーから関連付けられた devfile.yaml ファイルをダウンロードします。

  3. ディレクトリーの内容を一覧表示し、devfile およびサンプル Java アプリケーションがダウンロードされていることを確認します。 

    $ ls
    Copy to Clipboard Toggle word wrap

    直前のコマンドにより、以下の出力が生成されます。 

    README.md    devfile.yaml    pom.xml        src
    Copy to Clipboard Toggle word wrap

  4. デプロイされたコンポーネントにアクセスするための URL を作成します。 

    $ odo url create --host apps-crc.testing
    Copy to Clipboard Toggle word wrap

    直前のコマンドにより、以下の出力が生成されます。 

    ✓  URL myspring-8080.apps-crc.testing created for component: myspring

To apply the URL configuration changes, please use odo push
    Copy to Clipboard Toggle word wrap
    注記

    URL の作成時にクラスターのホストドメイン名を使用する必要があります。

  5. コンポーネントをクラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap

    直前のコマンドにより、以下の出力が生成されます。 

    Validation
 ✓  Validating the devfile [81808ns]

Creating Kubernetes resources for component myspring
 ✓  Waiting for component to start [5s]

Applying URL changes
 ✓  URL myspring-8080: http://myspring-8080.apps-crc.testing created

Syncing to component myspring
 ✓  Checking files for pushing [2ms]
 ✓  Syncing files to the component [1s]

Executing devfile commands for component myspring
 ✓  Executing devbuild command "/artifacts/bin/build-container-full.sh" [1m]
 ✓  Executing devrun command "/artifacts/bin/start-server.sh" [2s]

Pushing devfile component myspring
 ✓  Changes successfully pushed to component
    Copy to Clipboard Toggle word wrap

  6. コンポーネントの URL を一覧表示し、コンポーネントが正常にプッシュされたことを確認します。 

    $ odo url list
    Copy to Clipboard Toggle word wrap

    直前のコマンドにより、以下の出力が生成されます。 

    Found the following URLs for component myspring
NAME              URL                                       PORT     SECURE
myspring-8080     http://myspring-8080.apps-crc.testing     8080     false
    Copy to Clipboard Toggle word wrap

  7. 生成された URL を使用してデプロイされたアプリケーションを表示します。 

    $ curl http://myspring-8080.apps-crc.testing
    Copy to Clipboard Toggle word wrap

2.8.4. S2I コンポーネントの devfile コンポーネントへの変換
リンクのコピー

odo を使用すると、Source-to-Image (S2I) および devfile コンポーネントの両方を作成できます。既存の S2I コンポーネントがある場合には、odo utils コマンドを使用して devfile コンポーネントに変換できます。

手順

S2I コンポーネントディレクトリーからすべてのコマンドを実行します。

  1. odo utils convert-to-devfile コマンドを実行します。これにより、コンポーネントに基づいて devfile.yaml および env.yaml が作成されます。 

    $ odo utils convert-to-devfile
    Copy to Clipboard Toggle word wrap

  2. コンポーネントをクラスターにプッシュします。 

    $ odo push
    Copy to Clipboard Toggle word wrap
    注記

    devfile コンポーネントのデプロイメントに失敗した場合は、odo delete -a を実行してこれを削除します。

  3. devfile コンポーネントが正常にデプロイされたことを確認します。 

    $ odo list
    Copy to Clipboard Toggle word wrap

  4. S2I コンポーネントを削除します。 

    $ odo delete --s2i
    Copy to Clipboard Toggle word wrap

2.9. サンプルアプリケーションの使用
リンクのコピー

odo は、OpenShift カタログのコンポーネントタイプ内の言語またはランタイムとの部分的な互換性を提供します。以下は例になります。 

NAME        PROJECT       TAGS
dotnet      openshift     2.0,latest
httpd       openshift     2.4,latest
java        openshift     8,latest
nginx       openshift     1.10,1.12,1.8,latest
nodejs      openshift     0.10,4,6,8,latest
perl        openshift     5.16,5.20,5.24,latest
php         openshift     5.5,5.6,7.0,7.1,latest
python      openshift     2.7,3.3,3.4,3.5,3.6,latest
ruby        openshift     2.0,2.2,2.3,2.4,latest
wildfly     openshift     10.0,10.1,8.1,9.0,latest
Copy to Clipboard Toggle word wrap
注記

odo については、Java および Node.js は正式にサポートされているコンポーネントタイプです。odo catalog list components を実行して、正式にサポートされているコンポーネントタイプを確認します。

Web 経由でコンポーネントにアクセスするには、 odo url create を使用して URL を作成します。

2.9.1. Git リポジトリーの例
リンクのコピー

2.9.1.1. httpd
リンクのコピー

この例は、CentOS 7 で httpd を使用して静的コンテンツをビルドし、提供するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージの使用方法についての詳細は、Apache HTTP Server container image repository を参照してください。 

$ odo create httpd --git https://github.com/openshift/httpd-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.2. java
リンクのコピー

この例は、CentOS 7 で Fat JAR Java アプリケーションをビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Java S2I Builder image を参照してください。 

$ odo create java --git https://github.com/spring-projects/spring-petclinic.git
Copy to Clipboard Toggle word wrap
2.9.1.3. nodejs
リンクのコピー

CentOS 7 で Node.js アプリケーションをビルドし、実行します。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Node.js 8 container image を参照してください。 

$ odo create nodejs --git https://github.com/openshift/nodejs-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.4. perl
リンクのコピー

この例は、CentOS 7 で Perl アプリケーションのビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Perl 5.26 container image を参照してください。 

$ odo create perl --git https://github.com/openshift/dancer-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.5. php
リンクのコピー

この例は、CentOS 7 で PHP アプリケーションのビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、PHP 7.1 Docker image を参照してください。 

$ odo create php --git https://github.com/openshift/cakephp-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.6. python
リンクのコピー

この例は、CentOS 7 で Python アプリケーションをビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Python 3.6 container image を参照してください。 

$ odo create python --git https://github.com/openshift/django-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.7. ruby
リンクのコピー

この例は、CentOS 7 で Ruby アプリケーションをビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Ruby 2.5 container image を参照してください。 

$ odo create ruby --git https://github.com/openshift/ruby-ex.git
Copy to Clipboard Toggle word wrap
2.9.1.8. wildfly
リンクのコピー

この例は、CentOS 7 で WildFly アプリケーションをビルドし、実行するのに役立ちます。OpenShift Container Platform の考慮点を含む、このビルダーイメージを使用する方法についての詳細は、Wildfly - CentOS Docker images for OpenShift を参照してください。 

$ odo create wildfly --git https://github.com/openshift/openshift-jee-sample.git
Copy to Clipboard Toggle word wrap

2.9.2. バイナリーのサンプル
リンクのコピー

2.9.2.1. java
リンクのコピー

Java を使用すると、以下のようにバイナリーアーティファクトをデプロイすることができます。 

$ git clone https://github.com/spring-projects/spring-petclinic.git
$ cd spring-petclinic
$ mvn package
$ odo create java test3 --binary target/*.jar
$ odo push
Copy to Clipboard Toggle word wrap
2.9.2.2. wildfly
リンクのコピー

WildFly を使用すると、以下のようにバイナリーアプリケーションをデプロイすることができます。 

$ git clone https://github.com/openshiftdemos/os-sample-java-web.git
$ cd os-sample-java-web
$ mvn package
$ cd ..
$ mkdir example && cd example
$ mv ../os-sample-java-web/target/ROOT.war example.war
$ odo create wildfly --binary example.war
Copy to Clipboard Toggle word wrap

2.10. Operator によって管理されるサービスのインスタンスの作成
リンクのコピー

重要

'odo' で Operator によって管理されるサービスのインスタンスの作成は、テクノロジープレビュー機能としてのみご利用いただけます。テクノロジープレビュー機能は Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲についての詳細は、https://access.redhat.com/ja/support/offerings/techpreview/ を参照してください。

Operator は、Kubernetes サービスをパッケージ化し、デプロイし、管理する方法です。odo を使用して、Operator によって提供されるカスタムリソース定義 (CRD) からサービスのインスタンスを作成できます。その後、プロジェクトでこれらのインスタンスを使用し、それらをコンポーネントにリンクできます。

Operator からサービスを作成するには、要求されたサービスを起動するために必要な有効な値が Operator の metadata に定義されていることを確認する必要があります。odo は Operator の metadata.annotations.alm-examples YAML ファイルを使用してサービスを起動します。この YAML にプレースホルダーの値またはサンプルの値がある場合、サービスは起動できません。YAML ファイルを変更し、変更した値でサービスを起動することができます。YAML ファイルを変更する方法およびそのファイルからサービスを起動する方法については、Creating services from YAML files を参照してください。

2.10.1. 前提条件
リンクのコピー

  • oc CLI をインストールし、クラスターにログインします。

    • クラスターの設定により利用できるサービスが異なることに注意してください。Operator サービスにアクセスするには、クラスター管理者はまずクララスターにそれぞれの Operator をインストールする必要があります。詳細は、Adding Operators to the cluster を参照してください。
  • odo CLI をインストールします。
  • 実験モードを有効にします。odo で実験モードを有効にするには、 odo preference set Experimental true を実行するか、または環境変数 odo config set --env ODO_EXPERIMENTAL=true を使用します。

2.10.2. プロジェクトの作成
リンクのコピー

プロジェクトを作成し、別個の単一の単位で編成されるソースコード、テスト、ライブラリーを維持します。

手順

  1. OpenShift Container Platform クラスターにログインします。 

    $ odo login -u developer -p developer
    Copy to Clipboard Toggle word wrap

  2. プロジェクトを作成します。 

    $ odo project create myproject
    Copy to Clipboard Toggle word wrap

    出力例

     ✓  Project 'myproject' is ready for use
 ✓  New project created and now using project : myproject
    Copy to Clipboard Toggle word wrap

2.10.3. クラスターにインストールされている Operator からの利用可能なサービスの一覧表示
リンクのコピー

odo を使用して、クラスターにインストールされている Operator およびそれらが提供するサービスの一覧を表示できます。

  • 現在のプロジェクトにインストールされている Operator を一覧表示するには、以下を実行します。 

    $ odo catalog list services
    Copy to Clipboard Toggle word wrap

    コマンドは Operator および CRD を一覧表示します。コマンドの出力には、クラスターにインストールされている Operator が表示されます。以下は例になります。 

    Operators available in the cluster
NAME                          CRDs
etcdoperator.v0.9.4           EtcdCluster, EtcdBackup, EtcdRestore
mongodb-enterprise.v1.4.5     MongoDB, MongoDBUser, MongoDBOpsManager
    Copy to Clipboard Toggle word wrap

    etcdoperator.v0.9.4 は Operator であり、 EtcdCluster、EtcdBackup および EtcdRestore は Operator によって提供される CRD です。

2.10.4. Operator からのサービスの作成
リンクのコピー

要求されたサービスを起動するために必要な有効な値が Operator の metadata に定義されている場合、odo service create でサービスを使用できます。

  1. サービスの YAML をローカルドライブのファイルとして出力します。 

    $ oc get csv/etcdoperator.v0.9.4 -o yaml
    Copy to Clipboard Toggle word wrap

  2. サービスの値が有効であることを確認します。 

    apiVersion: etcd.database.coreos.com/v1beta2
kind: EtcdCluster
metadata:
  name: example
spec:
  size: 3
  version: 3.2.13
    Copy to Clipboard Toggle word wrap

  3. EtcdCluster サービスを etcdoperator.v0.9.4 Operator から起動します。 

    $ odo service create etcdoperator.v0.9.4 EtcdCluster
    Copy to Clipboard Toggle word wrap

  4. サービスが起動していることを確認します。 

    $ oc get EtcdCluster
    Copy to Clipboard Toggle word wrap

2.10.5. YAML ファイルからのサービスの作成
リンクのコピー

サービスまたはカスタムリソース (CR) の YAML 定義に無効なデータまたはプレースホルダーのデータがある場合、--dry-run フラグを使用して YAML 定義を取得し、正しい値を指定し、修正された YAML 定義を使用してサービスを起動することができます。サービスを起動するために使用される YAML を出力および変更するために、odo はサービスの起動前に Operator によって提供されるサービスまたは CR の YAML 定義を出力する機能を提供します。

  1. サービスの YAML を表示するには、以下を実行します。 

    $ odo service create <operator-name> --dry-run
    Copy to Clipboard Toggle word wrap

    たとえば、etcdoperator.v0.9.4 Operator によって提供される EtcdCluster の YAML 定義を出力するには、以下を実行します。 

    $ odo service create etcdoperator.v0.9.4 --dry-run
    Copy to Clipboard Toggle word wrap

    YAML は etcd.yaml ファイルとして保存されます。

  2. etcd.yaml ファイルを変更します。 

    apiVersion: etcd.database.coreos.com/v1beta2
kind: EtcdCluster
metadata:
  name: my-etcd-cluster
    1 
    
spec:
  size: 1
    2 
    
  version: 3.2.13
    Copy to Clipboard Toggle word wrap
    1
    名前を example から my-etcd-cluster に変更します。
    2
    サイズを 3 から 1 に縮小します。

  3. YAML ファイルからサービスを起動します。 

    $ odo service create --from-file etcd.yaml
    Copy to Clipboard Toggle word wrap

  4. EtcdCluster サービスが事前に設定された 3 つの Pod ではなく 1 つの Pod で起動されていることを確認します。 

    $ oc get pods | grep my-etcd-cluster
    Copy to Clipboard Toggle word wrap

2.11. odo でのアプリケーションのデバッグ
リンクのコピー

odo を使用すると、デバッガーを割り当て、アプリケーションをリモートでデバッグできます。この機能は NodeJS および Java コンポーネントでのみサポートされます。

odo で作成されたコンポーネントは、デフォルトでデバッグモードで実行されます。デバッガーのエージェントは、特定のポートでコンポーネントに対して実行されます。アプリケーションのデバッグを開始するには、ポート転送を開始して、統合開発環境 (IDE) にバンドルされたローカルのデバッガーを割り当てる必要があります。

2.11.1. アプリケーションのデバッグ
リンクのコピー

odo debug コマンドを使用して、odo でアプリケーションをデバッグできます。

手順

  1. アプリケーションがデプロイされた後に、コンポーネントのポート転送を開始して、アプリケーションのデバッグを行います。 

    $ odo debug port-forward
    Copy to Clipboard Toggle word wrap
  2. IDE にバンドルされたデバッガーをコンポーネントに割り当てます。手順は、IDE によって異なります。

2.11.2. デバッグパラメーターの設定
リンクのコピー

odo config コマンドでリモートポートを指定し、odo debug コマンドでローカルポートを指定できます。

手順

  • デバッグエージェントを実行するリモートポートを設定するには、以下を実行します。 

    $ odo config set DebugPort 9292
    Copy to Clipboard Toggle word wrap
    注記

    この値のコンポーネントをコンポーネントに反映させるには、コンポーネントを再デプロイする必要があります。

  • ローカルポートをポート転送に設定するには、以下を実行します。 

    $ odo debug port-forward --local-port 9292
    Copy to Clipboard Toggle word wrap
    注記

    ローカルポートの値は永続化されません。ポートを変更する必要がある場合は毎回これを指定する必要があります。

2.12. 環境変数の管理
リンクのコピー

odo はコンポーネント固有の設定および環境変数を config ファイルに保存します。odo config コマンドを使用すると、config ファイルを変更せずに、コンポーネントの環境変数の設定、設定解除、および一覧表示を実行できます。

2.12.1. 環境変数の設定および設定解除
リンクのコピー

手順

  • コンポーネントで環境変数を設定するには、以下を実行します。 

    $ odo config set --env <variable>=<value>
    Copy to Clipboard Toggle word wrap

  • コンポーネントの環境変数の設定を解除するには、以下を実行します。 

    $ odo config unset --env <variable>
    Copy to Clipboard Toggle word wrap

  • コンポーネント内のすべての環境変数を一覧表示するには、以下を実行します。 

    $ odo config view
    Copy to Clipboard Toggle word wrap

2.13. odo CLI の設定
リンクのコピー

2.13.1. コマンド補完の使用
リンクのコピー

注記

現時点で、コマンドの補完は bash、zsh、および fish シェルでのみサポートされています。

odo は、ユーザー入力に基づくコマンドパラメーターのスマート補完を提供します。これを機能させるには、odo は実行中のシェルと統合する必要があります。

手順

  • コマンド補完を自動的にインストールするには、以下を実行します。

    1. 以下を実行します。 

      $ odo --complete
      Copy to Clipboard Toggle word wrap
    2. 補完フックのインストールを求めるプロンプトが出されたら、y を押します。
  • 補完フックを手動でインストールするには、complete -o nospace -C <full_path_to_your_odo_binary> odo をシェル設定ファイルに追加します。シェル設定ファイルを変更したら、シェルを再起動します。

  • 補完を無効にするには、以下を実行します。

    1. 以下を実行します。 

      $ odo --uncomplete
      Copy to Clipboard Toggle word wrap
    2. 補完フックをアンインストールするようプロンプトされたら y を押します。
注記

odo 実行可能ファイルの名前を変更した場合や、これを別のディレクトリーに移動する場合、コマンド補完を再度有効にします。

2.13.2. ファイルまたはパターンを無視する
リンクのコピー

アプリケーションのルートディレクトリーにある .odoignore ファイルを変更して、無視するファイルまたはパターンの一覧を設定できます。これは、odo push および odo watch の両方に適用されます。

.odoignore ファイルが存在 しない 場合、特定のファイルおよびフォルダーを無視するように .gitignore ファイルが代わりに使用されます。

.git ファイル、.js 拡張子のあるファイルおよびフォルダー tests を無視するには、以下を .odoignore または .gitignore ファイルのいずれかに追加します。 

.git
*.js
tests/
Copy to Clipboard Toggle word wrap

.odoignore ファイルはすべての glob 表現を許可します。

2.14. odo CLI リファレンス
リンクのコピー

2.14.1. 基本的な odo CLI コマンド
リンクのコピー

2.14.1.1. app
リンクのコピー

OpenShift Container Platform プロジェクトに関連するアプリケーション操作を実行します。

app の使用例

  # Delete the application
  odo app delete myapp

  # Describe 'webapp' application,
  odo app describe webapp

  # List all applications in the current project
  odo app list

  # List all applications in the specified project
  odo app list --project myproject
Copy to Clipboard Toggle word wrap

2.14.1.2. catalog
リンクのコピー

カタログ関連の操作を実行します。

catalog の使用例

  # Get the supported components
  odo catalog list components

  # Get the supported services from service catalog
  odo catalog list services

  # Search for a component
  odo catalog search component python

  # Search for a service
  odo catalog search service mysql

  # Describe a service
  odo catalog describe service mysql-persistent
Copy to Clipboard Toggle word wrap

2.14.1.3. component
リンクのコピー

アプリケーションのコンポーネントを管理します。

component の使用例

# Create a new component
odo component create

# Create a local configuration and create all objects on the cluster
odo component create --now
Copy to Clipboard Toggle word wrap

2.14.1.4. config
リンクのコピー

config ファイル内で odo 固有の設定を変更します。

config の使用例

  # For viewing the current local configuration
  odo config view

  # Set a configuration value in the local configuration
  odo config set Type java
  odo config set Name test
  odo config set MinMemory 50M
  odo config set MaxMemory 500M
  odo config set Memory 250M
  odo config set Ignore false
  odo config set MinCPU 0.5
  odo config set MaxCPU 2
  odo config set CPU 1

  # Set an environment variable in the local configuration
  odo config set --env KAFKA_HOST=kafka --env KAFKA_PORT=6639

  # Create a local configuration and apply the changes to the cluster immediately
  odo config set --now

  # Unset a configuration value in the local config
  odo config unset Type
  odo config unset Name
  odo config unset MinMemory
  odo config unset MaxMemory
  odo config unset Memory
  odo config unset Ignore
  odo config unset MinCPU
  odo config unset MaxCPU
  odo config unset CPU

  # Unset an env variable in the local config
  odo config unset --env KAFKA_HOST --env KAFKA_PORT
Copy to Clipboard Toggle word wrap

Expand

アプリケーション

Application は、コンポーネントを含める必要のあるアプリケーションの名前になります。

CPU

コンポーネントが使用できる CPU の最小数と最大数

Ignore

プッシュと監視に関連して .odoignore ファイルを考慮します。

Expand
表2.2 利用可能なローカルパラメーター:

アプリケーション

コンポーネントを含める必要のあるアプリケーションの名前

CPU

コンポーネントが使用できる CPU の最小数と最大数

Ignore

プッシュおよび監視に関連して .odoignore ファイルを考慮するかどうか

MaxCPU

コンポーネントで使用可能な最大 CPU

MaxMemory

コンポーネントで使用可能な最大メモリー

Memory

コンポーネントで使用できる最小および最大メモリー

MinCPU

コンポーネントで使用できる最小 CPU

MinMemory

コンポーネントに指定される最小メモリー

Name

コンポーネントの名前

Ports

コンポーネントで開くポート

Project

コンポーネントを含めるプロジェクトの名前

Ref

git ソースからコンポーネントを作成するために使用する Git ref

SourceLocation

パスはバイナリーファイルまたは git ソースの場所を示します。

SourceType

コンポーネントソースのタイプ: git/binary/local

Storage

コンポーネントのストレージ

Type

コンポーネントのタイプ

Url

コンポーネントにアクセスするために使用する URL

2.14.1.5. create
リンクのコピー

OpenShift Container Platform にデプロイするコンポーネントを記述する設定を作成します。コンポーネント名が指定されていない場合、これは自動的に生成されます。

デフォルトで、ビルダーイメージは現在の namespace から使用されます。namespace を明示的に指定するには、odo create namespace/name:version を使用します。バージョンが指定されていない場合、デフォルトは latest に設定されます。

odo catalog list を使用してデプロイできるコンポーネントタイプの詳細一覧を表示します。

create の使用例

  # Create new Node.js component with the source in current directory.
  odo create nodejs

  # Create new Node.js component and push it to the cluster immediately.
  odo create nodejs --now

  # A specific image version may also be specified
  odo create nodejs:latest

  # Create new Node.js component named 'frontend' with the source in './frontend' directory
  odo create nodejs frontend --context ./frontend

  # Create a new Node.js component of version 6 from the 'openshift' namespace
  odo create openshift/nodejs:6 --context /nodejs-ex

  # Create new Wildfly component with binary named sample.war in './downloads' directory
  odo create wildfly wildfly --binary ./downloads/sample.war

  # Create new Node.js component with source from remote git repository
  odo create nodejs --git https://github.com/openshift/nodejs-ex.git

  # Create new Node.js git component while specifying a branch, tag or commit ref
  odo create nodejs --git https://github.com/openshift/nodejs-ex.git --ref master

  # Create new Node.js git component while specifying a tag
  odo create nodejs --git https://github.com/openshift/nodejs-ex.git --ref v1.0.1

  # Create new Node.js component with the source in current directory and ports 8080-tcp,8100-tcp and 9100-udp exposed
  odo create nodejs --port 8080,8100/tcp,9100/udp

  # Create new Node.js component with the source in current directory and env variables key=value and key1=value1 exposed
  odo create nodejs --env key=value,key1=value1

  # Create a new Python component with the source in a Git repository
  odo create python --git https://github.com/openshift/django-ex.git

  # Passing memory limits
  odo create nodejs --memory 150Mi
  odo create nodejs --min-memory 150Mi --max-memory 300 Mi

  # Passing cpu limits
  odo create nodejs --cpu 2
  odo create nodejs --min-cpu 200m --max-cpu 2
Copy to Clipboard Toggle word wrap

2.14.1.6. debug
リンクのコピー

コンポーネントをデバッグします。

debug の使用例

# Displaying information about the state of debugging
odo debug info

# Starting the port forwarding for a component to debug the application
odo debug port-forward

# Setting a local port to port forward
odo debug port-forward --local-port 9292
Copy to Clipboard Toggle word wrap

2.14.1.7. delete
リンクのコピー

既存のコンポーネントを削除します。

delete の使用例

  # Delete component named 'frontend'.
  odo delete frontend
  odo delete frontend --all-apps
Copy to Clipboard Toggle word wrap

2.14.1.8. describe
リンクのコピー

指定のコンポーネントについて説明します。

describe の使用例

  # Describe nodejs component
  odo describe nodejs
Copy to Clipboard Toggle word wrap

2.14.1.9. link
リンクのコピー

サービスまたはコンポーネントにコンポーネントをリンクします。

link の使用例

  # Link the current component to the 'my-postgresql' service
  odo link my-postgresql

  # Link component 'nodejs' to the 'my-postgresql' service
  odo link my-postgresql --component nodejs

  # Link current component to the 'backend' component (backend must have a single exposed port)
  odo link backend

  # Link component 'nodejs' to the 'backend' component
  odo link backend --component nodejs

  # Link current component to port 8080 of the 'backend' component (backend must have port 8080 exposed)
  odo link backend --port 8080
Copy to Clipboard Toggle word wrap

リンクにより、適切なシークレットがソースコンポーネントの環境に追加されます。ソースコンポーネントは、シークレットのエントリーを環境変数として使用できます。ソースコンポーネントが指定されない場合、現在のアクティブなコンポーネントが使用されます。

2.14.1.10. list
リンクのコピー

現在のアプリケーションのすべてのコンポーネントとコンポーネントの状態を一覧表示します。

コンポーネントの状態

Pushed
コンポーネントはクラスターにプッシュされています。
Not Pushed
コンポーネントはクラスターにプッシュされていません。
Unknown
odo はクラスターから切断されます。

list の使用例

  # List all components in the application
  odo list

  # List all the components in a given path
  odo list --path <path_to_your_component>
Copy to Clipboard Toggle word wrap

2.14.1.11. log
リンクのコピー

指定のコンポーネントのログを取得します。

log の使用例

  # Get the logs for the nodejs component
  odo log nodejs
Copy to Clipboard Toggle word wrap

2.14.1.12. login
リンクのコピー

クラスターにログインします。

login の使用例

  # Log in interactively
  odo login

  # Log in to the given server with the given certificate authority file
  odo login localhost:8443 --certificate-authority=/path/to/cert.crt

  # Log in to the given server with the given credentials (basic auth)
  odo login localhost:8443 --username=myuser --password=mypass

  # Log in to the given server with the given credentials (token)
  odo login localhost:8443 --token=xxxxxxxxxxxxxxxxxxxxxxx
Copy to Clipboard Toggle word wrap

2.14.1.13. logout
リンクのコピー

現在の OpenShift Container Platform セッションからログアウトします。

logout の使用例

  # Log out
  odo logout
Copy to Clipboard Toggle word wrap

2.14.1.14. preference
リンクのコピー

グローバル設定ファイル内の odo 固有の設定内容を変更します。

preference の使用例

  # For viewing the current preferences
  odo preference view

  # Set a preference value in the global preference
  odo preference set UpdateNotification false
  odo preference set NamePrefix "app"
  odo preference set Timeout 20

  # Enable experimental mode
  odo preference set experimental true

  # Unset a preference value in the global preference
  odo preference unset  UpdateNotification
  odo preference unset  NamePrefix
  odo preference unset  Timeout

  # Disable experimental mode
  odo preference set experimental false
Copy to Clipboard Toggle word wrap

注記

デフォルトで、グローバル設定ファイルへのパスは ~/.odo/preferece.yaml であり、これは環境変数 GLOBALODOCONFIG に保存されます。環境変数の値を新規の設定パスに設定し、カスタムパスをセットアップできます (例: GLOBALODOCONFIG="new_path/preference.yaml")。

Expand
表2.3 利用可能なパラメーター:

NamePrefix

デフォルトの接頭辞は、現在のディレクトリー名です。この値を使用して、デフォルトの名前の接頭辞を設定します。

Timeout

OpenShift Container Platform サーバー接続チェックのタイムアウト (秒単位) です。

UpdateNotification

更新通知が表示されるかどうかを制御します。

2.14.1.15. project
リンクのコピー

プロジェクト操作を実行します。

project の使用例

  # Set the active project
  odo project set

  # Create a new project
  odo project create myproject

  # List all the projects
  odo project list

  # Delete a project
  odo project delete myproject

  # Get the active project
  odo project get
Copy to Clipboard Toggle word wrap

2.14.1.16. push
リンクのコピー

ソースコードをコンポーネントにプッシュします。

push の使用例

  # Push source code to the current component
  odo push

  # Push data to the current component from the original source.
  odo push

  # Push source code in ~/mycode to component called my-component
  odo push my-component --context ~/mycode

  # Push source code and display event notifications in JSON format.
  odo push -o json
Copy to Clipboard Toggle word wrap

2.14.1.17. registry
リンクのコピー

カスタムレジストリーを作成し、変更します。

registry の使用例

# Add a registry to the registry list
odo registry add <registry name> <registry URL>

# List a registry in the registry list
odo registry list

# Delete a registry from the registry list
odo registry delete <registry name>

# Update a registry in the registry list
odo registry update <registry name> <registry URL>

# List a component with a corresponding registry
odo catalog list components

# Create a component that is hosted by a specific registry
odo create <component type> --registry <registry name>
Copy to Clipboard Toggle word wrap

2.14.1.18. service
リンクのコピー

サービスカタログ操作を実行します。

service の使用例

  # Create new postgresql service from service catalog using dev plan and name my-postgresql-db.
  odo service create dh-postgresql-apb my-postgresql-db --plan dev -p postgresql_user=luke -p postgresql_password=secret

  # Delete the service named 'mysql-persistent'
  odo service delete mysql-persistent

  # List all services in the application
  odo service list
Copy to Clipboard Toggle word wrap

2.14.1.19. storage
リンクのコピー

ストレージ操作を実行します。

storage の使用例

  # Create storage of size 1Gb to a component
  odo storage create mystorage --path=/opt/app-root/src/storage/ --size=1Gi

  # Delete storage mystorage from the currently active component
  odo storage delete mystorage

  # List all storage attached or mounted to the current component and
  # all unattached or unmounted storage in the current application
  odo storage list

  # Set the `-o json` flag to get a JSON formatted output
  odo storage list -o json
Copy to Clipboard Toggle word wrap

2.14.1.20. unlink
リンクのコピー

コンポーネントまたはサービスのリンクを解除します。

このコマンドが正常に実行されるには、サービスまたはコンポーネントが呼び出し前に odo link を使用してリンクされている必要があります。

unlink の使用例

  # Unlink the 'my-postgresql' service from the current component
  odo unlink my-postgresql

  # Unlink the 'my-postgresql' service  from the 'nodejs' component
  odo unlink my-postgresql --component nodejs

  # Unlink the 'backend' component from the current component (backend must have a single exposed port)
  odo unlink backend

  # Unlink the 'backend' service  from the 'nodejs' component
  odo unlink backend --component nodejs

  # Unlink the backend's 8080 port from the current component
  odo unlink backend --port 8080
Copy to Clipboard Toggle word wrap

2.14.1.21. update
リンクのコピー

コンポーネントのソースコードパスを更新します。

update の使用例

  # Change the source code path of a currently active component to local (use the current directory as a source)
  odo update --local

  # Change the source code path of the frontend component to local with source in ./frontend directory
  odo update frontend --local ./frontend

  # Change the source code path of a currently active component to git
  odo update --git https://github.com/openshift/nodejs-ex.git

  # Change the source code path of the component named node-ex to git
  odo update node-ex --git https://github.com/openshift/nodejs-ex.git

  # Change the source code path of the component named wildfly to a binary named sample.war in ./downloads directory
  odo update wildfly --binary ./downloads/sample.war
Copy to Clipboard Toggle word wrap

2.14.1.22. url
リンクのコピー

コンポーネントを外部に公開します。

url の使用例

  # Create a URL for the current component with a specific port
  odo url create --port 8080

  # Create a URL with a specific name and port
  odo url create example --port 8080

  # Create a URL with a specific name by automatic detection of port (only for components which expose only one service port)
  odo url create example

  # Create a URL with a specific name and port for component frontend
  odo url create example --port 8080 --component frontend

  # Delete a URL to a component
  odo url delete myurl

  # List the available URLs
  odo url list

  # Create a URL in the configuration and apply the changes to the cluster
  odo url create --now

  # Create an HTTPS URL
  odo url create --secure
Copy to Clipboard Toggle word wrap

このコマンドを使用して生成される URL は、クラスター外からデプロイされたコンポーネントにアクセスするために使用できます。

2.14.1.23. utils
リンクのコピー

ターミナルコマンドのユーティリティーおよび odo 設定の変更

utils の使用例

  # Bash terminal PS1 support
  source <(odo utils terminal bash)

  # Zsh terminal PS1 support
  source <(odo utils terminal zsh)
Copy to Clipboard Toggle word wrap

2.14.1.24. version
リンクのコピー

クライアントバージョンの情報を出力します。

version の使用例

  # Print the client version of odo
  odo version
Copy to Clipboard Toggle word wrap

2.14.1.25. watch
リンクのコピー

odo は変更の有無の監視を開始し、変更時にコンポーネントを自動的に更新します。

watch の使用例

  # Watch for changes in directory for current component
  odo watch

  # Watch for changes in directory for component called frontend
  odo watch frontend
Copy to Clipboard Toggle word wrap

2.15. odo リリースノート
リンクのコピー

2.15.1. odo での主な変更点および改善点
リンクのコピー

  • --devfile フラグが odo create に追加されます。odo create <component name> --devfile <devfile path> を実行し、devfile の場所を指定します。このフラグは実験モードでのみ利用可能です。有効にする方法については、テクノロジープレビュー機能 を参照してください。

  • 動的レジストリーのサポート。これで、以下のコマンドで独自のレジストリーを設定できます。 

    # Add a registry to the registry list
odo registry add <registry name> <registry URL>

# List a registry in the registry list
odo registry list

# Delete a registry from the registry list
odo registry delete <registry name>

# Update a registry in the registry list
odo registry update <registry name> <registry URL>

# List a component with a corresponding registry
odo catalog list components

# Create a component that is hosted by a specific registry
odo create <component type> --registry <registry name>
    Copy to Clipboard Toggle word wrap
  • --starter フラグが odo create に追加されます。odo create nodejs --starter <project-name> を実行して、devfile に指定されるプロジェクトのソースコードをダウンロードします。プロジェクト名が指定されていない場合、odo は最初のプロジェクトをダウンロードします。
  • --context フラグが odo push に追加されます。--context を使用すると、ソースコードディレクトリーから odo push をトリガーできます。odo push --devfile <path to the devfile> --context <directory with your component> を実行してコンポーネントのディレクトリーを指定します。
  • devfile を使用する場合の odo catalog list components のパフォーマンスが向上しました。
  • devfile の使用時に、--now フラグが odo url delete に追加されます。
  • odo url delete --now が devfile で機能するようになりました。
  • --debug フラグが devfile で機能するようになりました。
  • Operator がサポートするサービスの一覧を表示するための機械読み取り可能出力が追加されました。odo catalog list services -o json を実行して、JSON 形式で Operator およびサービスについての情報を表示します。
  • デバッグ用の機械読み取り可能出力が追加されました。odo debug info -o json を実行して JSON 形式のデバッグ情報を表示します。
  • odo push の機械読み取り可能出力が追加されました。odo push -o json を実行して JSON 形式のイベント通知を表示します。

2.15.2. サポート
リンクのコピー

ドキュメント

ドキュメントのエラーが見つかったか、またはドキュメントの改善に関する提案をお寄せいただける場合は、Bugzilla に報告してください。OpenShift Container Platform の製品タイプおよび Documentation コンポーネントタイプを選択します。

製品

エラーを見つけた場合や、odo の機能に関するバグが見つかった場合やこれに関する改善案をお寄せいただける場合は、Bugzilla に報告してください。製品タイプとして Red Hat odo for OpenShift Container Platform を選択します。

問題の詳細情報をできる限り多く入力します。

2.15.3. 既知の問題
リンクのコピー

  • Bug 1760574: 削除された namespace が odo project get コマンドで一覧表示されます。
  • Bug 1760586: odo delete コマンドは、プロジェクトが削除され、コンポーネント名が設定されると無限ループを開始します。
  • Bug 1760588: odo service create コマンドは Cygwin で実行されるとクラッシュします。
  • Bug 1760590: Windows 用の Git BASH では、odo login -u developer は要求された場合も入力されたパスワードを非表示にしません。
  • Bug 1783188: 非接続クラスターでは、odo component create コマンドは、コンポーネントがカタログ一覧に一覧表示されていてもエラーの …​tag not found…​ を出力します。
  • Bug 1761440: 1 つのオブジェクトに同じタイプの 2 つのサービスを作成することができません。

  • Bug 1821643 odo push は .NET コンポーネントタグ 2.1+ では機能しません。

    回避策: 以下を実行して .NET プロジェクトファイルを指定します。 

    $ odo config set --env DOTNET_STARTUP_PROJECT=<path to your project file>
    Copy to Clipboard Toggle word wrap

2.15.4. テクノロジープレビューの機能: odo
リンクのコピー

  • odo debug は、ユーザーが Pod で実行されているコンポーネントにローカルデバッガーを割り当てることを可能にする機能です。詳細は、odo でのアプリケーションのデバッグ を参照してください。
重要

odo debug は現時点ではテクノロジープレビュー機能です。テクノロジープレビュー機能は Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲についての詳細は、https://access.redhat.com/ja/support/offerings/techpreview/ を参照してください。

  • devfile のサポート。odo で、devfile を使用してアプリケーションを作成し、デプロイできます。詳細は、devfile を使用したアプリケーションの作成 を参照してください。この機能にアクセスするには、odo preference set experimental true で実験モードを有効にする必要があります。

    現在サポートされている devfile コンポーネントの一覧を表示するには、odo catalog list components を実行します。

重要

Devfile のサポートはテクノロジープレビュー機能でのみ利用可能です。テクノロジープレビュー機能は Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲についての詳細は、https://access.redhat.com/ja/support/offerings/techpreview/ を参照してください。

重要

Operator のサポートはテクノロジープレビュー機能でのみ利用可能です。テクノロジープレビュー機能は Red Hat の実稼働環境でのサービスレベルアグリーメント (SLA) ではサポートされていないため、Red Hat では実稼働環境での使用を推奨していません。Red Hat は実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲についての詳細は、https://access.redhat.com/ja/support/offerings/techpreview/ を参照してください。

第3章 Helm CLI
リンクのコピー

3.1. OpenShift Container Platform での Helm 3 の使用開始
リンクのコピー

3.1.1. Helm について
リンクのコピー

Helm は、アプリケーションやサービスの OpenShift Container Platform クラスターへのデプロイメントを単純化するソフトウェアパッケージマネージャーです。

Helm は charts というパッケージ形式を使用します。Helm チャートは、OpenShift Container Platform リソースを記述するファイルのコレクションです。

クラスター内のチャートの実行中のインスタンスは、リリース と呼ばれます。チャートがクラスターにインストールされているたびに、新規のリリースが作成されます。

チャートのインストール時、またはリリースがアップグレードまたはロールバックされるたびに、増分リビジョンが作成されます。

3.1.1.1. 主な特長
リンクのコピー

Helm は以下を行う機能を提供します。

  • チャートリポジトリーに保存したチャートの大規模なコレクションの検索。
  • 既存のチャートの変更。
  • OpenShift Container Platform または Kubernetes リソースの使用による独自のチャートの作成。
  • アプリケーションのチャートとしてのパッケージ化および共有。

3.1.2. Helm のインストール
リンクのコピー

以下のセクションでは、CLI を使用して各種の異なるプラットフォームに Helm をインストールする方法を説明します。

また、OpenShift Container Platform Web コンソールから最新のバイナリーへの URL を見つけるには、右上隅の ? アイコンをクリックし、Command Line Tools を選択します。

前提条件

  • Go バージョン 1.13 以降がインストールされている。
3.1.2.1. Linux の場合
リンクのコピー

  1. Helm バイナリーをダウンロードし、これをパスに追加します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-amd64 -o /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  2. バイナリーファイルを実行可能にします。 

    # chmod +x /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  3. インストールされたバージョンを確認します。 

    $ helm version
    Copy to Clipboard Toggle word wrap

    出力例

    version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}
    Copy to Clipboard Toggle word wrap

3.1.2.2. Windows 7/8 の場合
リンクのコピー
  1. 最新の .exe ファイル をダウンロードし、希望のディレクトリーに配置します。
  2. Start を右クリックし、Control Panel をクリックします。
  3. System and Security を選択してから System をクリックします。
  4. 左側のメニューから、Advanced systems settings を選択し、下部にある Environment Variables をクリックします。
  5. Variable セクションから Path を選択し、Edit をクリックします。
  6. New をクリックして、 .exe ファイルのあるフォルダーへのパスをフィールドに入力するか、または Browse をクリックし、ディレクトリーを選択して OK をクリックします。
3.1.2.3. Windows 10 の場合
リンクのコピー
  1. 最新の .exe ファイル をダウンロードし、希望のディレクトリーに配置します。
  2. Search クリックして、env または environment を入力します。
  3. Edit environment variables for your account を選択します。
  4. Variable セクションから Path を選択し、Edit をクリックします。
  5. New をクリックし、exe ファイルのあるディレクトリーへのパスをフィールドに入力するか、または Browse をクリックし、ディレクトリーを選択して OK をクリックします。
3.1.2.4. MacOS の場合
リンクのコピー

  1. Helm バイナリーをダウンロードし、これをパスに追加します。 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-darwin-amd64 -o /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  2. バイナリーファイルを実行可能にします。 

    # chmod +x /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  3. インストールされたバージョンを確認します。 

    $ helm version
    Copy to Clipboard Toggle word wrap

    出力例

    version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}
    Copy to Clipboard Toggle word wrap

3.1.3. OpenShift Container Platform クラスターでの Helm チャートのインストール
リンクのコピー

前提条件

  • 実行中の OpenShift Container Platform クラスターがあり、ログインしている。
  • Helm がインストールされている。

手順

  1. 新規プロジェクトを作成します。 

    $ oc new-project mysql
    Copy to Clipboard Toggle word wrap

  2. Helm チャートのリポジトリーをローカルの Helm クライアントに追加します。 

    $ helm repo add stable https://kubernetes-charts.storage.googleapis.com/
    Copy to Clipboard Toggle word wrap

    出力例

    "stable" has been added to your repositories
    Copy to Clipboard Toggle word wrap

  3. リポジトリーを更新します。 

    $ helm repo update
    Copy to Clipboard Toggle word wrap

  4. MySQL チャートのサンプルをインストールします。 

    $ helm install example-mysql stable/mysql
    Copy to Clipboard Toggle word wrap

  5. チャートが正常にインストールされたことを確認します。 

    $ helm list
    Copy to Clipboard Toggle word wrap

    出力例

    NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
example-mysql mysql 1 2019-12-05 15:06:51.379134163 -0500 EST deployed mysql-1.5.0 5.7.27
    Copy to Clipboard Toggle word wrap

3.1.4. OpenShift Container Platform でのカスタム Helm チャートの作成
リンクのコピー

手順

  1. 新規プロジェクトを作成します。 

    $ oc new-project nodejs-ex-k
    Copy to Clipboard Toggle word wrap

  2. OpenShift Container Platform オブジェクトが含まれる Node.js チャートのサンプルをダウンロードします。 

    $ git clone https://github.com/redhat-developer/redhat-helm-charts
    Copy to Clipboard Toggle word wrap

  3. サンプルチャートを含むディレクトリーに移動します。 

    $ cd redhat-helm-charts/alpha/nodejs-ex-k/
    Copy to Clipboard Toggle word wrap

  4. Chart.yaml ファイルを編集し、チャートの説明を追加します。 

    apiVersion: v2
    1 
    
name: nodejs-ex-k
    2 
    
description: A Helm chart for OpenShift
    3 
    
icon: https://static.redhat.com/libs/redhat/brand-assets/latest/corp/logo.svg
    4
    Copy to Clipboard Toggle word wrap
    1
    チャート API バージョン。これは、Helm 3 以上を必要とする Helm チャートの場合は v2 である必要があります。
    2
    チャートの名前。
    3
    チャートの説明。
    4
    アイコンとして使用するイメージへの URL。

  5. チャートが適切にフォーマットされていることを確認します。 

    $ helm lint
    Copy to Clipboard Toggle word wrap

    出力例

    [INFO] Chart.yaml: icon is recommended

1 chart(s) linted, 0 chart(s) failed
    Copy to Clipboard Toggle word wrap

  6. 直前のディレクトリーレベルに移動します。 

    $ cd ..
    Copy to Clipboard Toggle word wrap

  7. チャートをインストールします。 

    $ helm install nodejs-chart nodejs-ex-k
    Copy to Clipboard Toggle word wrap

  8. チャートが正常にインストールされたことを確認します。 

    $ helm list
    Copy to Clipboard Toggle word wrap

    出力例

    NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
nodejs-chart nodejs-ex-k 1 2019-12-05 15:06:51.379134163 -0500 EST deployed nodejs-0.1.0  1.16.0
    Copy to Clipboard Toggle word wrap

第4章 OpenShift Serverless で使用する Knative CLI (kn)
リンクのコピー

kn は、OpenShift Container Platform の Knative コンポーネントとの簡単な対話を有効にします。

OpenShift Serverless をインストールして、OpenShift Container Platform で Knative を有効にすることができます。詳細は、OpenShift Serverless の使用開始 についてのドキュメントを参照してください。

注記

OpenShift Serverless は kn CLI を使用してインストールできません。クラスター管理者は、OpenShift Container Platform の Serverless アプリケーション についてのドキュメントで説明されているように OpenShift Serverless Operator をインストールし、Knative コンポーネントをセットアップする必要があります。

4.1. 主な特長
リンクのコピー

kn は、サーバーレスコンピューティングタスクを単純かつ簡潔にするように設計されています。kn の主な特長には、以下が含まれます。

  • コマンドラインから サーバーレスアプリケーションをデプロイ します。
  • サービス、リビジョン、およびトラフィック分割などの Knative Serving の機能を管理します。

  • イベントソースおよびトリガーなどの Knative Eventing コンポーネントを作成し、管理します。

    注記

    Knative Eventing は現時点で OpenShift Serverless のテクノロジープレビュー機能として利用できます。

  • 既存の Kubernetes アプリケーションおよび Knative サービスを接続するために、sink binding を作成します。
  • kubectl と同様に、kn を柔軟性のあるプラグインアーキテクチャーで拡張します。
  • Knative サービスの 自動スケーリング パラメーターを設定します。
  • 操作の結果を待機したり、カスタムロールアウトおよびロールバックストラテジーのデプロイなどのスクリプト化された使用。

4.2. kn のインストール
リンクのコピー

OpenShift Serverless で使用する kn のインストールについての詳細は、Knative CLI (kn) のインストール についてのドキュメントを参照してください。

第5章 Pipelines CLI (tkn)
リンクのコピー

5.1. tkn のインストール
リンクのコピー

tkn CLI を使用して、ターミナルから Red Hat OpenShift Pipeline を管理します。以下のセクションでは、各種の異なるプラットフォームに tkn をインストールする方法を説明します。

また、OpenShift Container Platform Web コンソールから最新のバイナリーへの URL を見つけるには、右上隅の ? アイコンをクリックし、Command Line Tools を選択します。

5.1.1. Linux への Red Hat OpenShift Pipelines CLI (tkn) のインストール
リンクのコピー

Linux ディストリビューションの場合、CLI を tar.gz アーカイブとして直接ダウンロードできます。

手順

  1. CLI をダウンロードします。

  2. アーカイブを展開します。 

    $ tar xvzf <file>
    Copy to Clipboard Toggle word wrap
  3. tkn バイナリーを、PATH にあるディレクトリーに配置します。

  4. PATH を確認するには、以下を実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

5.1.2. RPM を使用した Red Hat OpenShift Pipelines CLI (tkn) の Linux へのインストール
リンクのコピー

Red Hat Enterprise Linux (RHEL) バージョン 8 の場合は、Red Hat OpenShift Pipelines CLI (tkn) を RPM としてインストールできます。

前提条件

  • お使いの Red Hat アカウントに有効な OpenShift Container Platform サブスクリプションがある。
  • ローカルシステムに root または sudo 権限がある。

手順

  1. Red Hat Subscription Manager に登録します。 

    # subscription-manager register
    Copy to Clipboard Toggle word wrap

  2. 最新のサブスクリプションデータをプルします。 

    # subscription-manager refresh
    Copy to Clipboard Toggle word wrap

  3. 利用可能なサブスクリプションを一覧表示します。 

    # subscription-manager list --available --matches '*pipelines*'
    Copy to Clipboard Toggle word wrap

  4. 直前のコマンドの出力で、OpenShift Container Platform サブスクリプションのプール ID を見つけ、これを登録されたシステムにアタッチします。 

    # subscription-manager attach --pool=<pool_id>
    Copy to Clipboard Toggle word wrap

  5. Red Hat OpenShift Pipelines で必要なリポジトリーを有効にします。 

    # subscription-manager repos --enable="pipelines-1.1-for-rhel-8-x86_64-rpms"
    Copy to Clipboard Toggle word wrap

  6. openshift-pipelines-client パッケージをインストールします。 

    # yum install openshift-pipelines-client
    Copy to Clipboard Toggle word wrap

CLI のインストール後は、tkn コマンドを使用して利用できます。 

$ tkn version
Copy to Clipboard Toggle word wrap

5.1.3. Windows への Red Hat OpenShift Pipelines CLI (tkn) のインストール
リンクのコピー

Windows の場合、tkn CLI は zip アーカイブとして提供されます。

手順

  1. CLI をダウンロードします。
  2. ZIP プログラムでアーカイブを解凍します。
  3. tkn.exe ファイルの場所を、 PATH 環境変数に追加します。

  4. PATH を確認するには、コマンドプロンプトを開いて以下のコマンドを実行します。 

    C:\> path
    Copy to Clipboard Toggle word wrap

5.1.4. macOS への Red Hat OpenShift Pipelines CLI (tkn) のインストール
リンクのコピー

macOS の場合、tkn CLI は tar.gz アーカイブとして提供されます。

手順

  1. CLI をダウンロードします。
  2. アーカイブを展開し、解凍します。
  3. tkn バイナリーをパスにあるディレクトリーに移動します。

  4. PATH を確認するには、ターミナルウィンドウを開き、以下を実行します。 

    $ echo $PATH
    Copy to Clipboard Toggle word wrap

5.2. OpenShift Pipelines tkn CLI の設定
リンクのコピー

タブ補完を有効にするために Red Hat OpenShift Pipelines tkn CLI を設定します。

5.2.1. タブ補完の有効化
リンクのコピー

tkn CLI ツールをインストールした後に、タブ補完を有効にして tkn コマンドの自動補完を実行するか、または Tab キーを押す際にオプションの提案が表示されるようにできます。

前提条件

  • tkn CLI ツールをインストールしていること。
  • ローカルシステムに bash-completion がインストールされていること。

手順

以下の手順では、Bash のタブ補完を有効にします。

  1. Bash 補完コードをファイルに保存します。 

    $ tkn completion bash > tkn_bash_completion
    Copy to Clipboard Toggle word wrap

  2. ファイルを /etc/bash_completion.d/ にコピーします。 

    $ sudo cp tkn_bash_completion /etc/bash_completion.d/
    Copy to Clipboard Toggle word wrap

    または、ファイルをローカルディレクトリーに保存した後に、これを .bashrc ファイルから取得できるようにすることができます。

タブ補完は、新規ターミナルを開くと有効にされます。

5.3. OpenShift Pipelines tkn リファレンス
リンクのコピー

このセクションでは、基本的な tkn CLI コマンドの一覧を紹介します。

5.3.1. 基本的な構文
リンクのコピー

tkn [command or options] [arguments…​]

5.3.2. グローバルオプション
リンクのコピー

--help, -h

5.3.3. ユーティリティーコマンド
リンクのコピー

5.3.3.1. tkn
リンクのコピー

tkn CLI の親コマンド。

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

$ tkn
Copy to Clipboard Toggle word wrap

5.3.3.2. completion [shell]
リンクのコピー

インタラクティブな補完を提供するために評価する必要があるシェル補完コードを出力します。サポートされるシェルは bash および zsh です。

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

$ tkn completion bash
Copy to Clipboard Toggle word wrap

5.3.3.3. version
リンクのコピー

tkn CLI のバージョン情報を出力します。

例: tkn バージョンの確認

$ tkn version
Copy to Clipboard Toggle word wrap

5.3.4. Pipelines 管理コマンド
リンクのコピー

5.3.4.1. pipeline
リンクのコピー

Pipeline を管理します。

例: ヘルプの表示

$ tkn pipeline --help
Copy to Clipboard Toggle word wrap

5.3.4.2. pipeline delete
リンクのコピー

Pipeline を削除します。

例: namespace からの mypipeline Pipeline の削除

$ tkn pipeline delete mypipeline -n myspace
Copy to Clipboard Toggle word wrap

5.3.4.3. pipeline describe
リンクのコピー

Pipeline を記述します。

例: mypipeline Pipeline の記述

$ tkn pipeline describe mypipeline
Copy to Clipboard Toggle word wrap

5.3.4.4. pipeline list
リンクのコピー

Pipeline を一覧表示します。

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

$ tkn pipeline list
Copy to Clipboard Toggle word wrap

5.3.4.5. pipeline logs
リンクのコピー

特定の Pipeline の Pipeline ログを表示します。

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

$ tkn pipeline logs -f mypipeline
Copy to Clipboard Toggle word wrap

5.3.4.6. pipeline start
リンクのコピー

Pipeline を開始します。

例: mypipeline Pipeline の開始

$ tkn pipeline start mypipeline
Copy to Clipboard Toggle word wrap

5.3.5. PipelineRun コマンド
リンクのコピー

5.3.5.1. pipelinerun
リンクのコピー

PipelineRun を管理します。

例: ヘルプの表示

$ tkn pipelinerun -h
Copy to Clipboard Toggle word wrap

5.3.5.2. pipelinerun cancel
リンクのコピー

PipelineRun を取り消します。

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

$ tkn pipelinerun cancel mypipelinerun -n myspace
Copy to Clipboard Toggle word wrap

5.3.5.3. pipelinerun delete
リンクのコピー

PipelineRun を削除します。

例: namespace からの PipelineRun の削除

$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
Copy to Clipboard Toggle word wrap

5.3.5.4. pipelinerun describe
リンクのコピー

PipelineRun を記述します。

例: namespace の mypipelinerun PipelineRun の記述

$ tkn pipelinerun describe mypipelinerun -n myspace
Copy to Clipboard Toggle word wrap

5.3.5.5. pipelinerun list
リンクのコピー

PipelineRun を一覧表示します。

例: namespace の PipelineRun の一覧表示

$ tkn pipelinerun list -n myspace
Copy to Clipboard Toggle word wrap

5.3.5.6. pipelinerun logs
リンクのコピー

PipelineRun のログを表示します。

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

$ tkn pipelinerun logs mypipelinerun -a -n myspace
Copy to Clipboard Toggle word wrap

5.3.6. タスク管理コマンド
リンクのコピー

5.3.6.1. task
リンクのコピー

Task を管理します。

例: ヘルプの表示

$ tkn task -h
Copy to Clipboard Toggle word wrap

5.3.6.2. task delete
リンクのコピー

Task を削除します。

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

$ tkn task delete mytask1 mytask2 -n myspace
Copy to Clipboard Toggle word wrap

5.3.6.3. task describe
リンクのコピー

Task を記述します。

例: namespace の mytask Task の記述

$ tkn task describe mytask -n myspace
Copy to Clipboard Toggle word wrap

5.3.6.4. task list
リンクのコピー

Task を一覧表示します。

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

$ tkn task list -n myspace
Copy to Clipboard Toggle word wrap

5.3.6.5. task logs
リンクのコピー

Task ログを表示します。

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

$ tkn task logs mytask mytaskrun -n myspace
Copy to Clipboard Toggle word wrap

5.3.6.6. task start
リンクのコピー

Task を開始します。

例: namespace の mytask Task の開始

$ tkn task start mytask -s <ServiceAccountName> -n myspace
Copy to Clipboard Toggle word wrap

5.3.7. TaskRun コマンド
リンクのコピー

5.3.7.1. taskrun
リンクのコピー

TaskRun を管理します。

例: ヘルプの表示

$ tkn taskrun -h
Copy to Clipboard Toggle word wrap

5.3.7.2. taskrun cancel
リンクのコピー

TaskRun をキャンセルします。

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

$ tkn taskrun cancel mytaskrun -n myspace
Copy to Clipboard Toggle word wrap

5.3.7.3. taskrun delete
リンクのコピー

TaskRun を削除します。

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

$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
Copy to Clipboard Toggle word wrap

5.3.7.4. taskrun describe
リンクのコピー

TaskRun を記述します。

例: namespace の mytaskrun TaskRun の記述

$ tkn taskrun describe mytaskrun -n myspace
Copy to Clipboard Toggle word wrap

5.3.7.5. taskrun list
リンクのコピー

TaskRun を一覧表示します。

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

$ tkn taskrun list -n myspace
Copy to Clipboard Toggle word wrap

5.3.7.6. taskrun logs
リンクのコピー

TaskRun ログを表示します。

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

$ tkn taskrun logs -f mytaskrun -n myspace
Copy to Clipboard Toggle word wrap

5.3.8. 条件管理コマンド
リンクのコピー

5.3.8.1. condition
リンクのコピー

条件を管理します。

例: ヘルプの表示

$ tkn condition --help
Copy to Clipboard Toggle word wrap

5.3.8.2. condition delete
リンクのコピー

条件を削除します。

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

$ tkn condition delete mycondition1 -n myspace
Copy to Clipboard Toggle word wrap

5.3.8.3. condition describe
リンクのコピー

条件を記述します。

例: namespace での mycondition1 条件の記述

$ tkn condition describe mycondition1 -n myspace
Copy to Clipboard Toggle word wrap

5.3.8.4. condition list
リンクのコピー

条件を一覧表示します。

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

$ tkn condition list -n myspace
Copy to Clipboard Toggle word wrap

5.3.9. Pipeline リソース管理コマンド
リンクのコピー

5.3.9.1. resource
リンクのコピー

Pipeline リソースを管理します。

例: ヘルプの表示

$ tkn resource -h
Copy to Clipboard Toggle word wrap

5.3.9.2. resource create
リンクのコピー

Pipeline リソースを作成します。

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

$ tkn resource create -n myspace
Copy to Clipboard Toggle word wrap

これは、リソースの名前、リソースのタイプ、およびリソースのタイプに基づく値の入力を要求するインタラクティブなコマンドです。

5.3.9.3. resource delete
リンクのコピー

Pipeline リソースを削除します。

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

$ tkn resource delete myresource -n myspace
Copy to Clipboard Toggle word wrap

5.3.9.4. resource describe
リンクのコピー

Pipeline リソースを記述します。

例: myresource Pipeline リソースの記述

$ tkn resource describe myresource -n myspace
Copy to Clipboard Toggle word wrap

5.3.9.5. resource list
リンクのコピー

Pipeline リソースを一覧表示します。

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

$ tkn resource list -n myspace
Copy to Clipboard Toggle word wrap

5.3.10. ClusterTask 管理コマンド
リンクのコピー

5.3.10.1. clustertask
リンクのコピー

ClusterTask を管理します。

例: ヘルプの表示

$ tkn clustertask --help
Copy to Clipboard Toggle word wrap

5.3.10.2. clustertask delete
リンクのコピー

クラスターの ClusterTask リソースを削除します。

例: mytask1 および mytask2 ClusterTask の削除

$ tkn clustertask delete mytask1 mytask2
Copy to Clipboard Toggle word wrap

5.3.10.3. clustertask describe
リンクのコピー

ClusterTask を記述します。

例: mytask ClusterTask の記述

$ tkn clustertask describe mytask1
Copy to Clipboard Toggle word wrap

5.3.10.4. clustertask list
リンクのコピー

ClusterTask を一覧表示します。

例: ClusterTask の一覧表示

$ tkn clustertask list
Copy to Clipboard Toggle word wrap

5.3.10.5. clustertask start
リンクのコピー

ClusterTask を開始します。

例: mytask ClusterTask の開始

$ tkn clustertask start mytask
Copy to Clipboard Toggle word wrap

5.3.11. 管理コマンドのトリガー
リンクのコピー

5.3.11.1. eventlistener
リンクのコピー

EventListener を管理します。

例: ヘルプの表示

$ tkn eventlistener -h
Copy to Clipboard Toggle word wrap

5.3.11.2. eventlistener delete
リンクのコピー

EventListener を削除します。

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

$ tkn eventlistener delete mylistener1 mylistener2 -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.3. eventlistener describe
リンクのコピー

EventListener を記述します。

例: namespace の mylistener EventListener の記述

$ tkn eventlistener describe mylistener -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.4. eventlistener list
リンクのコピー

EventListener を一覧表示します。

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

$ tkn eventlistener list -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.5. triggerbinding
リンクのコピー

TriggerBinding を管理します。

例: TriggerBindings ヘルプの表示

$ tkn triggerbinding -h
Copy to Clipboard Toggle word wrap

5.3.11.6. triggerbinding delete
リンクのコピー

TriggerBinding を削除します。

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

$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.7. triggerbinding describe
リンクのコピー

TriggerBinding を記述します。

例: namespace の mybinding TriggerBinding の記述

$ tkn triggerbinding describe mybinding -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.8. triggerbinding list
リンクのコピー

TriggerBinding を一覧表示します。

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

$ tkn triggerbinding list -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.9. triggertemplate
リンクのコピー

TriggerTemplate を管理します。

例: TriggerTemplate ヘルプの表示

$ tkn triggertemplate -h
Copy to Clipboard Toggle word wrap

5.3.11.10. triggertemplate delete
リンクのコピー

TriggerTemplate を削除します。

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

$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace`
Copy to Clipboard Toggle word wrap

5.3.11.11. triggertemplate describe
リンクのコピー

TriggerTemplate を記述します。

例: namespace の mytemplate TriggerTemplate の記述

$ tkn triggertemplate describe mytemplate -n `myspace`
Copy to Clipboard Toggle word wrap

5.3.11.12. triggertemplate list
リンクのコピー

TriggerTemplate を一覧表示します。

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

$ tkn triggertemplate list -n myspace
Copy to Clipboard Toggle word wrap

5.3.11.13. clustertriggerbinding
リンクのコピー

ClusterTriggerBinding を管理します。

例: ClusterTriggerBinding のヘルプの表示

$ tkn clustertriggerbinding -h
Copy to Clipboard Toggle word wrap

5.3.11.14. clustertriggerbinding delete
リンクのコピー

ClusterTriggerBinding を削除します。

例: myclusterbinding1 および myclusterbinding2 ClusterTriggerBinding の削除

$ tkn clustertriggerbinding delete myclusterbinding1 myclusterbinding2
Copy to Clipboard Toggle word wrap

5.3.11.15. clustertriggerbinding describe
リンクのコピー

ClusterTriggerBinding を記述します。

例: myclusterbinding ClusterTriggerBinding の記述

$ tkn clustertriggerbinding describe myclusterbinding
Copy to Clipboard Toggle word wrap

5.3.11.16. clustertriggerbinding list
リンクのコピー

ClusterTriggerBinding の一覧を表示します。

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

$ tkn clustertriggerbinding list
Copy to Clipboard Toggle word wrap

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat