『Getting Started with Service Registry』

手順

1. インストール用のプロジェクトを作成します。たとえば、service-registry:

   oc new-project service-registry

2. {NAMESPACE} を service-registry に置き換えて、install/cluster_role_binding.yaml に namespace を設定します。

3. install/ フォルダーにあるファイルを適用します。

   oc apply -f install/ -n service-registry

手順

1. Operator がデプロイされている namespace に ApicurioRegistry カスタムリソース(CR)を作成します。

   oc apply -f ./examples/apicurioregistry_infinispan_cr.yaml -n service-registry

   Infinispan ストレージの CR の例

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "infinispan"
       infinispan:
         clusterName: "example-apicurioregistry"
         # ^ Optional

2. Service Registry Web コンソール用に自動作成されたルートにアクセスします。以下に例を示します。

   http://example-apicurioregistry.my-project.my-domain-name.com/

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。

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

   1. 左側のナビゲーションメニューで、Home > Project > Create Project とクリックします。
   2. プロジェクト名 (my-project など) を入力し、Create をクリックします。
3. 左側のナビゲーションメニューで、Operators > OperatorHub とクリックします。
4. Filter by keyword テキストボックスに registry を入力し、Red Hat Integration - Service Registry Operator を見つけます。
5. Operator に関する情報を読み、Install をクリックして Operator サブスクリプションページを表示します。

6. サブスクリプション設定を選択します。以下に例を示します。

   • Update Channel > 以下のチャンネルから 1 つ選択します。

     • ServiceRegistry-1: 1.1.0 および 1.0.1 などのマイナーおよびパッチの更新すべて。1.0.x へのインストールは自動的に 1.1.x にアップグレードされます。
     • ServiceRegistry -1.0: 1.0.1 および 1.0.2 などのパッチ更新のみ。1.0.x へのインストールは自動的に 1.1.x を無視します。
     • ServiceRegistry -1.1: 1.1.1 や 1.1.2 などのパッチ更新のみ。1.1.x へのインストールは自動的に 1.0.x を無視します。
   • Installation Mode > A specific namespace on the cluster > my-project
   • Approval Strategy > Manual
7. Install をクリックし、Operator が使用できるようになるまでしばらく待ちます。

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
2. Service Registry がインストールされている OpenShift プロジェクトに切り替えます。たとえば、Project ドロップダウンから、my-project を選択します。
3. 左側のナビゲーションメニューで、Operators > OperatorHub とクリックします。
4. Filter by keyword テキストボックスに AMQ Streams を入力し、Red Hat Integration - AMQ Streams を見つけます。
5. Operator に関する情報を読み、Install をクリックして Operator サブスクリプションページを表示します。

6. サブスクリプション設定を選択します。以下に例を示します。

   • Update Channel > amq-streams-1.5.x
   • Installation Mode > A specific namespace on the cluster > my-project
   • Approval Strategy > Manual
7. Install をクリックし、Operator が使用できるようになるまでしばらく待ちます。

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。

2. Kafka クラスターがまだ設定されていない場合は、AMQ Streams を使用して新しい Kafka クラスターを作成します。たとえば、OpenShift OperatorHub では以下を実行します。

   1. Installed Operators > Red Hat Integration - AMQ Streams の順にクリックします。
   2. Provided APIs > Kafka で Create Instance をクリックし、新しい Kafka クラスターを作成します。

   3. 適切にカスタムリソース定義を編集し、Create をクリックします。

      警告

      デフォルトの例では、3 つの Zookeeper ノード、および、ephemeral ストレージを持つ 3 つの Kafka ノードを持つクラスターが作成されます。この一時ストレージは開発およびテストにのみ適しており、実稼働には適していません。詳細は、『 Using AMQ Streams on OpenShift 』を参照してください。

3. クラスターの準備ができたら、Provided APIs > Kafka > my-cluster > YAML をクリックします。

4. status ブロックで、bootstrapServers 値のコピーを作成します。これは、後で ServiceRegistry をデプロイするために使用します。以下に例を示します。

   status:
     conditions:
     ...
     listeners:
       - addresses:
           - host: my-cluster-kafka-bootstrap.my-project.svc
             port: 9092
         bootstrapServers: 'my-cluster-kafka-bootstrap.my-project.svc:9092'
         type: plain
     ...

