From e2a1b2fa2dfae73523ee58efb4b9183a250caa8c Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Tue, 30 Oct 2018 16:37:04 -0700 Subject: [PATCH 1/3] Update Helm docs to include the `default` flag for catalog sync Additionally fixes an issue with quotes on the related annotation. --- website/source/docs/platform/k8s/helm.html.md | 5 +++++ website/source/docs/platform/k8s/service-sync.html.md | 9 +++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index ef47b7a5e..071f8e5c2 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -261,6 +261,11 @@ and consider if they're appropriate for your deployment. [consul-k8s](/docs/platform/k8s/index.html#quot-consul-k8s-quot-project) to run the sync program. + - `default` (`boolean: true`) - + If true, all valid services in K8S are synced by default. If false, + the service must be [annotated](/docs/platform/k8s/service-sync.html#sync-enable-disable) + properly to sync. In either case an annotation can override the default. + - `k8sPrefix` (`string: ""`) - A prefix to prepend to all services registered in Kubernetes from Consul. This defaults to `""` where no prefix is prepended; Consul services are diff --git a/website/source/docs/platform/k8s/service-sync.html.md b/website/source/docs/platform/k8s/service-sync.html.md index ffb3437a9..13525cb60 100644 --- a/website/source/docs/platform/k8s/service-sync.html.md +++ b/website/source/docs/platform/k8s/service-sync.html.md @@ -133,9 +133,10 @@ is routable and configured by some other system. ### Sync Enable/Disable -By default, all valid services (as explained above) are synced. This default -can be changed as configuration to the sync process. Syncing can also be -explicitly enabled or disabled using an annotation: +By default, all valid services (as explained above) are synced. This default can +be changed as [configuration](/docs/platform/k8s/helm.html#v-synccatalog-default) +to the sync process. Syncing can also be explicitly enabled or disabled using an +annotation: ```yaml kind: Service @@ -143,7 +144,7 @@ apiVersion: v1 metadata: name: my-service annotations: - "consul.hashicorp.com/service-sync": false + "consul.hashicorp.com/service-sync": "false" ``` ### Service Name From 548c8e798d0eb7701a61dc30fc0e537a74480264 Mon Sep 17 00:00:00 2001 From: Anubhav Mishra Date: Wed, 31 Oct 2018 13:18:01 -0700 Subject: [PATCH 2/3] Updating configuration wording. Co-Authored-By: adilyse --- website/source/docs/platform/k8s/service-sync.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/platform/k8s/service-sync.html.md b/website/source/docs/platform/k8s/service-sync.html.md index 13525cb60..af22a3980 100644 --- a/website/source/docs/platform/k8s/service-sync.html.md +++ b/website/source/docs/platform/k8s/service-sync.html.md @@ -134,7 +134,7 @@ is routable and configured by some other system. ### Sync Enable/Disable By default, all valid services (as explained above) are synced. This default can -be changed as [configuration](/docs/platform/k8s/helm.html#v-synccatalog-default) +be changed using the [configuration](/docs/platform/k8s/helm.html#v-synccatalog-default). to the sync process. Syncing can also be explicitly enabled or disabled using an annotation: From 80776eead4126ecc95a906d76f6ba72299c63284 Mon Sep 17 00:00:00 2001 From: Anubhav Mishra Date: Wed, 31 Oct 2018 13:18:50 -0700 Subject: [PATCH 3/3] Clarify sync wording. Co-Authored-By: adilyse --- website/source/docs/platform/k8s/service-sync.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/platform/k8s/service-sync.html.md b/website/source/docs/platform/k8s/service-sync.html.md index af22a3980..34f7b9d67 100644 --- a/website/source/docs/platform/k8s/service-sync.html.md +++ b/website/source/docs/platform/k8s/service-sync.html.md @@ -135,7 +135,7 @@ is routable and configured by some other system. By default, all valid services (as explained above) are synced. This default can be changed using the [configuration](/docs/platform/k8s/helm.html#v-synccatalog-default). -to the sync process. Syncing can also be explicitly enabled or disabled using an +Syncing can also be explicitly enabled or disabled using an annotation: ```yaml