externalServices パラメーター

Cassandra、 Elasticsearch、 Kafka などの外部サービスを設定するには、 externalServices を使用する。

以下のYAMLファイルは、外部サービス Cassandra、 Elasticsearch、 Kafka のサンプルスキーマです。
  externalServices:
    cassandra:
      # iv_keyspace: ""
      # cas_keyspace: ""
      # promising_keyspace: ""
      # filex_keyspace: ""
      # lifecycle_manager_keyspace: ""
      # contactPoints: ""
      # createDevInstance:
        # affinityAndTolerations: ""
        # resources:
          # limits:
            # cpu: '2'
            # memory:9Gi
          # requests:
            # cpu: '1'
            # memory: 3Gi        
        # storage:
          # name: ""
          # accessMode: ReadWriteMany
          # capacity: 10Gi
          # storageClassName: default
          # securityContext:
            # fsGroup: 
            # supplementalGroups: []   
    kafka:
      # contactPoints: ""
      # topicPrefix: "sip"
      # mirrorTopicPrefix: ""
      # crossDCTopicPrefix: ""     
      # loggingContactPoints: ""
      # createDevInstance:
        # affinityAndTolerations: ""
        # resources:
          # limits:
            # cpu: '1'
            # memory: 1Gi
          # requests:
            # cpu: '0.1'
            # memory: 1.5Gi
        # storage:
          # name: ""
          # accessMode: ReadWriteMany
          # capacity: 10Gi
          # storageClassName: default
          # securityContext:
            # fsGroup: 
            # supplementalGroups: []  
    elasticSearch:
      # contactPoints: ""
      # replicationEnabled: false
      # createDevInstance:
        # affinityAndTolerations: ""
        # resources:
          # limits:
            # cpu: '1'
            # memory: 1Gi
          # requests:
            # cpu: '0.1'
            # memory: 1.5Gi
        # storage:
          # name: ""
          # accessMode: ReadWriteMany
          # capacity: 10Gi
          # storageClassName: default
          # securityContext:
            # fsGroup: 
            # supplementalGroups: [] 
  
    # configuration:
      # ssl_cassandra_disable: ""
      # ssl_elasticsearch_disable: ""
      # ssl_kafka_disable: ""  
      # ssl_Logging_kafka_disable: ""
注: Cassandra には最小 5000Mi のメモリーが必要であり、最大 9000Miまで使用できます。
以下の表で、 SIPEnvironmentの externalServices パラメーターに適用される属性について説明します。
プロパティー デフォルト値 値タイプ 必須 説明
cassandra   object はい externalServices用に Cassandra を構成します。 詳しくは、 cassandra パラメーターを参照してください。
elasticsearch   object はい externalServices用に Elasticsearch を構成します。 詳しくは、 elasticsearch パラメーターを参照してください。
kafka   object はい externalServices用に Kafka を構成します。 詳しくは、 kafka パラメーターを参照してください。
configuration   object いいえ 各サービスの configuration パラメーターを構成します。 詳しくは、 構成パラメーターを参照してください。

cassandra パラメーター

注:
  • Cassandra ポッドが unhealthy 状態になったら、 Cassandra のリソースを増やし、 IV-appserver と IV-backend のデプロイメントを再始動することをお勧めします。
  • Cassandra ポッドの JVM_OPTS は、リソースに渡された要求と制限に基づいて計算されます。 したがって、 Xms は要求と等しくなければならず、 Xmx は制限の 75% でなければなりません。 詳しくは、 リソースを参照してください。
