Commit Graph

90 Commits

Author SHA1 Message Date
Luke Kysow 12e6ef8424
Update Helm docs to match repo 2019-12-13 10:15:58 -08:00
Iryna Shustava 1f3f9a7847
Merge pull request #6902 from hashicorp/k8s-auto-join-min-perms
Clarify the minimum permissions required for k8s auto-join
2019-12-06 13:35:15 -08:00
Iryna Shustava 1694f95e4a
Clarify minimum perms required for k8s auto-join 2019-12-06 12:57:47 -08:00
Luke Kysow 5412ba9dad
Reorg helm chart docs
- Remove duplicate install instructions from the Helm Chart page and
kept them in Running Consul
- Renamed Helm Chart to Helm Chart Reference because that's mostly what
it contains (along with some examples)
- Renamed Running Consul to Installing Consul
- Changed instructions to be for installing using Helm 3 and added
  notes if using Helm 2
- Used release name "hashicorp" so subsequent instructions can be more
concise and pastable, e.g. "port forward to svc/hashicorp-consul-server" vs. "port
forward to svc/<your release name>-consul-server"
- Use config.yaml as the name for the override values file since it
differentiates from the default values.yaml file and its the name of the
file used in the helm docs
(https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing)
2019-12-03 17:49:05 -08:00
Tyler Ryan 0a7e0279e7 Docs/consul k8s existing pvc (#6872)
Update docs for using pre-existing PVCs with helm
2019-12-03 11:14:25 -08:00
Luke Kysow 585f3ccf29
Merge pull request #6798 from hashicorp/namespace-selector-docs
Fix documentation for namespaceSelector
2019-12-02 17:54:04 -08:00
Luke Kysow eaefa80362
Fix documentation for namespaceSelector
Also remove the example for using namespace selector because it requires
labelling a namespace which is harder to explain.
2019-12-02 12:25:38 -08:00
Luke Kysow 7b9f63af15
Fix helm docs bug
If the ServiceAccount isn't applied first, we get an error since the Pod
references a non-existing ServiceAccount
2019-11-29 09:17:56 -08:00
kaitlincarter-hc 9c0e1a5b08
[WIP] Kubernetes Docs (#6770)
* adding cloud providers for k8s

* adding links

* added utm parameters

* Updating descriptions

* fix sidenav

* renaming page minikube
2019-11-18 12:00:01 -06:00
Blake Covarrubias 0aa025df1c
docs: Miscellaneous docs cleanup (#6742)
Fix spelling errors, API doc inconsistencies, and formatting issues.

* Fix several spelling errors.
* Prepend / to v1/event/list path in Watches.
* Rename script handlers to match Watch type.
* Remove /v1 path prefix on service health API endpoints.

Makes request path consistent with the rest of the HTTP API
documentation which does not include the /v1 prefix.

* Fix bracket formatting issue on Telemetry page.

The HTML codes used for brackets inside of the code block are not
interpolated, and are shown as literal strings.

Replace the numeric HTML codes with the intended character value to
fix display formatting.

Also placed variable reference on agent/options.html inside code block
for consistency with the presentation of other options on the page.

* Add missing word to Coordinate.Node docstring.

Resolves #6014
2019-11-05 20:34:46 -08:00
Luke Kysow c496fd80c2
Merge pull request #6583 from hashicorp/connect-annotations
Document new annotations for Connect injections
2019-10-31 12:58:43 -07:00
Luke Kysow 3524ee0478
Document service account name requirements
If ACLs are enabled, service account name must match the name of the
service in Consul.

Fixes https://github.com/hashicorp/consul-helm/issues/202
2019-10-24 16:51:51 -07:00
kaitlincarter-hc b0310364c6
[docs] Adding Links to Learn (#6611)
* adding links to Learn

* fixing a couple typos

* adding utm paramaters

* Update website/source/docs/connect/registration/sidecar-service.md

* Update website/source/docs/connect/registration/sidecar-service.md

* Update website/source/docs/acl/acl-system.html.md

* Update website/source/docs/acl/acl-system.html.md

* Update website/source/docs/agent/encryption.html.md

Co-Authored-By: Judith Malnick <judith.patudith@gmail.com>

* Update website/source/docs/connect/proxies/built-in.md

Co-Authored-By: Judith Malnick <judith.patudith@gmail.com>

* Update website/source/docs/connect/registration/sidecar-service.md

Co-Authored-By: Judith Malnick <judith.patudith@gmail.com>

* Update website/source/docs/install/index.html.md

Co-Authored-By: Judith Malnick <judith.patudith@gmail.com>

* Update website/source/docs/agent/kv.html.md

* Update website/source/docs/connect/security.html.md

* Update website/source/docs/connect/security.html.md

* Update website/source/docs/internals/architecture.html.md
2019-10-14 10:40:35 -05:00
Luke Kysow 17990aabf3
Document new annotations for Connect injections 2019-10-04 15:31:24 -07:00
Luke Kysow dcf922858a
Update consul-helm enterprise docs for ACLs
If ACLs are added then slightly different commands are needed.
2019-09-19 15:09:38 -07:00
Luke Kysow 2a0d9ff882
Update Consul DNS on kube docs
- fix instructions for CoreDNS (it updated)
- fix instructions for new component names
- recommend installing with the name 'consul'
- add disclaimer that catalog sync is not always required
- clean up example values.yaml files
2019-09-19 15:09:38 -07:00
Iryna Shustava 7d593aca60
Fix typo in "Service Ports" section 2019-09-17 12:05:04 -07:00
Jake Lundberg 8241787e92 docs: Update consul-helm example to pull latest tag 2019-08-09 16:33:43 -06:00
Todd Radel 569b37133a Fix links to ambassador website 2019-07-24 13:23:49 -04:00
Justin Weissig 88b15d84f9 docs: fixed typos on a few doc pages (#5870) 2019-06-24 15:25:57 -06:00
Sarah Christoff 8c821c1260
[docs] update documentation for connect-service-upstreams (#5422)
* update documentation for connect-service-upstreams

Adds documentation for services, multiple services, and prepared
query under connect-service-upstreams annotation.

* changing tone of voice

* active voice fix

* fixing spaces

* fixed order, added clarification for multiple upstreams

* Update website/source/docs/platform/k8s/connect.html.md

Co-Authored-By: s-christoff <sarah.christoff13@gmail.com>
2019-06-20 14:18:34 -05:00
kaitlincarter-hc c2c22a35fb
[docs] Updating links to guides (#5795)
* fixing links in the docs post guide migartion.

* fixed one more

* Update website/source/docs/acl/acl-legacy.html.md

Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>

* Update website/source/docs/enterprise/connect-multi-datacenter/index.html.md

* Updating based on comments and fixing word wrap

* Update website/source/api/acl-legacy.html.md

* Update website/source/api/acl/acl.html.md

* Update website/source/docs/agent/options.html.md

* Update website/source/docs/faq.html.md

* Update website/source/docs/internals/architecture.html.md

* Update website/source/docs/agent/encryption.html.md
2019-05-15 10:49:41 -05:00
Rebecca Zanzig 803a84bf83 Update to correct parameter name in docs 2019-05-14 15:30:59 -07:00
Rebecca Zanzig 8895d9c2d5
Merge pull request #5825 from hashicorp/docs/helming
Add docs for Helm chart features introduced in v0.8.0
2019-05-14 12:13:59 -07:00
Rebecca Zanzig ca01f2a93a Add docs for Helm chart features introduced in v0.8.0
Additionally defines a new annotation that is used with these new
features.
2019-05-14 11:28:08 -07:00
Justin Weissig f5ec74f0e1 docs: fixed spelling (#5840)
Spelling: namepace/namespace.
2019-05-14 10:54:22 -05:00
Christoph Puhl 87bf4c026b Update index.html.md (#5813)
Missing dot in Consul Kubernetes landing page.
2019-05-13 10:06:05 -05:00
Sarah Christoff bf2bcef53a Update documentation for clarity 2019-05-01 17:16:30 -05:00
Sarah Christoff 16d1e0f2f2 Update Helm Docs with consulPrefix 2019-04-30 17:30:24 -05:00
Judith Malnick d909766403 Remove redundant word. 2019-04-16 16:03:03 -06:00
Judith Malnick fc7a1e0175
[docs] security warning about Helm chart (#5561)
* [docs] security warning about Helm chart

Correct security warning about helm chart to caution about default Consul install.

* clarify that k8s or consul should be secure
2019-04-04 16:58:57 -07:00
Rebecca Zanzig e035db0e8d
Merge pull request #5515 from tryan225/docs/helm-extra-volumes-example
[docs] Adding an example of extraVolumes with the Helm chart
2019-04-01 09:53:02 -07:00
Todd Radel 77bd53269d [docs] New doc on integration with Ambassador Proxy (#5497)
* New doc on integration with Ambassador Proxy

* Remove reference to "step 1"

* Added link to docs for `consul intention check`

* Update website/source/docs/platform/k8s/ambassador.html.md

Co-Authored-By: tradel <todd@radel.us>

* Update website/source/docs/platform/k8s/ambassador.html.md

Co-Authored-By: tradel <todd@radel.us>

* Update website/source/docs/platform/k8s/ambassador.html.md

Co-Authored-By: tradel <todd@radel.us>

* Added links to install guide and Connect guide
2019-03-21 11:00:39 -05:00
Rebecca Zanzig fb521c6094 Add dns configuration info for CoreDNS users 2019-03-20 23:02:04 -07:00
tryan225 8f9b93448f Adding an example of extraVolumes with the Helm chart 2019-03-19 14:31:11 -07:00
Todd Radel c5bd1a79da [docs] Added section on using Helm chart to deploy Enterprise binaries (#5454)
* Added section on using Helm chart to deploy Enterprise binaries

* Update website/source/docs/platform/k8s/helm.html.md

Switch to active voice.

Co-Authored-By: tradel <todd@radel.us>

* Update website/source/docs/platform/k8s/helm.html.md

Co-Authored-By: tradel <todd@radel.us>

* Update website/source/docs/platform/k8s/helm.html.md

* Update website/source/docs/platform/k8s/helm.html.md

Co-Authored-By: tradel <todd@radel.us>
2019-03-18 11:21:40 -07:00
Rebecca Zanzig 34e9eab0d6 Add docs for using Helm `--set` to create extraConfig variables (#5474)
* Add docs for using Helm `--set` to create extraConfig variables

Based on info provided for `consul-helm` issue 74.

* fixing formatting
2019-03-13 16:25:09 -05:00
Rebecca Zanzig 3ac9e57efe Add docs for new Helm `annotations` options 2019-03-08 10:10:25 -08:00
Rebecca Zanzig 6c7245ce84 Add docs about new Helm `priorityClassName` options 2019-03-08 09:42:53 -08:00
Rebecca Zanzig 3dbd73ee23 Move aclSyncToken docs under `syncCatalog`
Additionally updates the anchors to follow the established convention.
2019-03-07 16:54:11 -08:00
Rebecca Zanzig c07b7cc154 Add examples for the `extraConfig` options in the Helm chart 2019-03-06 13:01:17 -08:00
R.B. Boyer a99f7aaa25 website: fix broken links 2019-03-05 14:24:33 -06:00
kaitlincarter-hc 193c0b727b
[Docs] Helm Chart (#5350)
* Updating the Helm chart to include ACL parameter and examples.

* Updates based on feedback.

* Update website/source/docs/platform/k8s/helm.html.md

Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>
2019-02-20 18:27:28 -06:00
Rebecca Zanzig 1ef6bf3902 Add additional clarification to the ACL token wording 2019-02-07 13:26:17 -08:00
kaitlincarter-hc 5a98953c43
Apply suggestions from code review
Co-Authored-By: adilyse <rebecca@hashicorp.com>
2019-02-07 13:08:04 -08:00
kaitlincarter-hc 9bdd921917
Apply suggestions from code review
Co-Authored-By: adilyse <rebecca@hashicorp.com>
2019-02-01 14:33:06 -08:00
kaitlincarter-hc c60efabed2
Update website/source/docs/platform/k8s/service-sync.html.md
Co-Authored-By: adilyse <rebecca@hashicorp.com>
2019-02-01 14:32:37 -08:00
Rebecca Zanzig a3b830f68f Update k8s ACL documentation
Clarifies that an ACL token only needs to be provided when ACLs are
enabled within the Consul cluster.
2019-01-31 13:55:09 -08:00
Ilya Pavlov 39d5f2c08e Fix missed letter in the documentation (#5281) 2019-01-28 16:25:56 -06:00
Diogenes S. Jesus f0e081bf88 Fix repeating wording in sentence (#5256)
Fix `to join to join` typo
2019-01-23 09:12:41 -05:00