Commit Graph

370 Commits

Author SHA1 Message Date
Paul Glass fc460c0a8d
docs: Apply suggestions from code review
Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-09-16 10:19:15 -05:00
trujillo-adam 08c1b0e2ca
Update website/content/docs/k8s/k8s-cli.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:32:21 -07:00
trujillo-adam 69a6bb0ca4
Update website/content/docs/k8s/installation/install.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:31:43 -07:00
trujillo-adam cd13796bd4
Update website/content/docs/k8s/index.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:31:17 -07:00
trujillo-adam a2f58bdbdf
Update website/content/docs/k8s/installation/install.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:30:58 -07:00
Paul Glass f2d800c533 docs: update ECS Install guide for beta 2021-09-15 17:29:31 -05:00
Paul Glass f969ffec63 docs: Migrate Existing Tasks page for ECS 2021-09-15 17:28:34 -05:00
Paul Glass 333baead73
Merge pull request #11043 from hashicorp/pglass/consul-ecs-arch-doc
ECS architecture docs for Beta
2021-09-15 17:00:53 -05:00
Paul Glass 19ae767f6e
Merge pull request #11033 from hashicorp/consul-ecs-beta-docs
updates to ECS docs per beta release
2021-09-15 17:00:00 -05:00
Paul Glass 198841c296 docs: ECS architecture feedback 2021-09-15 16:18:37 -05:00
trujillo-adam a12fb39af7 applied comment feedback about my_task example 2021-09-15 14:09:47 -07:00
Paul Glass c9aa64270e docs: Address ECS architecture feedback 2021-09-15 15:04:39 -05:00
trujillo-adam 84d0763302 added a few more nbsp to improve table readability 2021-09-15 11:59:30 -07:00
David Yu 6ae4d7bb70
docs: Reformat Uninstall steps (#11040)
* docs: Reformat Uninstall steps

Reformatting uninstall as steps to make uninstall instructions more clear.
2021-09-15 11:59:02 -07:00
trujillo-adam d1554f7269 updates to the uninstall flags, preset descriptions 2021-09-15 11:55:14 -07:00
Paul Glass 58062ce587 docs: remove T3 in ECS task startup arch doc 2021-09-15 13:50:38 -05:00
Paul Glass a10d3f1991 docs: correct point about service health checks for ECS 2021-09-15 13:38:19 -05:00
Paul Glass 1097c78a6a ECS architecture docs for Beta 2021-09-15 13:04:07 -05:00
trujillo-adam d2dce8735f
Apply suggestions from code review
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2021-09-15 10:46:00 -07:00
Jared Kirschner e0527a503e docs: improve network segments agent options docs 2021-09-15 10:00:41 -07:00
Jared Kirschner cf24d6c86c docs: expand network segments documentation
Includes a brief overview with images, descriptions of server and client
configuration with examples, and how to join an agent to a segment.
2021-09-15 10:00:41 -07:00
David Yu 994d06f363
docs: Remove step for deleting webhook-cert-manager secret on Consul K8s uninstall (#11035)
* Remove step for deleting webhook-cert-manager secret
* Update website/content/docs/k8s/operations/uninstall.mdx
2021-09-15 08:11:22 -07:00
trujillo-adam e81bf74e4e updates to ECS docs per beta release 2021-09-14 16:36:52 -07:00
trujillo-adam cf58cd1e54 adding k8s-cli alpha docs 2021-09-14 12:25:24 -07:00
Daniel Nephin 44d91ea56f
Add failures_before_warning to checks (#10969)
Signed-off-by: Jakub Sokołowski <jakub@status.im>

* agent: add failures_before_warning setting

The new setting allows users to specify the number of check failures
that have to happen before a service status us updated to be `warning`.
This allows for more visibility for detected issues without creating
alerts and pinging administrators. Unlike the previous behavior, which
caused the service status to not update until it reached the configured
`failures_before_critical` setting, now Consul updates the Web UI view
with the `warning` state and the output of the service check when
`failures_before_warning` is breached.

The default value of `FailuresBeforeWarning` is the same as the value of
`FailuresBeforeCritical`, which allows for retaining the previous default
behavior of not triggering a warning.

When `FailuresBeforeWarning` is set to a value higher than that of
`FailuresBeforeCritical it has no effect as `FailuresBeforeCritical`
takes precedence.

Resolves: https://github.com/hashicorp/consul/issues/10680

Signed-off-by: Jakub Sokołowski <jakub@status.im>

Co-authored-by: Jakub Sokołowski <jakub@status.im>
2021-09-14 12:47:52 -04:00
Jared Kirschner def2d9d96d
Merge pull request #10837 from jkirschner-hashicorp/improve-docs-dns-with-acl
Improve documentation around using DNS with ACLs Enabled
2021-09-13 11:09:09 -04:00
Kyle MacDonald 13e0bb2906
website: fixup incorrect markdown syntax (#11015) 2021-09-13 10:36:34 -04:00
Jared Kirschner 4b28cfb54a docs: add ACL component relationships visual 2021-09-10 15:33:23 -07:00
Jared Kirschner e0b65303d4 docs: discuss use of ACLs on DNS page 2021-09-10 15:33:23 -07:00
Paul Banks b9dd859c6d
Apply suggestions from code review
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-09-10 21:29:43 +01:00
Paul Banks 64957f2d22
Document how to make namespace wildcard intentions. (#10724)
* Update intentions.mdx

* Apply suggestions from code review

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-09-10 21:25:09 +01:00
Jared Kirschner 2798b3e02f
Merge pull request #10834 from jkirschner-hashicorp/improve-docs-configure-ui-https
docs: give tutorials links for securing UI access
2021-09-09 11:08:11 -04:00
Jared Kirschner b2b00606fb docs: give tutorials links for securing UI access 2021-09-07 22:13:09 -07:00
trujillo-adam 9bedec4006
Update website/content/docs/k8s/installation/multi-cluster/vms-and-kubernetes.mdx
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2021-09-07 07:53:57 -07:00
trujillo-adam 2f92768b75 fixing the policy for configuring k8 clusters as secondary in federated arch 2021-09-02 15:26:41 -07:00
mrspanishviking ab47aac5b4
Merge pull request #10977 from hashicorp/nia-style-fix
docs: fixed numbering of license bullets and corrected indent
2021-09-02 12:51:35 -07:00
Karl Cardenas 77b93b6cce
docs: indenting pr web dev guidance and Blake 2021-09-02 11:25:49 -07:00
mrspanishviking 4eee7d222e
Update website/content/docs/nia/enterprise/license.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-09-02 11:24:21 -07:00
Peter M f5edf83cbb
Adding NIA to Consul Ent page 2021-09-02 10:32:07 -06:00
Karl Cardenas 05fa704647
docs: fixed numbering of license bullets and corrected indent 2021-09-02 09:28:36 -07:00
Amos Shapira 519a7e7848
docs: Add missing "is" on core security models (#10975)
Add missing "is" in description of `auto_encrypt.tls` parameter on
core security models page.
2021-09-01 22:07:20 -07:00
Karl Cardenas 52c7d2c797
docs: link to the enterprise license tutorial 2021-09-01 15:59:12 -07:00
lornasong 5384f6f2fd
nia/docs 0.3.0 (#10930)
Co-authored-by: Kim Ngo <6362111+findkim@users.noreply.github.com>
Co-authored-by: Melissa Kam <mkam@hashicorp.com>
Co-authored-by: Michael Wilkerson <mwilkerson@hashicorp.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-09-01 13:45:36 -05:00
Freddy 1dfdad8193
Update audit logging example (#10966)
* Update audit-logging.mdx
2021-08-31 16:04:47 -06:00
Freddy 11672defaf
connect: update envoy supported versions to latest patch release
(#10961)

Relevant advisory: 
https://github.com/envoyproxy/envoy/security/advisories/GHSA-6g4j-5vrw-2m8h
2021-08-31 10:39:18 -06:00
trujillo-adam d341e113db
Merge pull request #10892 from hashicorp/docs-tables-service-discovery-services
Reformatting service discovery parameters into tables
2021-08-30 15:20:42 -07:00
trujillo-adam 51b45c34de missed typo 2021-08-30 14:50:55 -07:00
trujillo-adam 09679aee3a applying @blake 's feedback 2021-08-30 14:49:32 -07:00
mrspanishviking 2497afed0d
Merge pull request #10912 from hashicorp/auto_config
docs: added information about a conflict when using auto_config and a…
2021-08-30 08:32:32 -07:00
Karl Cardenas 245ab6dbf4
docs: fixed identation of warning components 2021-08-30 07:12:30 -07:00
Dustin Clifford 27839b6d93
docs: Bad External VM Example (#10943)
Adds a missing `\` for continuation in the example command for
connecting an external VM client outside of Kubernetes to the Consul
server cluster.
2021-08-27 11:38:55 -07:00
mrspanishviking 4558d51ba3
Apply suggestions from code review
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-27 07:41:11 -07:00
Luke Kysow bb7b678617
Update helm reference (#10939)
* Update helm reference

* Fix docs issue breaking build

* Remove keys that aren't yet in the release
2021-08-26 17:58:59 -07:00
Karl Cardenas 8eab6b65b7
docs: added information about a conflict when using auto_config and auto_encrypt 2021-08-25 21:25:18 -07:00
sridhar bb9188bb45
Merge pull request #10673 from hashicorp/srikrishmurthy-patch-1
Updated a note in the ingress-gateway YAML that the ingress gateway name must match with what's configured in the helm chart
2021-08-25 17:35:00 -07:00
trujillo-adam 7b4a7bcc38 removed merge conflict chars 2021-08-24 12:05:01 -07:00
trujillo-adam fd868af255 fixed merge conflicts 2021-08-24 11:46:27 -07:00
trujillo-adam 8e24c923fc Merge branch 'main' of github.com:hashicorp/consul into docs-tables-service-discovery-services 2021-08-24 11:26:32 -07:00
trujillo-adam 832a5e4067 fixed more typos, applied additional tables, additional edits 2021-08-24 11:15:33 -07:00
trujillo-adam 4f85b1082b fixed typos, finished applying tables, minor editing 2021-08-24 09:57:48 -07:00
Nitya Dhanushkodi 59eab91d69
doc: remove sentence that tproxy works cross-DC with config entries. (#10885)
It can only work if there is a running service instance in the local DC,
so this is a bit misleading, since failover and redirects are typically
used when there is not an instance in the local DC.
2021-08-23 12:14:28 -07:00
trujillo-adam 7fce25fdbf
Update website/content/docs/discovery/services.mdx
Co-authored-by: Geoffrey Grosenbach <26+topfunky@users.noreply.github.com>
2021-08-23 11:09:43 -07:00
trujillo-adam 1bb21ab24e
Update website/content/docs/discovery/services.mdx
Co-authored-by: Geoffrey Grosenbach <26+topfunky@users.noreply.github.com>
2021-08-23 11:09:34 -07:00
trujillo-adam 584ee9f10e testing markdown table format for ref docs 2021-08-20 13:41:03 -07:00
Blake Covarrubias ef11e8bc92
docs: Add common CA config options to provider doc pages (#10842)
Add the list of common Connect CA configuration options to the
provider-specific CA docs.

Previously these options were only documented under the agent
configuration options. This change makes it so that all supported CA
provider configuration options are available from a single location.

Co-authored-by: Daniel Nephin <dnephin@hashicorp.com>
2021-08-19 11:18:55 -07:00
sridhar 8f625ae170
Update website/content/docs/k8s/connect/ingress-gateways.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-17 16:32:35 -07:00
Olatunde Alex-Oni 9ea02121b7 Update documentation for enable_key_list_policy
The current suggests the option expects a string of either "enabled" or "disabled" but this results in an error `'acl.enable_key_list_policy' expected type 'bool', got unconvertible type 'string', value: 'enabled'`. Setting to a boolean value resolves this, also had a quick look at the code (d2b58cd0d6/agent/config/runtime.go (L109)) and it suggests this too
2021-08-16 13:10:54 -07:00
Blake Covarrubias 247397dcd2
Document possible risk w.r.t exposing the admin API in Envoy (#10817)
Add a section to the Connect Security page which highlights the risks
of exposing Envoy's administration interface outside of localhost.

Resolves #5692

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Kent 'picat' Gruber <kent@hashicorp.com>
2021-08-13 10:05:29 -07:00
Blake Covarrubias 24166d9631
Document tagged addresses (#10744)
Add section for tagged addresses on service definition documentation.

Resolves #6989

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-08-12 16:49:59 -07:00
Blake Covarrubias deeebd2795
docs: Clarify ingress gateway's -address flag (#10810)
Clarify the function of `-address` flag when instantiating an ingress
gateway.

Resolves #9849

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-08-12 14:56:07 -07:00
Chris Piraino b302a926c6
docs: remove note on ingress gateway hosts field needing a port number (#10827)
This was necessary in older versions of Consul, but was obsoleted by
making Consul add the port number itself when constructing the Envoy
configuration.
2021-08-11 16:36:57 -05:00
Blake Covarrubias db59597cac docs: Update code blocks across website
* Use CodeTabs for examples in multiple formats.
* Ensure correct language on code fences.
* Use CodeBlockConfig for examples with filenames, or which need
highlighted content.
2021-08-11 13:20:03 -07:00
Blake Covarrubias 6f1fa59005 docs: Add JSON examples to all config entries
This commit adds example JSON configs for several config entry
resources were missing examples in this language.

The examples have been updated to use the new CodeTabs resource
instead of the Tab component.
2021-08-10 15:34:28 -07:00
trujillo-adam 79c25af139
Merge branch 'main' into docs-envoy-proxy-breaks-when-enabling-tls 2021-08-09 14:57:29 -07:00
trujillo-adam 521be9f2a8
Update website/content/docs/connect/proxies/envoy.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-09 13:36:28 -07:00
trujillo-adam 4c3a48e6b3
Update website/content/docs/connect/proxies/envoy.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-09 13:36:07 -07:00
trujillo-adam 6ba6025b55 docs: adding env var info, resolves #7926 2021-08-09 13:14:02 -07:00
sridhar 6cc451bd7f
Update website/content/docs/k8s/connect/ingress-gateways.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-04 16:25:36 -07:00
Daniel Nephin 79ab48ef81
Merge pull request #10768 from hashicorp/dnephin/agent-tls-cert-expiration-metric
telemetry: add Agent TLS Certificate expiration metric
2021-08-04 18:42:02 -04:00
trujillo-adam caa7052455
Merge pull request #10763 from hashicorp/docs-proxy-integration-improvements
general language and readability improvements to proxy integration docs
2021-08-04 14:36:47 -07:00
trujillo-adam 068ec1b607 Applying more feedback from @black and @karl-cardenas-coding 2021-08-04 14:02:42 -07:00
trujillo-adam c412c2811d Applying feedback from @blake 2021-08-04 11:29:21 -07:00
Daniel Nephin 1673b3a68c telemetry: add a metric for agent TLS cert expiry 2021-08-04 13:51:44 -04:00
trujillo-adam df643bb921
Update website/content/docs/connect/proxies/integrate.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-04 10:44:06 -07:00
trujillo-adam 0a6ea4e91e general language and readability improvements to proxy integration docs 2021-08-03 15:56:56 -07:00
joshwolfer d53db57558 Update options.mdx
add service config link to description of enable_central_service_config.
2021-08-03 15:36:51 -04:00
Blake Covarrubias 9eb8622061
docs: Note proxy-defaults can globally set service protocol (#10649)
Add a note to the docs for the service defaults config entry which
informs users that the service protocol can be configured for all
services using the proxy defaults config entry.

Resolves #8279

Co-authored-by: Freddy <freddygv@users.noreply.github.com>
2021-08-02 13:23:58 -07:00
Blake Covarrubias f97e843c61 Add OSS changes for specifying audit log permission mode 2021-07-30 09:58:11 -07:00
Daniel Nephin efad0234f4
Update website/content/docs/agent/options.mdx
Co-authored-by: Kent 'picat' Gruber <kent@hashicorp.com>
2021-07-29 12:38:30 -04:00
Paul Banks 73d1d55ddd
Call out the incompatibility of wildcards and L7 permissions 2021-07-29 11:58:21 +01:00
Daniel Nephin 7cf86dc2ab docs: give better guidance about how to configure the agent TLS CA 2021-07-28 18:22:35 -04:00
Sabeen Syed cac45c9379
Add Citrix TF module links to NIA docs (#10710) 2021-07-28 12:52:40 -05:00
Jared Kirschner 6bcc864819 Generalize base64 command usage in docs
The base64 CLI utility has two different short flag arguments for decode
depending on the platform: -D and -d.

Previously, the docs used the -D flag exclusively with the base64 utility.
Luckily, the long form of the flag is the same across platforms: --decode.

All uses of the base64 -D flag have been replaced with --decode.
2021-07-28 11:40:35 -04:00
trujillo-adam cc40493bd6
Merge pull request #10685 from hashicorp/docs-fix-broken-link-swim-article
Docs fix broken link swim article
2021-07-26 11:31:17 -07:00
Fabio Lichinchi ab9008158d
Update vault.mdx (#10679) 2021-07-26 09:16:00 -07:00
trujillo-adam e84891296c General improvements to the wording 2021-07-22 16:20:16 -07:00
trujillo-adam fa2b139cf4 docs: fixed broken link to SWIM article in architecture/gossip ref 2021-07-22 15:19:46 -07:00
sridhar 321e20af13
Update ingress-gateways.mdx
Updated a note in the ingress-gateway YAML that the ingress gateway name must match with what's configured in the helm chart
2021-07-21 16:18:40 -07:00
Blake Covarrubias 9a84fe7864
docs: Add intentions to ACL System docs (#10323)
Adds mention of `intentions` rules to ACL System and ACL Rules pages.

Resolves #9790
2021-07-19 15:31:41 -07:00
Blake Covarrubias 441a6c9969
Add DNS recursor strategy option (#10611)
This change adds a new `dns_config.recursor_strategy` option which
controls how Consul queries DNS resolvers listed in the `recursors`
config option. The supported options are `sequential` (default), and
`random`.

Closes #8807

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
Co-authored-by: Priyanka Sengupta <psengupta@flatiron.com>
2021-07-19 15:22:51 -07:00