第3章 アプリケーションの作成

手順

• 以下のコマンドを実行して、テンプレートにラベルを追加します。

  $ oc process -f <filename> -l name=otherLabel

手順

• 以下のコマンドを実行して、ローカルテンプレートファイルからテンプレートパラメーターを一覧表示します。

  $ oc process --parameters -f <filename>

• 次のコマンドを実行して、アップロードしたテンプレートからテンプレートパラメーターを一覧表示します。

  $ oc process --parameters -n <project> <template_name>

  たとえば、デフォルトの openshift プロジェクトで rails-postgresql-example クイックスタートテンプレートのパラメーターを一覧表示するには、以下のコマンドを実行します。

  $ oc process --parameters -n openshift rails-postgresql-example

  出力例

  NAME                         DESCRIPTION                                                                                              GENERATOR           VALUE
  SOURCE_REPOSITORY_URL        The URL of the repository with your application source code                                                                  https://github.com/sclorg/rails-ex.git
  SOURCE_REPOSITORY_REF        Set this to a branch name, tag or other ref of your repository if you are not using the default branch
  CONTEXT_DIR                  Set this to the relative path to your project if it is not in the root of your repository
  APPLICATION_DOMAIN           The exposed hostname that will route to the Rails service                                                                    rails-postgresql-example.openshiftapps.com
  GITHUB_WEBHOOK_SECRET        A secret string used to configure the GitHub webhook                                                     expression          [a-zA-Z0-9]{40}
  SECRET_KEY_BASE              Your secret key for verifying the integrity of signed cookies                                            expression          [a-z0-9]{127}
  APPLICATION_USER             The application user that is used within the sample application to authorize access on pages                                 openshift
  APPLICATION_PASSWORD         The application password that is used within the sample application to authorize access on pages                             secret
  DATABASE_SERVICE_NAME        Database service name                                                                                                        postgresql
  POSTGRESQL_USER              database username                                                                                        expression          user[A-Z0-9]{3}
  POSTGRESQL_PASSWORD          database password                                                                                        expression          [a-zA-Z0-9]{8}
  POSTGRESQL_DATABASE          database name                                                                                                                root
  POSTGRESQL_MAX_CONNECTIONS   database max connections                                                                                                     10
  POSTGRESQL_SHARED_BUFFERS    database shared buffers                                                                                                      12MB

  この出力から、テンプレートの処理時に正規表現のようなジェネレーターで生成された複数のパラメーターを特定できます。

手順

• 以下のコマンドを実行して、標準出力にオブジェクト一覧を返すテンプレートを定義するファイルを処理します。

  $ oc process -f <filename>

• 次のコマンドを実行して、現在のプロジェクトにアップロードされたテンプレートを処理し、オブジェクトのリストを標準出力に戻します。

  $ oc process <template_name>

• 以下のコマンドを実行して、テンプレートを処理し、oc create の出力をパイプして、テンプレートからオブジェクトを作成します。

  $ oc process -f <filename> | oc create -f -

• 以下のコマンドを実行して、テンプレートを処理し、oc create の出力をパイプして、現在のプロジェクトにアップロードされたテンプレートからオブジェクトを作成します。

  $ oc process <template> | oc create -f -

• オーバーライドする <name>=<value> の各ペアに、-p オプションを追加することで、ファイルに定義されたパラメーターの値をオーバーライドできます。パラメーター参照は、テンプレートアイテム内のテキストフィールドに表示されます。

  たとえば、テンプレートの以下の POSTGRESQL_USER および POSTGRESQL_DATABASE パラメーターをオーバーライドし、カスタマイズされた環境変数の設定を出力します。

  • 次のコマンドを実行して、テンプレートからオブジェクトの一覧を作成します。

    $ oc process -f my-rails-postgresql \
        -p POSTGRESQL_USER=bob \
        -p POSTGRESQL_DATABASE=mydatabase

  • 次のコマンドを実行して、処理された出力からオブジェクトを作成します。

    $ oc process -f my-rails-postgresql \
        -p POSTGRESQL_USER=bob \
        -p POSTGRESQL_DATABASE=mydatabase \
        | oc create -f -

    注記

    JSON 出力をファイルにリダイレクトするか、oc create コマンドにパイプして、テンプレートをアップロードせずに直接適用できます。

  • 多数のパラメーターがある場合は、以下のコマンドを実行して、それらをファイルに保存してからそのファイルを oc process に渡すことができます。

    $ cat postgres.env

    $ oc process -f my-rails-postgresql --param-file=postgres.env

    出力例

    POSTGRESQL_USER=bob
    POSTGRESQL_DATABASE=mydatabase

  • 次のコマンドを実行して、"-- param-file オプションの値として "-" を指定して、標準入力からパラメーター値を読み取ることもできます。

    $ sed s/bob/alice/ postgres.env | oc process -f my-rails-postgresql --param-file=-

• 文字列の値として、テンプレートの文字列フィールドに ${PARAMETER_NAME} の形式で配置する
• JSON/YAML の値として、テンプレートのフィールドに ${{PARAMETER_NAME}} の形式で配置する

