diff --git a/docs/gcp/gke/README.md b/docs/gcp/gke/README.md index 4e23a1b..ec6b27e 100644 --- a/docs/gcp/gke/README.md +++ b/docs/gcp/gke/README.md @@ -34,12 +34,12 @@ EXPORT_DESTINATION=bigquery,pubsub ``` ### Pubsub Ordering (optional) -If you want to order message in pubsub, set ```PUBSUB_ORDERING_BY``` env. +If you want to order message in pubsub, set ```PUBSUB_ORDERING_BY``` env.
+Specify the field name of one of the Change Streams.
https://cloud.google.com/pubsub/docs/ordering **NOTICE** -ordering message can cause performance issues. - +ordering message can cause performance issues.
see https://medium.com/google-cloud/google-cloud-pub-sub-ordered-delivery-1e4181f60bc8 ### BigQuery schema (optional) diff --git a/docs/gcp/gke/README_JP.md b/docs/gcp/gke/README_JP.md index 1b96a80..a72ac44 100644 --- a/docs/gcp/gke/README_JP.md +++ b/docs/gcp/gke/README_JP.md @@ -34,11 +34,12 @@ EXPORT_DESTINATION=bigquery,pubsub ``` ### Pubsub Ordering (オプション) -メッセージの順序指定を利用したい場合、環境変数```PUBSUB_ORDERING_BY```を設定する必要があります。 +メッセージの順序指定を利用したい場合、環境変数```PUBSUB_ORDERING_BY```を設定する必要があります。
+Change Streamsのいずれかのフィールド名を指定します。
https://cloud.google.com/pubsub/docs/ordering **注意** -メッセージの順序指定はパフォーマンスに悪影響をもたらす可能性があります。 +メッセージの順序指定はパフォーマンスに影響をもたらす可能性があります。
参照: https://medium.com/google-cloud/google-cloud-pub-sub-ordered-delivery-1e4181f60bc8 ### BigQuery スキーマ (オプション) diff --git a/docs/gcp/gke/helm/templates/stateless.yaml b/docs/gcp/gke/helm/templates/stateless.yaml index 7afd22d..439f411 100644 --- a/docs/gcp/gke/helm/templates/stateless.yaml +++ b/docs/gcp/gke/helm/templates/stateless.yaml @@ -50,6 +50,18 @@ spec: # secretKeyRef: # name: {{ $.Values.secrets.name }} # key: BIGQUERY_TABLE_{{ $collection }} +# # Optional +# - name: PUBSUB_TOPIC_NAME +# valueFrom: +# secretKeyRef: +# name: {{ $.Values.secrets.name }} +# key: PUBSUB_TOPIC_NAME{{ $collection }} +# # Optional +# - name: PUBSUB_ORDERING_BY +# valueFrom: +# secretKeyRef: +# name: {{ $.Values.secrets.name }} +# key: PUBSUB_ORDERING_BY{{ $collection }} - name: RESUME_TOKEN_VOLUME_DIR valueFrom: secretKeyRef: diff --git a/docs/gcp/gke/secrets.env.template b/docs/gcp/gke/secrets.env.template index 51ea0a1..a26778c 100644 --- a/docs/gcp/gke/secrets.env.template +++ b/docs/gcp/gke/secrets.env.template @@ -21,6 +21,8 @@ EXPORT_DESTINATION= # Optional ## You have to specify this environment variable if you want to export Cloud PubSub. PUBSUB_TOPIC_NAME= +## You have to specify this environment variable if you want to take advantage of PubSub message ordering. +PUBSUB_ORDERING_BY= # Require ## Specify the time zone you run this middleware by referring to the following. (e.g. TIME_ZONE=Asia/Tokyo)