5. Kafka トピックを作成し、Service Registry アーティファクトを保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な storage-topic に変更します。

6. Kafka トピックを作成し、Service Registry のグローバル ID を保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な global-id-topic に変更します。
7. Installed Operators > Red Hat Integration - Service Registry > ApicurioRegistry > Create ApicurioRegistry とクリックします。

8. 次のカスタムリソース定義を貼り付けますが、前にコピーした bootstrapServers 値を使用します。

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "streams"
       streams:
         bootstrapServers: "my-cluster-kafka-bootstrap.my-project.svc:9092"

9. Create をクリックし、OpenShift で Service Registry ルートが作成されるまで待機します。

10. Networking > Route をクリックして、Service Registry Web コンソールの新規ルートにアクセスします。以下に例を示します。

    http://example-apicurioregistry.my-project.my-domain-name.com/

手順

1. OpenShift Web コンソールで Installed Operators をクリックし、AMQ Streams Operator の詳細を選択してから、Kafka タブをクリックします。
2. Create Kafka をクリックし、Service Registry ストレージの新しい Kafka クラスターをプロビジョニングします。

3. Kafka クラスターに TLS 認証を使用するように、 authorization フィールドと tls フィールドを設定します。次に例を示します。

   apiVersion: kafka.strimzi.io/v1beta1
   kind: Kafka
   metadata:
     name: my-cluster
     namespace: registry-example-streams-tls
   spec:
     kafka:
       authorization:
         type: simple
       version: 2.5.0
       replicas: 3
       listeners:
         plain: {}
         tls:
           authentication:
             type: tls
       config:
         offsets.topic.replication.factor: 3
         transaction.state.log.replication.factor: 3
         transaction.state.log.min.isr: 2
         log.message.format.version: '2.5'
       storage:
         type: ephemeral
     zookeeper:
       replicas: 3
       storage:
         type: ephemeral
     entityOperator:
       topicOperator: {}
       userOperator: {}

4. Kafka トピックを作成し、Service Registry アーティファクトを保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な storage-topic に変更します。

5. Kafka トピックを作成し、Service Registry のグローバル ID を保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な global-id-topic に変更します。

6. Kafka User リソースを作成し、Service Registry ユーザーの認証および承認を設定します。たとえば、spec ブロックでは metadata セクションにユーザー名を指定するか、デフォルトの my-user を使用できます。

   spec:
     authentication:
       type: tls
     authorization:
       acls:
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: topic
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: cluster
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: transactionalId
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: group
       type: simple

   注記

   Service Registry が必要とするトピックおよびリソースに合わせて承認を設定する必要があります。これは簡単な例です。

7. Workloads をクリックしてから Secrets をクリックし、Service Registry が Kafka クラスターに接続するために AMQ Stremas によって作成される 2 つのシークレットを見つけます。

   • my-cluster-cluster-ca-cert - Kafka クラスターの PKCS12 トラストストアが含まれています

   • my-user - ユーザーのキーストアが含まれます

     注記

     シークレットの名前は、クラスターまたはユーザー名によって異なります。

8. シークレットを手動で作成する場合は、以下のキーと値のペアを含める必要があります。

   • my-cluster-ca-cert

     • ca.p12 - PKCS12 形式のトラストストア
     • ca.password - truststore password

   • my-user

     • user.p12 - PKCS12 形式のキーストア
     • user.password - keystore password

9. Service Registry をデプロイするように、以下の設定例を設定します。

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "streams"
       streams:
         bootstrapServers: "my-cluster-kafka-bootstrap.registry-example-streams-tls.svc:9093"
         security:
           tls:
             keystoreSecretName: my-user
             truststoreSecretName: my-cluster-cluster-ca-cert

   重要

   プレーンでセキュアでないユースケースとは別の bootstrapServers アドレスを使用する必要があります。アドレスは TLS 接続をサポートする必要があり、指定された Kafka リソースの type:tls フィールドにあります。

手順

1. OpenShift Web コンソールで Installed Operators をクリックし、AMQ Streams Operator の詳細を選択してから、Kafka タブをクリックします。
2. Create Kafka をクリックし、Service Registry ストレージの新しい Kafka クラスターをプロビジョニングします。

