第8章 AMQ Streams のアップグレード

手順

1. convert-file コマンドおよび適切なフラグで、API 変換ツールを実行します。

   例 1: YAML ファイルを変換し、出力を表示しますが、ファイルは変更されません。

   bin/api-conversion.sh convert-file --file input.yaml

   例 2: YAML ファイルを変換し、変更を元のソースファイルに書き込みます。

   bin/api-conversion.sh convert-file --file input.yaml --in-place

   例 3: YAML ファイルを変換し、変更を新しい出力ファイルに書き込みます。

   bin/api-conversion.sh convert-file --file input.yaml --output output.yaml

2. 変換した設定ファイルを使用して、カスタムリソースを更新します。

   oc apply -f CONVERTED-CONFIG-FILE

3. カスタムリソースが変換されたことを確認します。

   oc get KIND CUSTOM-RESOURCE-NAME -o yaml

手順

1. convert-resource コマンドおよび適切なフラグで、API 変換ツールを実行します。

   例 1: 現在の namespace のすべての AMQ Streams リソースを変換します。

   bin/api-conversion.sh convert-resource

   例 2: すべての namespace のすべての AMQ Streams リソースを変換します。

   bin/api-conversion.sh convert-resource --all-namespaces

   例 3: my-kafka namespace のすべての AMQ Streams リソースを変換します。

   bin/api-conversion.sh convert-resource --namespace my-kafka

   例 4: すべての namespace の Kafka リソースのみを変換します。

   bin/api-conversion.sh convert-resource --all-namespaces --kind Kafka

   例 5: すべての namespace の Kafka および Kafka Connect リソースを変換します。

   bin/api-conversion.sh convert-resource --all-namespaces --kind Kafka --kind KafkaConnect

   例 6: my-kafka namespace の my-cluster という名前の Kafka カスタムリソースを変換します。

   bin/api-conversion.sh convert-resource --kind Kafka --namespace my-kafka --name my-cluster

2. カスタムリソースが変換されたことを確認します。

   oc get KIND CUSTOM-RESOURCE-NAME -o yaml

手順

1. v1beta2 を使用するようにカスタムリソースを変換していない場合は、そのように変換します。

   これは、API 変換ツールを使用して、以下のいずれかの方法で行います。

   • 「API 変換ツールを使用したカスタムリソース設定ファイルの変換」

   • 「API 変換ツールを使用したカスタムリソースの直接変換」

     また、手動で変更することもできます。

2. crd-upgrade コマンドを使用して、API 変換ツールを実行します。

   bin/api-conversion.sh crd-upgrade

3. CRD がアップグレードされ、v1beta2 がストレージバージョンであることを確認します。

   たとえば、Kafka トピック CRD の場合は次のとおりです。

   apiVersion: kafka.strimzi.io/v1beta2
   kind: CustomResourceDefinition
   metadata:
     name: kafkatopics.kafka.strimzi.io
     #...
   spec:
     group: kafka.strimzi.io
     #...
     versions:
     - name: v1beta2
       served: true
       storage: true
       #...
   status:
     #...
     storedVersions:
     - v1beta2

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. .spec.kafka.listener を新しい汎用リスナー形式に更新していない場合は、「リスナーの汎用リスナー設定への更新」 の説明に従って更新します。

   警告

   API バージョン v1beta2 では、古いリスナーの形式はサポートされません。

3. affinity が .spec.kafka.affinity に存在する場合は .spec.kafka.template.pod.affinity に移動します。
4. tolerations が .spec.kafka.tolerations に存在する場合は .spec.kafka.template.pod.tolerations に移動します。
5. .spec.kafka.template.tlsSidecarContainer が存在する場合は削除します。
6. .spec.kafka.tlsSidecarContainer が存在する場合は削除します。

7. 以下のポリシー設定のいずれかが存在する場合:

   • .spec.kafka.template.externalBootstrapService.externalTrafficPolicy

   • .spec.kafka.template.perPodService.externalTrafficPolicy

     1. type: loadbalancer および type: nodeport リスナー両方の設定を .spec.kafka.listeners[].configuration.externalTrafficPolicy に移動します。
     2. .spec.kafka.template.externalBootstrapService.externalTrafficPolicy または .spec.kafka.template.perPodService.externalTrafficPolicy を削除します。

8. 以下の loadbalancer リスナー設定のいずれかが存在する場合:

   • .spec.kafka.template.externalBootstrapService.loadBalancerSourceRanges

   • .spec.kafka.template.perPodService.loadBalancerSourceRanges

     1. type: loadbalancer リスナーの設定を .spec.kafka.listeners[].configuration.loadBalancerSourceRanges に移動します。
     2. .spec.kafka.template.externalBootstrapService.loadBalancerSourceRanges または .spec.kafka.template.perPodService.loadBalancerSourceRanges を削除します。

