github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update Helm docs to include the `default` flag for catalog sync 

Additionally fixes an issue with quotes on the related annotation.
pull/4873/head
Rebecca Zanzig 2018-10-30 16:37:04 -07:00
parent f8e56d5365
commit 6e575b2671
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/source/docs/platform/k8s/helm.html.md
View File

@ -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) [consul-k8s](/docs/platform/k8s/index.html#quot-consul-k8s-quot-project)
to run the sync program. to run the sync program.
- <a name="v-synccatalog-default" href="#v-synccatalog-default">`default`</a> (`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.
- <a name="v-synccatalog-k8sprefix" href="#v-synccatalog-k8sprefix">`k8sPrefix`</a> (`string: ""`) - - <a name="v-synccatalog-k8sprefix" href="#v-synccatalog-k8sprefix">`k8sPrefix`</a> (`string: ""`) -
A prefix to prepend to all services registered in Kubernetes from Consul. A prefix to prepend to all services registered in Kubernetes from Consul.
This defaults to `""` where no prefix is prepended; Consul services are This defaults to `""` where no prefix is prepended; Consul services are

9
website/source/docs/platform/k8s/service-sync.html.md
View File

@ -133,9 +133,10 @@ is routable and configured by some other system.
### Sync Enable/Disable ### Sync Enable/Disable
By default, all valid services (as explained above) are synced. This default By default, all valid services (as explained above) are synced. This default can
can be changed as configuration to the sync process. Syncing can also be be changed as [configuration](/docs/platform/k8s/helm.html#v-synccatalog-default)
explicitly enabled or disabled using an annotation: to the sync process. Syncing can also be explicitly enabled or disabled using an
annotation:
```yaml ```yaml
kind: Service kind: Service
@ -143,7 +144,7 @@ apiVersion: v1
metadata: metadata:
name: my-service name: my-service
annotations: annotations:
"consul.hashicorp.com/service-sync": false "consul.hashicorp.com/service-sync": "false"
``` ```
### Service Name ### Service Name