3. Kafka クラスターに SCRAM-SHA-512 認証を使用するように、 authorization フィールドと tls フィールドを設定します。次に例を示します。

   apiVersion: kafka.strimzi.io/v1beta1
   kind: Kafka
   metadata:
     name: my-cluster
     namespace: registry-example-streams-tls
   spec:
     kafka:
       authorization:
         type: simple
       version: 2.5.0
       replicas: 3
       listeners:
         plain: {}
         tls:
           authentication:
             type: scram-sha-512
       config:
         offsets.topic.replication.factor: 3
         transaction.state.log.replication.factor: 3
         transaction.state.log.min.isr: 2
         log.message.format.version: '2.5'
       storage:
         type: ephemeral
     zookeeper:
       replicas: 3
       storage:
         type: ephemeral
     entityOperator:
       topicOperator: {}
       userOperator: {}

4. Kafka トピックを作成し、Service Registry アーティファクトを保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な storage-topic に変更します。

5. Kafka トピックを作成し、Service Registry のグローバル ID を保存します。

   1. Provided APIs > Kafka Topic で、Create topic をクリックします。
   2. デフォルトのトピック名を my-topic から必要な global-id-topic に変更します。

6. Kafka User リソースを作成し、Service Registry ユーザーの SCRAM 認証および承認を設定します。たとえば、spec ブロックは authentication セクションを参照してください。

   spec:
     authentication:
       type: scram-sha-512
     authorization:
       acls:
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: topic
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: cluster
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: transactionalId
         - operation: All
           resource:
             name: '*'
             patternType: literal
             type: group
       type: simple

7. Workloads をクリックしてから Secrets をクリックし、Service Registry が Kafka クラスターに接続するために AMQ Stremas によって作成される 2 つのシークレットを見つけます。

   • my-cluster-cluster-ca-cert - Kafka クラスターの PKCS12 トラストストアが含まれています

   • my-user - ユーザーのキーストアが含まれます

     注記

     シークレットの名前は、クラスターまたはユーザー名によって異なります。

8. シークレットを手動で作成する場合は、以下のキーと値のペアを含める必要があります。

   • my-cluster-ca-cert

     • ca.p12 -PKCS12 形式のトラストストア
     • ca.password - truststore password

   • my-user

     • パスワード - ユーザーパスワード

9. Service Registry をデプロイするように、以下の設定例を設定します。

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "streams"
       streams:
         bootstrapServers: "my-cluster-kafka-bootstrap.registry-example-streams-scram.svc:9093"
         security:
           scram:
             truststoreSecretName: my-cluster-cluster-ca-cert
             user: my-user
             passwordSecretName: my-user

   重要

   プレーンでセキュアでないユースケースとは別の bootstrapServers アドレスを使用する必要があります。アドレスは TLS 接続をサポートする必要があり、指定された Kafka リソースの type:tls フィールドにあります。

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
2. Service Registry がインストールされている OpenShift プロジェクトに切り替えます。たとえば、Project ドロップダウンから、my-project を選択します。
3. 左側のナビゲーションメニューで、Operators > OperatorHub とクリックします。
4. Filter by keyword テキストボックスに PostgreSQL と入力して、ご使用の環境に適した Operator を検索します。たとえば、Crunchy PostgreSQL for OpenShift や PostgreSQL Operator by Dev4Ddevs.com です。
5. Operator に関する情報を読み、Install をクリックして Operator サブスクリプションページを表示します。

6. サブスクリプション設定を選択します。以下に例を示します。

   • Update Channel > stable
   • Installation Mode > A specific namespace on the cluster > my-project
   • Approval Strategy > Manual

7. Install をクリックし、Operator が使用できるようになるまでしばらく待ちます。

   重要

   データベースの作成と管理方法の詳細については、選択したPostgreSQL Operator のドキュメントを読む必要があります。

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
2. Service Registry および PostgreSQL Operator がインストールされている OpenShift プロジェクトに切り替えます。たとえば、Project ドロップダウンから、my-project を選択します。
3. Service Registry ストレージの PostgreSQL データベースを作成します。たとえば、Installed Operators > PostgreSQL Operator by Dev4Ddevs.com > Create database > YAML とクリックします。

4. 以下のようにデータベース設定を編集します。

   • name: 値を registry に変更します
   • image: 値を centos/postgresql-10-centos7に変更します。

