CLI ツール

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

   $ oc completion bash > oc_bash_completion

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

   $ sudo cp oc_bash_completion /etc/bash_completion.d/

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

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"

手順

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

   $ chmod +x <plugin_file>

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

   $ sudo mv <plugin_file> /usr/local/bin/.

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

   $ oc plugin list
   The following compatible plugins are available:
   
   /usr/local/bin/<plugin_file>

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

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

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

   $ oc ns

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

1. リソースの作成

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

   • デプロイメント設定 (DC):

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

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

       注記

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

   • サービス
   • シークレット
   • PersistentVolumeClaim

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

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

3. コードのプッシュ

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

4. assemble-and-restart の実行

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

手順

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

   $ odo login -u developer -p developer

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

   $ odo project create myproject
    ✓  Project 'myproject' is ready for use
    ✓  New project created and now using project : myproject

手順

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

   $ mkdir my_components $$ cd my_components

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

   $ git clone https://github.com/openshift/nodejs-ex

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

   $ cd <directory name>

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

   $ odo create nodejs

   注記

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

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

   $ odo push

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

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

   $ odo url create --port 8080

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

   $ odo push

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

   $ odo url list

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

   $ curl <URL>

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

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

   $ odo push

3. ブラウザーでアプリケーションを更新し、変更を確認します。

手順

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

   $ oc import-image openjdk18 \
   --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift \
   --confirm

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

   $ oc annotate istag/openjdk18:latest tags=builder

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

   $ odo create openjdk18 --git \
   https://github.com/openshift-evangelists/Wild-West-Backend

手順

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

   $ odo app list
       The project '<project_name>' has the following applications:
       NAME
       app

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

   $ odo component list
       APP     NAME                      TYPE       SOURCE        STATE
       app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed

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

   $ odo app delete <application_name>
       ? Are you sure you want to delete the application: <application_name> from project: <project_name>

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

手順

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

   $ odo login -u developer -p developer

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

   $ odo project create myproject
    ✓  Project 'myproject' is ready for use
    ✓  New project created and now using project : myproject

手順

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

   $ oc import-image openjdk18 \
   --from=registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift --confirm

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

   $ oc annotate istag/openjdk18:latest tags=builder

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

   $ odo catalog list components
   Odo Supported OpenShift Components:
   NAME          PROJECT       TAGS
   nodejs        openshift     10,8,8-RHOAR,latest
   openjdk18     myproject     latest

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

   $ mkdir my_components $$ cd my_components

5. バックエンドアプリケーションのサンプルをダウンロードします。

   $ git clone https://github.com/openshift-evangelists/Wild-West-Backend backend

6. ディレクトリーをバックエンドソースディレクトリーに切り替え、そのディレクトリーに正しいファイルが含まれることを確認します。

   $ cd backend
   $ ls
   debug.sh  pom.xml  src

7. バックエンドのソースファイルを Maven でビルドし、JAR ファイルを作成します。

   $ mvn package
   ...
   [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] --------------------------------------

8. backend という Java コンポーネントタイプのコンポーネント設定を作成します。

   $ odo create openjdk18 backend --binary target/wildwest-1.0.jar
    ✓  Validating component [1ms]
    Please use `odo push` command to create the component with source deployed

   設定ファイルの config.yaml は、デプロイ用のコンポーネントについての情報が含まれるバックエンドコンポーネントのローカルディレクトリーに置かれます。

9. 以下を使用して config.yaml ファイルでバックエンドコンポーネントの設定内容を確認します。

   $ odo config view
   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

10. コンポーネントを OpenShift Container Platform クラスターにプッシュします。

    $ odo push
    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]

    odo push を使用すると、OpenShift Container Platform はバックエンドコンポーネントをホストするためのコンテナーを作成し、そのコンテナーを OpenShift Container Platform クラスターで実行されている Pod にデプロイし、 backend コンポーネントを起動します。

11. 以下を検証します。

    • odo でのアクションのステータス

      odo log -f
      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)

    • バックエンドコンポーネントのステータス

      $ odo list
      APP     NAME        TYPE          SOURCE                             STATE
      app     backend     openjdk18     file://target/wildwest-1.0.jar     Pushed

手順

1. フロントエンドアプリケーションのサンプルをダウンロードします。

   $ git clone https://github.com/openshift/nodejs-ex

2. 現在のディレクトリーをフロントエンドディレクトリーに切り替えます。

   $ cd <directory-name>

3. フロントエンドが Node.js アプリケーションであることを確認するために、ディレクトリーの内容を一覧表示します。

   $ ls
   assets  bin  index.html  kwww-frontend.iml  package.json  package-lock.json  playfield.png  README.md  server.js

   注記

   フロントエンドコンポーネントはインタプリター型言語で記述され (Node.js)、ビルドされる必要はありません。

4. frontendという名前の Node.js コンポーネントタイプのコンポーネント設定を作成します。

   $ odo create nodejs frontend
    ✓  Validating component [5ms]
   Please use `odo push` command to create the component with source deployed

5. コンポーネントを実行中のコンテナーにプッシュします。

   $ odo push
   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

手順

1. クラスターで実行されるすべてのコンポーネントの一覧を表示します。

   $ odo list
   APP     NAME         TYPE          SOURCE                             STATE
   app     backend      openjdk18     file://target/wildwest-1.0.jar     Pushed
   app     frontend     nodejs        file://./                          Pushed

2. 現在のフロントエンドコンポーネントをバックエンドにリンクします。

   $ odo link backend --port 8080
    ✓  Component backend has been successfully linked from the component frontend
   
   Following environment variables were added to frontend component:
   - COMPONENT_BACKEND_HOST
   - COMPONENT_BACKEND_PORT

   バックエンドコンポーネントの設定情報がフロントエンドコンポーネントに追加され、フロントエンドコンポーネントが再起動します。