9. type: external ロギングが .spec.kafka.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

10. .spec.kafka.metrics フィールドを使用してメトリクスを有効にする場合:

    1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.kafka.metrics フィールドの内容と一致している必要があります。

       kind: ConfigMap
       apiVersion: v1
       metadata:
         name: kafka-metrics
         labels:
           app: strimzi
       data:
         kafka-metrics-config.yaml: |
             <YAML>

    2. ConfigMap およびキーを示す .spec.kafka.metricsConfig プロパティーを追加します。

       metricsConfig:
         type: jmxPrometheusExporter
         valueFrom:
           configMapKeyRef:
             name: kafka-metrics
             key: kafka-metrics-config.yaml

    3. 古い .spec.kafka.metrics フィールドを削除します。
11. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. affinity が .spec.zookeeper.affinity に存在する場合は .spec.zookeeper.template.pod.affinity に移動します。
3. tolerations が .spec.zookeeper.tolerations に存在する場合は .spec.zookeeper.template.pod.tolerations に移動します。
4. .spec.zookeeper.template.tlsSidecarContainer が存在する場合は削除します。
5. .spec.zookeeper.tlsSidecarContainer が存在する場合は削除します。

6. type: external ロギングが .spec.kafka.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

7. .spec.zookeeper.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.zookeeper.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-metrics
        labels:
          app: strimzi
      data:
        zookeeper-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.zookeeper.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-metrics
            key: zookeeper-metrics-config.yaml

   3. 古い .spec.zookeeper.metrics フィールドを削除します。
8. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. Kafka.spec.topicOperator を使用する場合:

   1. affinity を .spec.topicOperator.affinity から .spec.entityOperator.template.pod.affinity に移動します。
   2. tolerations を .spec.topicOperator.tolerations から .spec.entityOperator.template.pod.tolerations に移動します。
   3. .spec.topicOperator.tlsSidecar を .spec.entityOperator.tlsSidecar に移動します。
   4. affinity、tolerations、および tlsSidecar の移動後に、.spec.topicOperator の残りの設定を .spec.entityOperator.topicOperator に移動します。

3. type: external ロギングが .spec.topicOperator.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j2.properties

   注記

   このステップは、Entity Operator のアップグレード の一部として完了することもできます。

4. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. affinity を .spec.entityOperator.affinity から .spec.entityOperator.template.pod.affinity に移動します。
3. tolerations を .spec.entityOperator.tolerations から .spec.entityOperator.template.pod.tolerations に移動します。

4. type: external ロギングが .spec.entityOperator.userOperator.logging または .spec.entityOperator.topicOperator.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j2.properties

5. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. type: external ロギングが .spec.cruiseControl.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j2.properties

3. .spec.cruiseControl.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.cruiseControl.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-metrics
        labels:
          app: strimzi
      data:
        cruise-control-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.cruiseControl.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-metrics
            key: cruise-control-metrics-config.yaml

   3. 古い .spec.cruiseControl.metrics フィールドを削除します。
4. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで Kafka カスタムリソースを更新します。

   oc edit kafka KAFKA-CLUSTER

2. Kafka カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

3. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaConnect カスタムリソースを更新します。

   oc edit kafkaconnect KAFKA-CONNECT-CLUSTER

2. 以下があるか確認します。

   KafkaConnect.spec.affinity

   KafkaConnect.spec.tolerations

   あれば以下に変更します。

   KafkaConnect.spec.template.pod.affinity

   KafkaConnect.spec.template.pod.tolerations

   たとえば、以下の場合を考えてみましょう。

   spec:
     # ...
     affinity:
       # ...
     tolerations:
       # ...

   これを以下に変更します。

   spec:
     # ...
     template:
       pod:
         affinity:
           # ...
         tolerations:
           # ...

3. type: external ロギングが .spec.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

4. .spec.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-connect-metrics
        labels:
          app: strimzi
      data:
        connect-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-connect-metrics
            key: connect-metrics-config.yaml

   3. 古い .spec.metrics フィールドを削除します。

5. KafkaConnect カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

6. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaConnectS2I カスタムリソースを更新します。

   oc edit kafkaconnects2i S2I-CLUSTER