5. 実際の環境に応じて、必要に応じてその他のデータベース設定を編集します。以下に例を示します。

   apiVersion: postgresql.dev4devs.com/v1alpha1
   kind: Database
   metadata:
     name: registry
     namespace: my-project
   spec:
     databaseCpu: 30m
     databaseCpuLimit: 60m
     databaseMemoryLimit: 512Mi
     databaseMemoryRequest: 128Mi
     databaseName: example
     databaseNameKeyEnvVar: POSTGRESQL_DATABASE
     databasePassword: postgres
     databasePasswordKeyEnvVar: POSTGRESQL_PASSWORD
     databaseStorageRequest: 1Gi
     databaseUser: postgres
     databaseUserKeyEnvVar: POSTGRESQL_USER
     image: centos/postgresql-10-centos7
     size: 1

6. Create Database を クリックし、データベースが作成されるまで待ちます。
7. Installed Operators > Red Hat Integration - Service Registry > ApicurioRegistry > Create ApicurioRegistry とクリックします。

8. 以下のカスタムリソース定義に貼り付け、データベース url およびクレデンシャルの値を編集して環境と一致するようにします。

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "jpa"
       dataSource:
         url: "jdbc:postgresql://SERVICE_NAME.NAMESPACE.svc:5432/"
         # e.g. url: "jdbc:postgresql://acid-minimal-cluster.my-project.svc:5432/"
         userName: "postgres"
         password: "PASSWORD"
         # ^ Optional

9. Create をクリックし、OpenShift で Service Registry ルートが作成されるまで待機します。

10. Networking > Route をクリックして、Service Registry Web コンソールの新規ルートにアクセスします。以下に例を示します。

    http://example-apicurioregistry.my-project.my-domain-name.com/

手順

1. 以下のコマンドを入力して、データベースを作成します。

    $ createdb -T template0 dbname

2. 以下のコマンドを入力して SQL ダンプを復元します

    $ psql dbname < dumpfile

3. クエリーオプティマイザーが便利な統計を持つように、各データベースで ANALYZE を実行します。

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
2. Installed Operators > Red Hat Integration - Service Registry > ApicurioRegistry > Create ApicurioRegistry とクリックします。

3. 以下のカスタムリソース定義に貼り付けます。

   apiVersion: apicur.io/v1alpha1
   kind: ApicurioRegistry
   metadata:
     name: example-apicurioregistry
   spec:
     configuration:
       persistence: "infinispan"
       infinispan: # Currently uses embedded version of Infinispan
         clusterName: "example-apicurioregistry"
         # ^ Optional

4. Create をクリックし、OpenShift で Service Registry ルートが作成されるまで待機します。

5. Networking > Route をクリックして、Service Registry Web コンソールの新規ルートにアクセスします。以下に例を示します。

   http://example-apicurioregistry.my-project.my-domain-name.com/

手順

1. OpenShift Container Platform Web コンソールで、クラスター管理者権限を持つアカウントを使用してログインします。
2. Installed Operators > Red Hat Integration - Service Registry をクリックします。
3. ApicurioRegistry タブで、example-apicurioregistry などのデプロイメントの Operator カスタムリソースをクリックします。
4. メインの概要ページで、Deployment Name セクションと Service Registry デプロイメントの対応する DeploymentConfig 名を見つけます (例: example-apicurioregistry)。
5. 左側のナビゲーションメニューでWorkloads > Deployment Configs をクリックし、DeploymentConfig 名を選択します。

6. Environment タブをクリックして、Single values env セクションに環境変数を入力します。以下に例を示します。

   • NAME: LIVENESS_STATUS_RESET
   • VALUE: 350

7. 下部にある Save をクリックします。

   代わりに、OpenShift oc コマンドを使用して、これらの手順を実行することもできます。詳細は、OpenShift CLI のドキュメント を参照してください。

手順

1. 自己署名証明書を使用して keystore を生成します。独自の証明書を使用している場合は、この手順を省略できます。

   keytool -genkey -trustcacerts -keyalg RSA -keystore registry-keystore.jks -storepass password