プロパティー デフォルト値 値タイプ 必須 説明
iv_keyspace   string はい Inventory Visibilityの keyspace を指定します。
cas_keyspace ks_cas string いいえ 運送会社サービスの keyspace を指定します。
promising_keyspace ks_promising string いいえ 約束サービスの keyspace を指定します。
lifecycle_manager_keyspace ks_lifecycle_manager string いいえ ライフサイクルマネージャー・プロセスの を keyspace 指定してください。
filex_keyspace ks_filex string いいえ FileXkeyspace サービスに対してを指定し、コンテナのデプロイメントでプレミアム機能を有効にしてください。 を、希望するキースペース ks_filex 名に置き換えてください。 デプロイや更新を行う前に、キースペースが作成されている Sterling Intelligent Promisingことを確認してください。
createDevInstance   object いいえ Cassandraのリソースとストレージを指定します。 詳細については、createDevInstanceパラメータ。
注:
  • これは、非 SSL モードで Cassandra を展開します。
  • cassandra.createDevInstance は、必要なイメージをパブリック・リポジトリーからプルします。 IBM® Sterling Intelligent Promisingをデプロイする前に、クラスターがインターネットに接続されていることを確認してください。
contactPoints   string いいえ Cassandraのコンタクト・ポイント。 Cassandraで createDevInstance が有効になっていない場合、 contactPoints は必須です。 以下のキースペースを作成する必要があります。
  • <cassandra.iv_keyspace>
  • <cassandra.promising_keyspace>
  • <cassandra.cas_keyspace>
Cassandra が SSL に対して外部である場合、証明書をトラストストアに追加してください。 詳細については、 「セキュリティパラメータ」 を参照してください。
注: contactPoints インスタンスに http または https を含めないでください。
datacenter   ストリング いいえ Cassandraのデータ・センターを指定します。

elasticsearch パラメーター

プロパティー デフォルト値 値タイプ 必須 説明
createDevInstance   object いいえ Elasticsearchのリソースおよびストレージを指定します。
詳細については、createDevInstanceパラメータ。
注:
  • これは、非 SSL モードでのみ Elasticsearch を展開します。
  • elasticsearch.createDevInstance は、必要なイメージをパブリック・リポジトリーからプルします。 IBM Sterling Intelligent Promisingをデプロイする前に、クラスターがインターネットに接続されていることを確認してください。
contactPoints   string いいえ 連絡先Elasticsearch。 もしcreateDevInstance有効になっていませんElasticsearch、 それからcontactPoints必須です。 Elasticsearch が SSL に対して外部である場合、証明書をトラストストアに追加してください。 詳細については、 「セキュリティパラメータ」 を参照してください。
注: contactPoints インスタンスに http または https を含めないでください。
replicationEnabled いいえ ブール値 いいえ このプロパティを指定することで、Elasticsearch データレプリケーションをマルチクラスタセットアップで有効または無効にすることができます。

kafka パラメーター

プロパティー デフォルト値 値タイプ 必須 説明
contactPoints   ストリング いいえ 連絡先Kafka。 もしcreateDevInstance有効になっていませんKafka、 それからcontactPoints必須です。 Kafka が SSL に対して外部である場合、証明書をトラストストアに追加してください。 詳細については、 「セキュリティパラメータ」 を参照してください。
注: contactPoints インスタンスに http または https を含めないでください。
topicPrefix sip ストリング いいえ Kafkaトピックに設定するプレフィックスを定義します。 Kafka のトピックに関する詳細については、 各サービスの「 Kafka 」のトピック一覧を参照してください。
mirrorTopicPrefix   ストリング いいえ この接頭辞を定義すると、レプリケーション時に指定した接頭辞を名前に付加してミラー化されたトピックを識別できます。 この接頭辞は、Kafka MirrorMaker で、デスティネーション・クラスタのレプリケートされたトピックにラベルを付けるために使用されます。
crossDCTopicPrefix   ストリング いいえ 他のデータセンターのKafkaトピックにこの接頭辞を定義します。 指定しない場合は、topicPrefixがミラートピックに使われます。
createDevInstance   object いいえ Kafkaのリソースおよびストレージを指定します。 このオブジェクトは、 Kafkaの開発インスタンスをデプロイする場合にのみ設定します。 Kafkaで createDevInstance が有効になっている場合、 contactPoints は不要です。 詳細については、createDevInstanceパラメータ。
注:
  • これは、非 SSL モードでのみ Kafka を展開します。
  • kafka.createDevInstance は、必要なイメージをパブリック・リポジトリーからプルします。 そのため、インターネットにアクセスできないクラスターに IBM Sterling Intelligent Promising をデプロイする場合は、 Kafkaの独自のインスタンスを使用することをお勧めします。
  • Sync Supply API を開始する前に、必ず {topic_prefix}-iv-supply-sync トピックを作成してください。 以下のコマンドを実行して、トピックを作成します。
    ./kafka-topics.sh --bootstrap-server <hostname>:<port> --create --topic {topicPrefix}-inventory-supply-sync --partitions 1 --replication-factor 1
