Commit Graph

44 Commits

Author SHA1 Message Date
Luke Kysow 12e6ef8424
Update Helm docs to match repo 2019-12-13 10:15:58 -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
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
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 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
Jake Lundberg 8241787e92 docs: Update consul-helm example to pull latest tag 2019-08-09 16:33:43 -06:00
Rebecca Zanzig 803a84bf83 Update to correct parameter name in docs 2019-05-14 15:30: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
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 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
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
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
Diogenes S. Jesus f0e081bf88 Fix repeating wording in sentence (#5256)
Fix `to join to join` typo
2019-01-23 09:12:41 -05:00
Rebecca Zanzig ebba215891 Fix broken links 2019-01-16 14:42:12 -08:00
Rebecca Zanzig df99f4a3ac Indent code blocks further to fix list formatting 2019-01-16 14:31:50 -08:00
Rebecca Zanzig 388ff4caed
Merge pull request #5222 from hashicorp/docs/helm-0.5.0
Add documentation about the two additional Helm chart options
2019-01-16 14:18:15 -08:00
Rebecca Zanzig 6de477ef96 Add documentation about the two additional Helm chart options
Adds info about `k8stag` and `nodePortSyncType` options that were
added in consul-helm v0.5.0.

Additionally moves the k8sprefix to match the order in the Helm chart
values file, while also clarifying that it only affects one sync
direction.
2019-01-14 16:15:26 -08:00
Rebecca Zanzig 1c70407bd1 Add a security warning about the default Helm chart installation
If a user installs the default Helm chart Consul on a Kubernetes
cluster that is open to the internet, it is lacking some important
security configurations.
2019-01-14 15:59:27 -08:00
Rebecca Zanzig ce82de1965 Add examples for helm chart multi-line strings
There has been some confusion about the formating of multi-line
string variables in the Helm chart. This adds examples for these
situations, hopefully clarifying things for users.
2018-12-18 12:46:45 -08:00
Rebecca Zanzig dd1243691a Add documentation about the new ClusterIP syncing
Adds ClusterIP as a supported service type in the sync doc, as well
as add `syncClusterIPServices` to the helm chart detailed list.
2018-12-07 16:04:35 -08:00
Rebecca Zanzig 3c6bf3eb47 Update type for `resources` variables
These were changed to multi-line strings to match the affinity
definition.
2018-11-20 10:56:11 -08:00
Rebecca Zanzig 8ca4e56db1 Update the helm chart `join` instructions
This fixes some previous incorrect information about the join feature
in the Helm chart. Based on the fix for consul-helm issue 59.
2018-11-12 12:22:18 -08:00
Rebecca Zanzig b6cb8ea6ef Update docs for Helm chart `maxUnavailable` value
Due to a Helm templating limitation, setting this value to `0` requires
an extra flag when installing. This adds information about that.
2018-11-09 16:58:54 -08:00
Rebecca Zanzig db6c5d1b20 Add doc info for added server affinity value
Supports newly added functionality to the Helm chart.
2018-11-08 12:07:30 -08:00
Rebecca Zanzig 140a1edcea Reorder Helm chart server values
This matches the ordering in the Helm chart, to make it easier for
users to find information.
2018-11-08 12:06:00 -08:00
Rebecca Zanzig 2c8675565d
Merge pull request #4900 from hashicorp/docs/helm-extension
Document options for additional helm chart configuration
2018-11-06 15:39:40 -08:00
Rebecca Zanzig 638a5ff7a1 Document options for additional helm chart configuration
There is a fine line between making the helm chart easy and simple to
use and supporting lots of configurability. This documents options for
users who would like to extend the Helm chart beyond what is readily
available in the `values.yaml` file.
2018-11-05 12:20:14 -08:00
Rebecca Zanzig ea6e5c8945 Clarify storage usage for consul + k8s
This adds two Helm chart values into the documentation with details
that have come up in several issues.

Additionally, it notes that persistent volumes and their claims need
to be removed manually because of current kubernetes and helm design.
2018-11-05 10:50:41 -08:00
Rebecca Zanzig 6e575b2671 Update Helm docs to include the `default` flag for catalog sync
Additionally fixes an issue with quotes on the related annotation.
2018-10-30 16:37:04 -07:00
Rebecca Zanzig 6fb2134e96 Add connectInject `image` info into helm docs
This field was added back into the helm chart, but it was not added
back to the documentation. This adds it, then additionally fixes a
few typos in the same file.
2018-10-25 08:41:59 -07:00
Rebecca Zanzig 58fc4a7cbc Add additional formatting detail to the Helm `join` command
In response to consul-helm issue 16.
2018-10-17 12:53:44 -07:00
Mitchell Hashimoto 1b02b9e3c1
website: address PR feedback 2018-10-09 09:30:37 -07:00
Mitchell Hashimoto a3adf47bfb
website: add docs for the Connect injection 2018-10-07 23:47:08 -07:00
Mitchell Hashimoto 9ec50a732f
Add new helm fields 2018-09-25 09:20:36 -05:00
Mitchell Hashimoto 824814be3f
website: document helm options 2018-09-23 17:29:18 -07:00
Mitchell Hashimoto 5943c79ed4
Initial Helm Chart/K8S Docs (#4653)
* website: initial Kubernetes section with Helm information

* website: extraConfig for clients

* website: add more helm fields

* website: document extraVolumes

* website: document Consul DNS

* website: fix typos and show example of downward API
2018-09-12 08:44:30 -07:00