第7章 Knative CLI

前提条件

• OpenShift Serverless Operator および Knative Serving がクラスターにインストールされていること。
• Knative (kn) CLI をインストールしている。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

• Knative サービスを作成します。

  $ kn service create <service-name> --image <image> --tag <tag-value>

  詳細は以下のようになります。

  • --image は、アプリケーションのイメージの URI です。

  • --tag は、サービスで作成される初期リビジョンにタグを追加するために使用できるオプションのフラグです。

    コマンドの例

    $ kn service create event-display \
        --image quay.io/openshift-knative/knative-eventing-sources-event-display:latest

    出力例

    Creating service 'event-display' in namespace 'default':
    
      0.271s The Route is still working to reflect the latest desired specification.
      0.580s Configuration "event-display" is waiting for a Revision to become ready.
      3.857s ...
      3.861s Ingress has not yet been reconciled.
      4.270s Ready to serve.
    
    Service 'event-display' created with latest revision 'event-display-bxshg-1' and URL:
    http://event-display-default.apps-crc.testing

コマンドの例

• 新規の環境変数を追加してサービスを更新します。

  $ kn service update <service_name> --env <key>=<value>

• 新しいポートを追加してサービスを更新します。

  $ kn service update <service_name> --port 80

• 新しい要求および制限パラメーターを追加してサービスを更新します。

  $ kn service update <service_name> --request cpu=500m --limit memory=1024Mi --limit cpu=1000m

• latest タグをリビジョンに割り当てます。

  $ kn service update <service_name> --tag <revision_name>=latest

• サービスの最新の READY リビジョンについて、testing から staging にタグを更新します。

  $ kn service update <service_name> --untag testing --tag @latest=staging

• test タグをトラフィックの 10% を受信するリビジョンに追加し、残りのトラフィックをサービスの最新の READY リビジョンに送信します。

  $ kn service update <service_name> --tag <revision_name>=test --traffic test=10,@latest=90

コマンドの例

• サービスを作成します。

  $ kn service apply <service_name> --image <image>

• 環境変数をサービスに追加します。

  $ kn service apply <service_name> --image <image> --env <key>=<value>

• JSON または YAML ファイルからサービス宣言を読み取ります。

  $ kn service apply <service_name> -f <filename>

コマンドの例

• サービスを記述します。

  $ kn service describe --verbose <service_name>

  --verbose フラグは任意ですが、さらに詳細な説明を提供するために追加できます。通常の出力と詳細の出力の違いについては、以下の例に示されます。

  --verbose フラグを使用しない出力例

  Name:       hello
  Namespace:  default
  Age:        2m
  URL:        http://hello-default.apps.ocp.example.com
  
  Revisions:
    100%  @latest (hello-00001) [1] (2m)
          Image:  docker.io/openshift/hello-openshift (pinned to aaea76)
  
  Conditions:
    OK TYPE                   AGE REASON
    ++ Ready                   1m
    ++ ConfigurationsReady     1m
    ++ RoutesReady             1m

  --verbose フラグを使用する出力例

  Name:         hello
  Namespace:    default
  Annotations:  serving.knative.dev/creator=system:admin
                serving.knative.dev/lastModifier=system:admin
  Age:          3m
  URL:          http://hello-default.apps.ocp.example.com
  Cluster:      http://hello.default.svc.cluster.local
  
  Revisions:
    100%  @latest (hello-00001) [1] (3m)
          Image:  docker.io/openshift/hello-openshift (pinned to aaea76)
          Env:    RESPONSE=Hello Serverless!
  
  Conditions:
    OK TYPE                   AGE REASON
    ++ Ready                   3m
    ++ ConfigurationsReady     3m
    ++ RoutesReady             3m

• サービスを YAML 形式で記述します。

  $ kn service describe <service_name> -o yaml

• サービスを JSON 形式で記述します。

  $ kn service describe <service_name> -o json

