luxolus/open-consul
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
10602 commits 1 branch 1 tag 358 MiB
Commit graph

83 commits

Author SHA1 Message Date
Luke Kysow 87d359bb8c
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 44dd24d099
[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 bc42074f57
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 db2ca07f98
Merge pull request #6583 from hashicorp/connect-annotations 
Document new annotations for Connect injections
 2019-10-31 12:58:43 -07:00
Luke Kysow 1b1b41b62e
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 1a373271e3
[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 9093b99dfd
Document new annotations for Connect injections 2019-10-04 15:31:24 -07:00
Luke Kysow c5fca5d4b5
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 bd789f1011
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 b3f1b5afd5
Fix typo in "Service Ports" section 2019-09-17 12:05:04 -07:00
Jake Lundberg a530fee06e docs: Update consul-helm example to pull latest tag 2019-08-09 16:33:43 -06:00
Todd Radel 7575bce5c9 Fix links to ambassador website 2019-07-24 13:23:49 -04:00
Justin Weissig e0364b0076 docs: fixed typos on a few doc pages (#5870) 2019-06-24 15:25:57 -06:00
Sarah Christoff 352adf204c
[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 9074778c0c
[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 1fd7f667ee Update to correct parameter name in docs 2019-05-14 15:30:59 -07:00
Rebecca Zanzig 6e2a8e6b10
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 e0af4da0ff 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 72f05beb05 docs: fixed spelling (#5840) 
Spelling: namepace/namespace.
 2019-05-14 10:54:22 -05:00
Christoph Puhl 540966609f Update index.html.md (#5813) 
Missing dot in Consul Kubernetes landing page.
 2019-05-13 10:06:05 -05:00
Sarah Christoff 2c246cd5f2 Update documentation for clarity 2019-05-01 17:16:30 -05:00
Sarah Christoff 3e9b0a9764 Update Helm Docs with consulPrefix 2019-04-30 17:30:24 -05:00
Judith Malnick b441622564 Remove redundant word. 2019-04-16 16:03:03 -06:00
Judith Malnick f27905dc62
[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 f21b8a8edf
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 10d71fa84a [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 05587186a6 Add dns configuration info for CoreDNS users 2019-03-20 23:02:04 -07:00
tryan225 3dcc00f854 Adding an example of extraVolumes with the Helm chart 2019-03-19 14:31:11 -07:00
Todd Radel d3ad84a710 [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 1be36c82ed 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 13133c0fff Add docs for new Helm annotations options 2019-03-08 10:10:25 -08:00
Rebecca Zanzig 2f8bcd2b66 Add docs about new Helm priorityClassName options 2019-03-08 09:42:53 -08:00
Rebecca Zanzig c5b3f98b14 Move aclSyncToken docs under syncCatalog 
Additionally updates the anchors to follow the established convention.
 2019-03-07 16:54:11 -08:00
Rebecca Zanzig 5b322d84e4 Add examples for the extraConfig options in the Helm chart 2019-03-06 13:01:17 -08:00
R.B. Boyer 66af091de9 website: fix broken links 2019-03-05 14:24:33 -06:00
kaitlincarter-hc f827e6feaa
[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 b75a02c029 Add additional clarification to the ACL token wording 2019-02-07 13:26:17 -08:00
kaitlincarter-hc 95ee68a4d7
Apply suggestions from code review 
Co-Authored-By: adilyse <rebecca@hashicorp.com>
 2019-02-07 13:08:04 -08:00
kaitlincarter-hc c4e4aad95b
Apply suggestions from code review 
Co-Authored-By: adilyse <rebecca@hashicorp.com>
 2019-02-01 14:33:06 -08:00
kaitlincarter-hc e845d4ad5f
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 0ec987d94f 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 9cb766a8de Fix missed letter in the documentation (#5281) 2019-01-28 16:25:56 -06:00
Diogenes S. Jesus 90f2788fa2 Fix repeating wording in sentence (#5256) 
Fix `to join to join` typo
 2019-01-23 09:12:41 -05:00
Rebecca Zanzig a023a09ed0 Fix broken links 2019-01-16 14:42:12 -08:00
Rebecca Zanzig 30e4796efe Indent code blocks further to fix list formatting 2019-01-16 14:31:50 -08:00
Rebecca Zanzig e46dd7c059
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
Chris Wang 1143878455 Fix typo in k8s connect documentation (#5229) 2019-01-16 17:03:40 -05:00
Rebecca Zanzig c085f005e1 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 880544dd85 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 1f05af4fdc 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