2. キーストアおよびキーストアのパスワードを保持する新しいシークレットを作成します。

   1. OpenShift Web コンソールの左側のナビゲーションメニューで、Workloads > Secrets > Create Key/Value Secret とクリックします。

   2. 次の値を使用します。
      

      • 名前： registry-keystore
        
      • キー 1: keystore.jks
        
      • 値 1: registry-keystore.jks （アップロードしたファイル）
        
      • キー 2: パスワード
        

      • 値 2: パスワード

        注記

        java.io.IOException: Invalid keystore format が発生した場合、バイナリーファイルのアップロードは正しく機能しませんでした。別の方法として、cat registry-keystore.jks | base64 -w0 > data.txt を使用してファイルを base64 文字列にエンコードし、yaml として Secret リソースを編集してエンコードされたファイルを手動で追加してください。

3. Service Registry インスタンスの DeploymentConfig リソースを編集します。Service Registry Operator の status フィールドで正しい名前を見つけることができます。

   1. キーストアシークレットをボリュームとして追加します。

      template:
        spec:
          volumes:
          - name: registry-keystore-secret-volume
            secret:
            secretName: registry-keystore

   2. ボリュームマウントを追加します。

      volumeMounts:
        - name: registry-keystore-secret-volume
          mountPath: /etc/registry-keystore
          readOnly: true

   3. JAVA_OPTIONS および KEYSTORE_PASSWORD 環境変数を追加します。

      - name: KEYSTORE_PASSWORD
        valueFrom:
          secretKeyRef:
            name: registry-keystore
            key: password
      - name: JAVA_OPTIONS
          value: >-
           -Dquarkus.http.ssl.certificate.key-store-file=/etc/registry-keystore/keystore.jks
           -Dquarkus.http.ssl.certificate.key-store-file-type=jks
           -Dquarkus.http.ssl.certificate.key-store-password=$(KEYSTORE_PASSWORD)

      注記

      順序は、文字列の補間を使用する場合に重要です。

   4. HTTPS ポートを有効にします。

      ports:
        - containerPort: 8080
          protocol: TCP
        - containerPort: 8443
          protocol: TCP

4. Service Registry インスタンスの Service リソースを編集します。Service Registry Operator の status フィールドで正しい名前を見つけることができます。

   ports:
     - name: http
       protocol: TCP
       port: 8080
       targetPort: 8080
     - name: https
       protocol: TCP
       port: 8443
       targetPort: 8443

5. 接続が機能していることを確認します。

   1. SSH を使用してクラスターの Pod に接続します (Service Registry Pod を使用できます)。

      oc rsh -n default example-apicurioregistry-deployment-vx28s-4-lmtqb

   2. Serviceリソースから Service Registry Pod のクラスター IP を見つけます (Web コンソールの Location 列を参照)。

   3. その後、テスト要求を実行します (自己署名証明書を使用するので、セキュアでないフラグが必要になります)。

      curl -k https://172.30.209.198:8443/health
      [...]

手順

1. Service Registry Web コンソールに接続します。

   http://MY_REGISTRY_URL/ui

2. Upload Artifact をクリックし、以下を指定します。

   • id: デフォルトの空の設定を使用して ID を自動的に生成するか、特定のアーティファクト ID を入力します。

   • Type: デフォルトの Auto-Detect 設定を使用してアーティファクトタイプを自動的に検出し、ドロップダウンからアーティファクトタイプを選択します (例: Avro Schema または OpenAPI)。

     注記

     Service Registry サーバーは、Kafka Connect スキーマアーティファクトタイプを自動的に検出できません。このアーティファクトタイプを手動で選択する必要があります。

   • Artifact: ドラッグアンドドロップまたは Browse をクリックして、 my-schema.json や my-openapi.json などのファイルをアップロードします。

3. Upload をクリックし、Artifact Details を表示します。

   図9.1 Service Registry Web コンソールのアーティファクトの詳細

   
   • info: アーティファクト名、説明、ライフサイクルのステータス、作成時、および最終更新時を表示します。Edit Artifact Metadata 鉛筆アイコンをクリックしてアーティファクト名と説明を編集するか、またはラベルを追加し、Download をクリックしてアーティファクトファイルをローカルにダウンロードできます。また、有効化および設定できるアーティファクトコンテンツルールも表示します。
   • ドキュメント (OpenAPI のみ): 自動生成される REST API ドキュメントを表示します。
   • Content: 全アーティファクトコンテンツの読み取り専用ビューを表示します。