• サービス URL のみを出力します。

  $ kn service describe <service_name> -o url

• 記述子ファイルを使用してクラスターで変更する前に、記述子ファイルを手動で変更できます。
• バージョン管理システムでは、サービスの記述子ファイルをローカルで追跡できます。これにより、記述子ファイルを再利用できます。たとえば、継続的インテグレーション (CI) パイプライン、開発環境またはデモなどで、ターゲットクラスター以外の配置が可能になります。
• 作成した記述子ファイルを検証して Knative サービスについて確認できます。特に、生成されるサービスが kn コマンドに渡されるさまざまな引数によってどのように影響するかを確認できます。

前提条件

• OpenShift Serverless Operator および Knative Serving がクラスターにインストールされていること。
• Knative (kn) CLI をインストールしている。

• イメージからコンテナーを追加し、標準出力に出力します。

  $ kn container add <container_name> --image <image_uri>

  コマンドの例

  $ kn container add sidecar --image docker.io/example/sidecar

  出力例

  containers:
  - image: docker.io/example/sidecar
    name: sidecar
    resources: {}

• 2 つの kn container add コマンドを連結してから、kn service create コマンドに渡して、2 つのコンテナーで Knative サービスを作成します。

  $ kn container add <first_container_name> --image <image_uri> | \
  kn container add <second_container_name> --image <image_uri> | \
  kn service create <service_name> --image <image_uri> --extra-containers -

  --extra-containers - は、kn が YAML ファイルの代わりにパイプ入力を読み取る特別なケースを指定します。

  コマンドの例

  $ kn container add sidecar --image docker.io/example/sidecar:first | \
  kn container add second --image docker.io/example/sidecar:second | \
  kn service create my-service --image docker.io/example/my-app:latest --extra-containers -

  --extra-containers フラグは YAML ファイルへのパスを受け入れることもできます。

  $ kn service create <service_name> --image <image_uri> --extra-containers <filename>

  コマンドの例

  $ kn service create my-service --image docker.io/example/my-app:latest --extra-containers my-extra-containers.yaml

前提条件

• OpenShift Serverless Operator および Knative Serving がクラスターにインストールされている。

• Knative サービスまたはルートを作成し、その CR にマップするカスタムドメインを制御している。

  注記

  カスタムドメインは OpenShift Container Platform クラスターの DNS を参照する必要があります。

• Knative (kn) CLI をインストールしている。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

• ドメインを現在の namespace の CR にマップします。

  $ kn domain create <domain_mapping_name> --ref <target_name>

  コマンドの例

  $ kn domain create example-domain-map --ref example-service

  --ref フラグは、ドメインマッピング用のアドレス指定可能なターゲット CR を指定します。

  --ref フラグの使用時に接頭辞が指定されていない場合、ターゲットが現在の namespace の Knative サービスであることを前提としています。

• ドメインを指定された namespace の Knative サービスにマップします。

  $ kn domain create <domain_mapping_name> --ref <ksvc:service_name:service_namespace>

  コマンドの例

  $ kn domain create example-domain-map --ref ksvc:example-service:example-namespace

• ドメインを Knative ルートにマップします。

  $ kn domain create <domain_mapping_name> --ref <kroute:route_name>

  コマンドの例

  $ kn domain create example-domain-map --ref kroute:example-route

前提条件

• OpenShift Serverless Operator および Knative Serving がクラスターにインストールされている。
• 1 つ以上の DomainMapping CR を作成している。
• Knative (kn) CLI ツールをインストールしている。
• OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

• 既存の DomainMapping CR を一覧表示します。

  $ kn domain list -n <domain_mapping_namespace>

• 既存の DomainMapping CR の詳細を表示します。

  $ kn domain describe <domain_mapping_name>

• 新規ターゲットを参照するように DomainMapping CR を更新します。

  $ kn domain update --ref <target>

• DomainMapping CR を削除します。

  $ kn domain delete <domain_mapping_name>