Commit graph

4671 commits

Author SHA1 Message Date
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
Mike Morris 955f23628f
website(consul-api-gateway): add ReferencePolicy to overview docs (#12861)
* website(consul-api-gateway): add ReferencePolicy to overview docs

* website(consul-api-gateway): bump required Consul Helm chart version

For allowing Consul API Gateway controller to read ReferencePolicy
resources and UX improvement re-using connectInject.consulNamespaces
config for Consul API Gateway config.

* added referencepolicy documentation to route section

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com>

* Update consul-api-gateway-install.mdx

* Update consul-api-gateway-install.mdx

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

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

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

* Update website/content/docs/api-gateway/consul-api-gateway-install.mdx

* Update website/content/docs/api-gateway/index.mdx

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

* Update website/content/docs/api-gateway/index.mdx

* Update website/content/docs/api-gateway/index.mdx

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

Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com>
Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com>
Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2022-04-27 14:25:42 -04:00
Nathan Coleman 7f0755a4f1
Update website/content/docs/api-gateway/upgrade-specific-versions.mdx
Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-27 14:24:28 -04:00
Nathan Coleman 019907a51a
Update website/content/docs/api-gateway/upgrade-specific-versions.mdx
Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-27 14:23:57 -04:00
Nathan Coleman 0727a0f4fd
Update website/content/docs/api-gateway/upgrade-specific-versions.mdx
Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-27 14:23:48 -04:00
Nathan Coleman b7ba05197a
Update website/content/docs/api-gateway/upgrade-specific-versions.mdx
Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-27 14:14:36 -04:00
Nathan Coleman 7f8b9aa520
Update website/content/docs/api-gateway/upgrade-specific-versions.mdx
Co-authored-by: Karl Cardenas <kcardenas@hashicorp.com>
2022-04-27 14:14:27 -04:00
Nathan Coleman b5b4bd3f73 Update consul-api-gateway pin in installation instructions 2022-04-27 14:12:19 -04:00
Nathan Coleman 03456d84e8 Remove Consul pin from installation instructions
The consul-k8s chart has the correct version defaulted, and having it pinned here is another thing we have to include in all upgrade instructions
2022-04-27 14:11:51 -04:00
trujillo-adam ef0e29f350 edits to draft of upgrades 2022-04-27 11:03:14 -07:00
Jared Kirschner dd6d294651 docs: add missing space after ent feature matrix links 2022-04-27 09:46:53 -07:00
Jared Kirschner 62abd648ec docs: improve enterprise overview page
Move enterprise feature/package matrix back to the overview page.
Add descriptions for each enterprise feature that discuss use case.
2022-04-27 09:25:16 -07:00
Dan Upton e4008124bd
Upgrade Raft to v1.3.9 for saturation metrics (#12865) 2022-04-27 17:17:31 +01:00
Jared Kirschner e90b8316df docs: create enterprise feature/package matrix 2022-04-27 08:22:51 -07:00