手順

1. アプリケーションの外部 URL を作成します。

   $ cd frontend
   $ odo url create frontend --port 8080
    ✓  URL frontend created for component: frontend
   
   To create URL on the OpenShift  cluster, use `odo push`

2. 変更を適用します。

   $ odo push
   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.

3. ブラウザーで URL を開き、アプリケーションを表示します。

手順

1. ローカルディレクトリーをフロントエンドディレクトリーに切り替えます。

   $ cd ~/frontend

2. 以下のコマンドを実行して、ファイルシステムで変更を監視します。

   $ odo watch

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

4. Web ブラウザーでアプリケーションページを更新します。これで新しい名前が表示されます。

手順

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

   $ odo app list
       The project '<project_name>' has the following applications:
       NAME
       app

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

   $ odo component list
       APP     NAME                      TYPE       SOURCE        STATE
       app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed

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

   $ odo app delete <application_name>
       ? Are you sure you want to delete the application: <application_name> from project: <project_name>

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

手順

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

   $ odo login -u developer -p developer

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

   $ odo project create myproject
    ✓  Project 'myproject' is ready for use
    ✓  New project created and now using project : myproject

手順

1. フロントエンドアプリケーションのサンプルをダウンロードします。

   $ git clone https://github.com/openshift/nodejs-ex

2. 現在のディレクトリーをフロントエンドディレクトリーに切り替えます。

   $ cd <directory-name>

3. フロントエンドが Node.js アプリケーションであることを確認するために、ディレクトリーの内容を一覧表示します。

   $ ls
   assets  bin  index.html  kwww-frontend.iml  package.json  package-lock.json  playfield.png  README.md  server.js

   注記

   フロントエンドコンポーネントはインタプリター型言語で記述され (Node.js)、ビルドされる必要はありません。

4. frontendという名前の Node.js コンポーネントタイプのコンポーネント設定を作成します。

   $ odo create nodejs frontend
    ✓  Validating component [5ms]
   Please use `odo push` command to create the component with source deployed

5. フロントエンドインターフェースにアクセスするための URL を作成します。

   $ odo url create myurl
    ✓  URL myurl created for component: nodejs-nodejs-ex-pmdp

6. コンポーネントを OpenShift Container Platform クラスターにプッシュします。

   $ odo push
   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

1. 利用可能なサービスを一覧表示します。

   $ odo catalog list services
   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

2. サービスの mongodb-persistent タイプを選択し、必要なパラメーターを確認します。

   $ odo catalog describe service mongodb-persistent
     ***********************        | *****************************************************
     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

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

1. データベースをフロントエンドサービスにリンクします。

   $ odo link mongodb-persistent
    ✓  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

2. Pod のアプリケーションおよびデータベースの環境変数を確認します。

   $ oc get pods
   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
   
   $ oc rsh nodejs-nodejs-ex-mhbb-app-4-vkn9l
   sh-4.3$ env
   uri=mongodb://172.30.126.3:27017
   password=dHIOpYneSkX3rTLn
   database_name=sampledb
   username=user43U
   admin_password=NCn41tqmx7RIqmfv
   sh-4.3$

3. ブラウザーで URL を開き、右下に表示されるデータベース設定を確認します。

   $ odo url list

   Request information
   Page view count: 24
   
   DB Connection Info:
   Type:	MongoDB
   URL:	mongodb://172.30.126.3:27017/sampledb

手順

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

   $ odo app list
       The project '<project_name>' has the following applications:
       NAME
       app

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

   $ odo component list
       APP     NAME                      TYPE       SOURCE        STATE
       app     nodejs-nodejs-ex-elyf     nodejs     file://./     Pushed

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

   $ odo app delete <application_name>
       ? Are you sure you want to delete the application: <application_name> from project: <project_name>

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

手順

1. アプリケーションがデプロイされた後に、コンポーネントのポート転送を開始して、アプリケーションのデバッグを行います。

   $ odo debug port-forward

2. IDE にバンドルされたデバッガーをコンポーネントに割り当てます。手順は、IDE によって異なります。

手順

1. 新規プロジェクトを作成します。

   $ oc new-project mysql

2. Helm チャートのリポジトリーをローカルの Helm クライアントに追加します。

   $ helm repo add stable https://kubernetes-charts.storage.googleapis.com/
   "stable" has been added to your repositories

3. リポジトリーを更新します。

   $ helm repo update

4. MySQL チャートのサンプルをインストールします。

   $ helm install example-mysql stable/mysql

5. チャートが正常にインストールされたことを確認します。

   $ helm list
   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

手順

1. 新規プロジェクトを作成します。

   $ oc new-project nodejs-ex-k

2. OpenShift Container Platform オブジェクトが含まれる Node.js チャートのサンプルをダウンロードします。

   $ git clone https://github.com/redhat-developer/redhat-helm-charts

3. サンプルチャートを含むディレクトリーに移動します。

   $ cd redhat-helm-charts/alpha/nodejs-ex-k/

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

   1

   チャート API バージョン。これは、Helm 3 以上を必要とする Helm チャートの場合は v2 である必要があります。

   2

   チャートの名前。

   3

   チャートの説明。

   4

   アイコンとして使用するイメージへの URL。

5. チャートが適切にフォーマットされていることを確認します。

   $ helm lint
   [INFO] Chart.yaml: icon is recommended
   
   1 chart(s) linted, 0 chart(s) failed

6. チャートをインストールします。

   $ cd ..
   $ helm install nodejs-chart nodejs-ex-k

7. チャートが正常にインストールされたことを確認します。

   $ helm list
   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