2. 以下があるか確認します。

   KafkaConnectS2I.spec.affinity

   KafkaConnectS2I.spec.tolerations

   あれば以下に変更します。

   KafkaConnectS2I.spec.template.pod.affinity

   KafkaConnectS2I.spec.template.pod.tolerations

   たとえば、以下の場合を考えてみましょう。

   spec:
     # ...
     affinity:
       # ...
     tolerations:
       # ...

   これを以下に変更します。

   spec:
     # ...
     template:
       pod:
         affinity:
           # ...
         tolerations:
           # ...

3. type: external ロギングが .spec.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

4. .spec.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-connect-s2i-metrics
        labels:
          app: strimzi
      data:
        connect-s2i-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-connect-s2i-metrics
            key: connect-s2i-metrics-config.yaml

   3. 古い .spec.metrics フィールドを削除します。

5. KafkaConnectS2I カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

6. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaMirrorMaker カスタムリソースを更新します。

   oc edit kafkamirrormaker MIRROR-MAKER

2. 以下があるか確認します。

   KafkaMirrorMaker.spec.affinity

   KafkaMirrorMaker.spec.tolerations

   あれば以下に変更します。

   KafkaMirrorMaker.spec.template.pod.affinity

   KafkaMirrorMaker.spec.template.pod.tolerations

   たとえば、以下の場合を考えてみましょう。

   spec:
     # ...
     affinity:
       # ...
     tolerations:
       # ...

   これを以下に変更します。

   spec:
     # ...
     template:
       pod:
         affinity:
           # ...
         tolerations:
           # ...

3. type: external ロギングが .spec.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

4. .spec.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-mm-metrics
        labels:
          app: strimzi
      data:
        mm-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-mm-metrics
            key: mm-metrics-config.yaml

   3. 古い .spec.metrics フィールドを削除します。

5. KafkaMirrorMaker カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

6. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaMirrorMaker2 カスタムリソースを更新します。

   oc edit kafkamirrormaker2 MIRROR-MAKER-2

2. affinity が .spec.affinity に存在する場合は .spec.template.pod.affinity に移動します。
3. tolerations が .spec.tolerations に存在する場合は .spec.template.pod.tolerations に移動します。

4. type: external ロギングが .spec.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j.properties

5. .spec.metrics フィールドを使用してメトリクスを有効にする場合:

   1. JMX Prometheus エクスポーターの YAML 設定をキーの下に保存する新しい ConfigMap を作成します。YAML は .spec.metrics フィールドの内容と一致している必要があります。

      kind: ConfigMap
      apiVersion: v1
      metadata:
        name: kafka-mm2-metrics
        labels:
          app: strimzi
      data:
        mm2-metrics-config.yaml: |
            <YAML>

   2. ConfigMap およびキーを示す .spec.metricsConfig プロパティーを追加します。

      metricsConfig:
        type: jmxPrometheusExporter
        valueFrom:
          configMapKeyRef:
            name: kafka-mm2-metrics
            key: mm2-metrics-config.yaml

   3. 古い .spec.metrics フィールドを削除します。

6. KafkaMirrorMaker2 カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1alpha1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

7. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaBridge カスタムリソースを更新します。

   oc edit kafkabridge KAFKA-BRIDGE

2. type: external ロギングが KafkaBridge.spec.logging で設定されている場合:

   ロギング設定が含まれる ConfigMap の name を置き換えます。

   logging:
     type: external
     name: my-config-map

   valueFrom.configMapKeyRef フィールドで、ログ保存される ConfigMap の name および key の両方を指定します。

   logging:
     type: external
     valueFrom:
       configMapKeyRef:
         name: my-config-map
         key: log4j2.properties

3. KafkaBridge カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1alpha1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

4. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaUser カスタムリソースを更新します。

   oc edit kafkauser KAFKA-USER

2. KafkaUser カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

3. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaTopic カスタムリソースを更新します。

   oc edit kafkatopic KAFKA-TOPIC

2. KafkaTopic カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1beta1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

3. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaConnector カスタムリソースを更新します。

   oc edit kafkaconnector KAFKA-CONNECTOR

2. KafkaConnector カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1alpha1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

3. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。

1. エディターで KafkaRebalance カスタムリソースを更新します。

   oc edit kafkarebalance KAFKA-REBALANCE

2. KafkaRebalance カスタムリソースの apiVersion を v1beta2 に更新します。

   以下の行を見つけます。

   apiVersion: kafka.strimzi.io/v1alpha1

   この行を以下の行に変更します。

   apiVersion: kafka.strimzi.io/v1beta2

3. ファイルを保存し、エディターを終了して更新したカスタムリソースが調整されるのを待ちます。