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

Additionally fixes an issue with quotes on the related annotation.
This commit is contained in:
Rebecca Zanzig 2018-10-30 16:37:04 -07:00
parent 70a051363f
commit e2a1b2fa2d
2 changed files with 10 additions and 4 deletions

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)
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 prefix to prepend to all services registered in Kubernetes from Consul.
This defaults to `""` where no prefix is prepended; Consul services are

View File

@ -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