• [\w]{10} は、10 桁の英字、数字、およびアンダースコアを生成します。これは PCRE 標準に準拠し、[a-zA-Z0-9_]{10} に相当します。
• [\d]{10} は 10 桁の数字を生成します。これは [0-9]{10} に相当します。
• [\a]{10} は 10 桁の英字を生成します。これは [a-zA-Z]{10} に相当します。
• [\A]{10} は 10 の句読点または記号文字を生成します。これは [~!@#$%\^&*()\-_+={}\[\]\\|<,>.?/"';:`]{10} に相当します。

手順

• template.openshift.io/bindable: "false" のアノテーションをテンプレートに追加して、エンドユーザーが指定のテンプレートからプロビジョニングされるサービスをバインドできないようにします。

手順

• template.openshift.io/expose- アノテーションを使用して、値を文字列として返します。この方法では、任意のバイナリーデータは処理されません。
• バイナリーデータを返す必要がある場合、template.openshift.io/base64-expose- アノテーションを使用して、データが返される前にデータをエンコードします。

• アプリケーションにスムーズに実行するのに十分なリソースが提供されるようにメモリー、CPU、およびストレージのデフォルトサイズを設定します。
• latest タグが複数のメジャーバージョンで使用されている場合には、イメージからこのタグを参照しないようにします。新規イメージがそのタグにプッシュされると、実行中のアプリケーションが破損してしまう可能性があります。
• 適切なテンプレートの場合、テンプレートのデプロイ後に変更する必要なしに、ビルドおよびデプロイが正常に行われます。

手順

• テンプレート機能を使用するには、テンプレート内の Build、BuildConfig、Deployment、DeploymentConfig、Job、または StatefulSet の種類のオブジェクト 1 つ以上に、以下のアノテーションでマークを付けます。

  "template.alpha.openshift.io/wait-for-ready": "true"

  アノテーションのマークが付けられたすべてのオブジェクトが準備完了と報告されるまで、テンプレートからのリソースの作成は完了しません。同様に、アノテーションが付けられたオブジェクトが失敗したと報告されるか、固定タイムアウトである 1 時間以内にテンプレートの準備が整わなかった場合に、テンプレートからリソースを作成できません。

  テンプレートからリソースを作成する場合、各オブジェクトの種類の準備状態および失敗は以下のように定義されます。

  種類	準備状態 (Readiness)	失敗 (Failure)
  Build	オブジェクトが Complete フェーズを報告する	オブジェクトが Canceled、Error、または Failed を報告する
  BuildConfig	関連付けられた最新のビルドオブジェクトが Complete フェーズを報告する	関連付けられた最新のビルドオブジェクトが Canceled、Error、または Failed を報告する
  Deployment	オブジェクトは、新しいレプリカセットとデプロイメントが利用可能であると報告する。これにより、オブジェクトで定義される readiness プローブが有効になります。	オブジェクトで、Progressing の状態が false であると報告される
  DeploymentConfig	オブジェクトは新規レプリケーションコントローラーおよびデプロイメントが利用可能であると報告する。これにより、オブジェクトで定義される readiness プローブが有効になります。	オブジェクトで、Progressing の状態が false であると報告される
  Job	オブジェクトが完了 (completion) を報告する	オブジェクトが 1 つ以上の失敗が発生したことを報告する
  StatefulSet	オブジェクトはすべてのレプリカが Ready であることを報告するこれにより、オブジェクトで定義される readiness プローブが有効になります。	該当なし

  以下は、テンプレートサンプルを一部抜粋したものです。この例では、wait-for-ready アノテーションが使用されています。他のサンプルは、OpenShift Container Platform クイックスタートテンプレートにあります。

  kind: Template
  apiVersion: template.openshift.io/v1
  metadata:
    name: my-template
  objects:
  - kind: BuildConfig
    apiVersion: build.openshift.io/v1
    metadata:
      name: ...
      annotations:
        # wait-for-ready used on BuildConfig ensures that creating resources from the template
        # fails immediately if the build fails
        template.alpha.openshift.io/wait-for-ready: "true"
    spec:
      ...
  - kind: DeploymentConfig
    apiVersion: apps.openshift.io/v1
    metadata:
      name: ...
      annotations:
        template.alpha.openshift.io/wait-for-ready: "true"
    spec:
      ...
  - kind: Service
    apiVersion: v1
    metadata:
      name: ...
    spec:
      ...

手順

• 以下のコマンドを実行してプロジェクトにオブジェクトをエクスポートします。

  $ oc get -o yaml all > <yaml_filename>

  all ではなく、特定のリソースタイプや複数のリソースを置き換えることも可能です。他の例は、oc get -h を実行してください。

  oc get -o yaml all に含まれるオブジェクトタイプは以下の通りです。

  • BuildConfig
  • Build
  • DeploymentConfig
  • ImageStream
  • Pod
  • ReplicationController
  • Route

  • Service

    注記

    コンテンツはクラスターやバージョンによって異なる可能性があるため、all エイリアスの使用は推奨されません。代わりに、必要なすべてのリソースを指定してください。