loggingContactPoints   ストリング いいえ Log4j2 Kafka アペンダーを使用している場合は、ロギングに loggingContactPointsを指定します。 デフォルトでは、 kafka.contactPoints は、ログを Kafka トピックにプッシュすると見なされます。

Log4j2 の Kafka アペンダーに関する詳細については、 「log」パラメータを参照してください。

createDevInstance パラメーター

プロパティー デフォルト値 値タイプ 必須 説明
affinityAndTolerations ストリング いいえ SIPEnvironmentで定義されている affinityAndTolerations の名前を使用します。
resources   オブジェクト いいえ CPU およびメモリーのリソース要求および制限を指定します。 詳細については、 「ポッドおよびコンテナのリソース管理」 を参照してください。
storage   オブジェクト いいえ ストレージの永続ボリュームを指定します。 詳細については、 「ストレージパラメータ」 を参照してください。

configuration パラメーター

プロパティー デフォルト値 値タイプ 必須 説明
ssl_cassandra_disable "false" ストリング いいえ 非 SSL 上の Cassandra インスタンスに対してコンタクトポイントを指定している場合、このプロパティを. "true"に設定してください。
ssl_kafka_disable "false" ストリング いいえ 非 SSL 上の Kafka インスタンスに対してコンタクトポイントを指定している場合、このプロパティを. "true"に設定してください。
ssl_elasticsearch_disable "false" ストリング いいえ 非 SSL 上の Elasticsearch インスタンスに対してコンタクトポイントを指定している場合、このプロパティを. "true"に設定してください。
ssl_Logging_kafka_disable "false" ストリング いいえ 非 SSL 環境にある Kafka のロギングインスタンスに対してを loggingContactPoints 指定している場合、このプロパティをに設定してください "true"。

外部サービス接続の検証に使用されるアノテーション

デフォルトでは、オペレータは外部サービスの接続をチェックしません。 以下のアノテーションを設定して、デプロイ前に外部インスタンス接続を検証するか、またはチェックをスキップします。
注釈 説明
apps.sip.ibm.com/validate-external-services-connections ジョブをトリガーするには、このアノテーションをtrueに設定します。 オペレーターはジョブをトリガーして、開発環境と本番環境の外部インスタンスの接続をチェックします。 接続に失敗するとプロセスが停止し、エラー処理によってエラーが確実にポッドログに記録されるため、正確なデバッグが可能になります。
apps.sip.ibm.com/skip-external-services-connection-validation 失敗した接続をスキップするには、このアノテーションを true に設定します。

接続性チェックをスキップしたい外部サービスの値をカンマ区切りで渡します。 有効な値は cassandra, kafka, elasticsearch, kafka-logging。

ログを別のKafkaに送信する場合、アノテーションはこのKafkaの接続性をチェックします。

例以下のアノテーションは、CassandraとKafkaの接続チェックをスキップします。

apps.sip.ibm.com/skip-external-services-connection-validation:`cassandra, kafka`
Sterling Intelligent Promisingとオプティマイザ展開のための事前接続性チェック
Sterling Intelligent Promisingをデプロイすると、sip-pre-connectivity-checkジョブが実行され、Cassandra、Elasticsearch、およびKafkaの接続がチェックされます。 オプティマイザーを独立モードでデプロイし、 sip-optimizer-pre-connectivity-check ジョブをトリガーするように設定すると、 Elasticsearch と Kafka の接続をチェックします。