Commit Graph

1189 Commits

Author SHA1 Message Date
Blake Covarrubias e653cb58ad Redirect /api-docs/acl/acl to the new URL 2022-05-13 10:37:16 -07:00
Blake Covarrubias 2848721d82 Clarify purpose of example ACL rules and policies 2022-05-13 10:37:16 -07:00
Blake Covarrubias 3d0abe7aef Remove unnecessary quotes from HCL variables 2022-05-13 10:35:24 -07:00
Blake Covarrubias 9afeac9643 Remove HCL examples of roles since only JSON payloads can be used 2022-05-13 10:35:24 -07:00
Blake Covarrubias 948fc47e75 docs: Fix JSON formatted example ACL policies
Commit 9333fad added JSON formatted examples for all ACL polices.
Most of these these examples are not valid JSON, and thus an error is
raised when attempting to create the example policies/rules in Consul.

This commit fixes the example JSON formatted ACL rules so that they
are valid JSON. This enables readers to use the policies as-is from
the documentation to successfully create policies in Consul.

It also removes unnecessary arrays from the example policies so that
the policies are easier for practitioners to read and write.
2022-05-13 10:35:24 -07:00
David Yu b6594144ee
docs: add enterprise image (#13047) 2022-05-12 13:27:11 -07:00
Adrian Todorov 1c2da4189d
fix small typo in multi-cluster k8s installs docs 2022-05-12 19:46:45 +02:00
Michael Wilkerson 3a196db8de
Beta CTS Docs (#12916)
* updated beta docs

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: AJ Jwair <aj.jwair@hashicorp.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* updated beta docs

* updated beta docs

* updated beta docs

* updated docs

* updated docs

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

* update docs

* Update website/content/docs/release-notes/consul-terraform-sync/v0_6_0_beta.mdx

Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>

* docs/nia: Health endpoint and service registration

- Add Health endpoint docs
- Add CTS service registration docs

* update docs

* docs/nia: Miscellaneous fixes to beta docs

Co-authored-by: lornasong <lornasong@users.noreply.github.com>

* docs/nia: Update TFC agents description

Co-authored-by: AJ Jwair <aj.jwair@hashicorp.com>
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: lornasong <lornasong@users.noreply.github.com>
Co-authored-by: Melissa Kam <mkam@hashicorp.com>
2022-05-11 15:53:49 -07:00
Blake Covarrubias a74710fd45
docs: Remove unnecessary use of CodeBlockConfig (#12974)
Remove empty CodeBlockConfig elements. These elements are not
providing any benefit for the enclosed code blocks. This PR removes
the elements so so that the source is easier to read.
2022-05-11 15:37:02 -07:00
David Yu 4c3559bfe3
docs: Address comments from admin partitions docs changes around networking requirements (#13035)
* docs: Address comments from admin partitions changes

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2022-05-11 14:58:35 -07:00
Luke Kysow 374adc110a
Updates to fed docs for 0.43.0 (#13026)
* Updates to fed docs for 0.43.0
* Fix docs for VMs and for auth method
2022-05-11 10:11:45 -07:00
David Yu f368b856c8
docs: Update Admin Partitions with more explicit commands by using shell variables (#12966)
* docs: Update Admin Partitions with more explicit commands by using shell variables

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-05-11 09:27:58 -07:00
Dan Upton 310a881fb1
docs: add section to 1.12 upgrade notes about new TLS config style (#12880) 2022-05-11 10:28:52 +01:00
Robert 4bc4f8773d
docs: Fix small errors for node identities and acl-rules (#13016)
* Fix node identities `datacenter` description to string type
* Fix service rules URL anchor
2022-05-10 18:14:21 -07:00
Luke Kysow 941e20a2dd
Document consul_datacenter param. (#13009) 2022-05-10 11:04:13 -07:00
Blake Covarrubias 45ff0ebc91 docs: Clarify version restriction for snapshot restore
Clarify that Consul snapshots must be restored into clusters running
the same version as the cluster from where the snapshot was taken.
2022-05-10 10:50:37 -07:00
Jared Kirschner d335a2a711
Merge pull request #12366 from hashicorp/docs/uri-decode-resource-names-for-http-api
Document API ability to URL-decode resource names
2022-05-10 11:54:38 -04:00
Jared Kirschner 4de15e822f Document API ability to URL-decode resource names
All Consul HTTP API endpoints now URL-decode resource names specified in the
path, enabling resource names containing URL-invalid characters to be used
in HTTP API requests if URL-encoded into the path.

Functionality implemented in Github Pull Requests:
- #11335
- #11957
- #12103
- #12190
- #12297

Also documents CLI accepting URL-invalid resource names.

All Consul HTTP API endpoints now URL-decode resource names specified in the
path, enabling resource names containing URL-invalid characters to be used
in HTTP API requests if URL-encoded into the path. The Consul HTTP API always
supported URL-decoding of query parameters.

The CLI automatically URL-encodes arguments which are inserted as resource
names in the URL path, enabling the CLI to also interact with resource names
that contain URL-invalid characters.
2022-05-10 08:45:58 -07:00
Blake Covarrubias 13ac34c08b
docs: Fix spelling errors across site (#12973) 2022-05-10 07:28:33 -07:00
Jared Kirschner a18d7092cb
Merge pull request #12463 from hashicorp/docs/consistency-mode-improvements
Improve consistency mode docs
2022-05-09 23:04:00 -04:00
Jared Kirschner bc69d70a55 docs: clarify consistency mode operation
Changes include:
- Add diagrams of the operation of different consistency modes
- Note that only stale reads benefit from horizontal scaling
- Increase scannability with headings
- Document consistency mode defaults and how to override for
  DNS and HTTP API interfaces
- Document X-Consul-Effective-Consistency response header
2022-05-09 16:39:48 -07:00
David Yu f7a310e11d
docs: provide option for installing using a specific version via Helm (#12968)
* docs: provide option for installing using a specific version via Helm

Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-05-09 12:44:34 -07:00
Blake Covarrubias 01ef26dea0
docs: Redirect /docs/security/acl/acl-system (#12975)
/docs/security/acl/acl-system was renamed in e9a42df from PR #12460 to
/docs/security/acl. A corresponding redirect was not added for this
page, resulting in a 404 being returned when accessing the old URL
path.

This commit redirects the former URL path to the new location, and
also updates all links on the site to point to the new location.
2022-05-09 09:04:23 -07:00
Christopher Swenson 7fc91af8a2
docs: Fix broken links for roles and service identities (#12954) 2022-05-05 16:24:18 -07:00
Mark Anderson f4c4c0e9ae
Update website/content/docs/connect/config-entries/mesh.mdx (#12943)
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Signed-off-by: Mark Anderson <manderson@hashicorp.com>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-05-05 10:39:53 -07:00
Blake Covarrubias f315eee98f
docs: Restore agent config docs removed in PR #12562 (#12907)
* docs: Re-add config file content removed in PR #12562

Re-add agent config option content that was erroneously removed in #12562 with
commit f4c03d234.

* docs: Re-add CLI flag content removed in PR #12562

Re-add CLI flag content that was erroneously removed in #12562 with
commit c5220fd18.

* Update website/content/docs/agent/config/cli-flags.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-05-05 10:08:15 -07:00
Mark Anderson 18193f2916
Support vault namespaces in connect CA (#12904)
* Support vault namespaces in connect CA

Follow on to some missed items from #12655

From an internal ticket "Support standard "Vault namespace in the
path" semantics for Connect Vault CA Provider"

Vault allows the namespace to be specified as a prefix in the path of
a PKI definition, but our usage of the Vault API includes calls that
don't support a namespaced key. In particular the sys.* family of
calls simply appends the key, instead of prefixing the namespace in
front of the path.

Unfortunately it is difficult to reliably parse a path with a
namespace; only vault knows what namespaces are present, and the '/'
separator can be inside a key name, as well as separating path
elements. This is in use in the wild; for example
'dc1/intermediate-key' is a relatively common naming schema.

Instead we add two new fields: RootPKINamespace and
IntermediatePKINamespace, which are the absolute namespace paths
'prefixed' in front of the respective PKI Paths.

Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2022-05-04 19:41:55 -07:00
Mark Anderson e6282c7c64 Docs and changelog edits
Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2022-05-04 08:50:59 -07:00
Mark Anderson 33bc0a8cb3 Add some docs
Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2022-05-04 08:50:58 -07:00
Blake Covarrubias 8dc68002f9
docs: Add example Envoy escape hatch configs (#12764)
Add example escape hatch configurations for all supported override
types.
2022-05-02 11:25:59 -07:00
Jared Kirschner 304eb8a95d
Merge pull request #12762 from hashicorp/jkirschner-hashicorp-patch-1
docs: use correct previous name of recovery token
2022-04-29 18:35:56 -04:00
Jared Kirschner 4b315c6ffd
docs: fix typo 2022-04-29 17:57:21 -04:00
Jared Kirschner c8676a4564
Merge pull request #12893 from hashicorp/docs/improve-consul-server-resilience
docs: add guidance on improving Consul resilience
2022-04-29 15:42:09 -04:00
Jared Kirschner 2ab5559a6a docs: add guidance on improving Consul resilience
Discuss available strategies for improving server-level and infrastructure-level
fault tolerance in Consul.
2022-04-29 10:58:03 -07:00
Jeff-Apple 70e5ccfe59 Dcos: update for API Gateway v0.2.1 2022-04-29 09:52:00 -07:00
Jared Kirschner 3867ce2355
Merge pull request #11810 from hashicorp/update-enterprise-packaging-in-feature-docs
Update enterprise packaging in feature docs
2022-04-28 19:38:59 -04:00
Jared Kirschner 1e161b8c1b docs: improve ent overview headings 2022-04-28 16:27:34 -07:00
Jared Kirschner e4a66931a9 docs: explicitly fill all ent feature matrix cells 2022-04-28 12:41:37 -07:00
Jeff-Apple 04409f7164 Docs: updated versions on install page and other minor fixes. 2022-04-27 16:52:52 -07:00
Mike Morris 22c02b002d
website(consul-api-gateway): fixup stray div tag and step 8 link rendering (#12873) 2022-04-27 19:36:01 -04:00
Karl Cardenas 89c32164d7
docs: fixes makdown leakage 2022-04-27 14:15:39 -07:00
Jared Kirschner ce9e72778c docs: update HCP Consul feature matrix 2022-04-27 12:44:00 -07:00
Nathan Coleman a9a0416266 Update version pin for consul-api-gateway CRD install 2022-04-27 15:07:02 -04:00
Jeff Apple 1f8f4e5d27
Merge pull request #12863 from hashicorp/api-gateway-v0.2-docs
Update product docs for release of Consul API Gateway v0.2
2022-04-27 12:01:23 -07:00
Nathan Coleman 498b80b284 Update minimum Consul version in Tech Specs 2022-04-27 14:55:55 -04:00
Jeff-Apple d110933167 correction to the API Gateway 0.2 release notes. 2022-04-27 11:53:27 -07:00
Nathan Coleman 865fa7c480 Instruct user to update apiGateway.image in values.yaml 2022-04-27 14:47:15 -04:00
Jeff-Apple 14030b261e Adding release notes for API Gateway v0.2 2022-04-27 11:44:39 -07:00
Nathan Coleman f678d8aeda Hide clipboard for codeblocks that shouldn't be copied 2022-04-27 14:37:51 -04:00
trujillo-adam 48a2ef9722 hid copy fn for codeblocks that don't need it 2022-04-27 11:34:44 -07:00