4. Content Rules で Enable をクリックして Validity Rule または Compatibility Rule を設定し、ドロップダウンから適切なルール設定を選択します。詳細は 14章Service Registry アーティファクトの参照 を参照してください。
5. Upload new version をクリックして新しいアーティファクトバージョンを追加し、ドラッグアンドドロップまたは Browse をクリックしてファイル (my-schema.json や my-openapi.json など) をアップロードします。

6. アーティファクトを削除するには、Upload new versio の横にあるゴミ箱アイコンをクリックします。

   警告

   アーティファクトを削除すると、アーティファクトとそのバージョンがすべて削除され、元に戻すことはできません。アーティファクトバージョンはイミュータブルで、個別に削除できません。

手順

1. Service Registry Web コンソールに接続します。

   http://MY_REGISTRY_URL/ui

2. レジストリーに保存されているアーティファクト一覧を参照するか、検索文字列を入力してアーティファクトを検索します。特定の Name、Description、Label、または Everything で検索できます。

   図9.2 Service Registry Web コンソールでのアーティファクトの閲覧

   

3. View artifact をクリックして Artifact Details を表示します。

   • info: アーティファクト名、説明、ライフサイクルのステータス、作成時、および最終更新時を表示します。Edit Artifact Metadata 鉛筆アイコンをクリックしてアーティファクト名と説明を編集するか、またはラベルを追加し、Download をクリックしてアーティファクトファイルをローカルにダウンロードできます。また、有効化および設定できるアーティファクトコンテンツルールも表示します。
   • ドキュメント (OpenAPI のみ): 自動生成される REST API ドキュメントを表示します。
   • Content: 全アーティファクトコンテンツの読み取り専用ビューを表示します。
4. 追加バージョンが追加されている場合は、ドロップダウンから異なるアーティファクトVersion を表示します。

手順

1. Service Registry Web コンソールに接続します。

   http://MY_REGISTRY_URL/ui

2. アーティファクトルールの場合、レジストリーに保存されているアーティファクト一覧を参照するか、検索文字列を入力してアーティファクトを検索します。特定のアーティファクト Name、Description、Label、または Everything で検索できます。
3. View artifact をクリックして Artifact Details を表示します。

4. Content Rules で Enable をクリックしてアーティファクトの 有効性ルールまたは 互換性ルールを設定し、ドロップダウンから適切なルール設定を選択します。詳細は 14章Service Registry アーティファクトの参照 を参照してください。

   図9.3 Service Registry Web コンソールでのコンテンツルールの設定

   
5. グローバルルールの場合は、ツールバーの右上の Settings cog アイコンをクリックし、Enable をクリックしてグローバル Validity Rule または Compatibility Rule を設定し、ドロップダウンから適切なルール設定を選択します。詳細は 14章Service Registry アーティファクトの参照 を参照してください。
6. アーティファクトルールまたはグローバルルールを無効にするには、ルールの横にあるゴミ箱アイコンをクリックします。

手順

1. /artifacts 操作を使用して、レジストリーにアーティファクトを追加します。以下の curl コマンドの例は、株価アプリケーションの単純なアーティファクトを追加します。

   $ curl -X POST -H "Content-type: application/json; artifactType=AVRO" -H "X-Registry-ArtifactId: share-price" --data '{"type":"record","name":"price","namespace":"com.example","fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}' http://MY-REGISTRY-HOST/api/artifacts

   以下の例では、共有価格 のアーティファクト ID を持つ Avro スキーマアーティファクトを追加する方法を示します。

   MY-REGISTRY-HOST は、Service Registry がデプロイされているホスト名です。例: my-cluster-service-registry-myproject.example.com。

2. 応答に、アーティファクトが追加されたことを確認するために、想定される JSON ボディーが含まれていることを確認します。以下に例を示します。

   {"createdOn":1578310374517,"modifiedOn":1578310374517,"id":"share-price","version":1,"type":"AVRO","globalId":8}

3. アーティファクト ID を使用してレジストリーからアーティファクトを取得します。たとえば、この場合は、指定の ID が share-price になります。

   $ curl http://MY-REGISTRY-URL/api/artifacts/share-price
   '{"type":"record","name":"price","namespace":"com.example","fields":[{"name":"symbol","type":"string"},{"name":"price","type":"string"}]}

手順

1. 以下の依存関係を Maven プロジェクトに追加します。

   <dependency>
       <groupId>io.apicurio</groupId>
       <artifactId>apicurio-registry-rest-client</artifactId>
       <version>${apicurio-registry.version}</version>
   </dependency>

2. 以下のようにレジストリークライアントを作成します。

   public class ClientExample {
   
       private static final RegistryRestClient client;
   
        public static void main(String[] args) throws Exception {
           // Create a registry client
           String registryUrl = "https://registry.my-domain.com/api"; 1
           RegistryRestClient client = RegistryRestClientFactory.create(registryUrl); 2
       }
   }

   1

   /api エンドポイントで Service Registry URL を指定する必要があります。

   2

   Service Registry クライアント作成時の他のオプションは、次のセクションの Java クライアント設定を参照してください。

3. クライアントが作成されると、クライアントを介して Service Registry REST API からのすべての操作を使用することができます。詳細は、Apicurio Registry REST API のドキュメント を参照してください。

手順

1. Service Registry の URL でクライアントを設定します。以下に例を示します。

   String registryUrl = "https://registry.example.com/api";
   Properties props = new Properties();
   props.putIfAbsent(AbstractKafkaSerDe.REGISTRY_URL_CONFIG_PARAM, registryUrl);

2. Service Registry デシリアライザーでクライアントを設定します。以下に例を示します。

   // Configure Kafka
   props.putIfAbsent(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, SERVERS);
   props.putIfAbsent(ConsumerConfig.GROUP_ID_CONFIG, "Consumer-" + TOPIC_NAME);
   props.putIfAbsent(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "true");
   props.putIfAbsent(ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG, "1000");
   props.putIfAbsent(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
   props.putIfAbsent(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG,
       AvroKafkaDeserializer.class.getName()); 1
   props.putIfAbsent(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG,
       AvroKafkaDeserializer.class.getName()); 2

   1

   Service Registry によって提供されるデシリアライザー。

   2

   デシリアライズは Apache Avro JSON 形式です。

手順

1. Service Registry の URL でクライアントを設定します。以下に例を示します。

   String registryUrl = "https://registry.example.com/api";
   Properties props = new Properties();
   props.putIfAbsent(AbstractKafkaSerDe.REGISTRY_URL_CONFIG_PARAM, registryUrl);

2. クライアントをシリアライザーで設定し、Service Registry でスキーマを検索するようにストラテジーを設定します。以下に例を示します。

   props.put(CommonClientConfigs.BOOTSTRAP_SERVERS_CONFIG, "my-cluster-kafka-bootstrap:9092");
   props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, AvroKafkaSerializer.class.getName()); 1
   props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, AvroKafkaSerializer.class.getName()); 2
   props.put(AbstractKafkaSerializer.REGISTRY_GLOBAL_ID_STRATEGY_CONFIG_PARAM, FindLatestIdStrategy.class.getName()); 3

   1

   Service Registry により提供されるメッセージキーのシリアライザー。

   2

   Service Registry により提供されるメッセージ値のシリアライザー。

   3

   スキーマのグローバル ID を検索する検索ストラテジー。

手順

1. Service Registry で REST クライアントを作成および設定します。以下に例を示します。

   String registryUrl = "https://registry.example.com/api";
   RegistryService client = RegistryClient.cached(registryUrl);

2. シリアライザー、デシリアライザーの設定、および Kafka Streams クライアントを作成します。以下に例を示します。

   Serializer<LogInput> serializer = new AvroKafkaSerializer<>( 1
       client,
       new DefaultAvroDatumProvider<LogInput>().setUseSpecificAvroReader(true)
   );
   Deserializer<LogInput> deserializer = new AvroKafkaDeserializer <> ( 2
       client,
       new DefaultAvroDatumProvider<LogInput>().setUseSpecificAvroReader(true)
   );
   Serde<LogInput> logSerde = Serdes.serdeFrom( 3
       serializer,
       deserializer
   );
   KStream<String, LogInput> input = builder.stream( 4
       INPUT_TOPIC,
       Consumed.with(Serdes.String(), logSerde)
   );

   1

   Service Registry によって提供されるシリアライザー。

   2

   Service Registry によって提供されるデシリアライザー。

   3

   デシリアライズは Apache Avro 形式です。

   4

   Kafka Streams クライアントアプリケーション。