Commit Graph

1189 Commits

Author SHA1 Message Date
Blake Covarrubias 21168aa617 Redirect /api-docs/acl/acl to the new URL 2022-05-13 10:37:16 -07:00
Blake Covarrubias 34b2f5daea Clarify purpose of example ACL rules and policies 2022-05-13 10:37:16 -07:00
Blake Covarrubias ab9c7d2dd4 Remove unnecessary quotes from HCL variables 2022-05-13 10:35:24 -07:00
Blake Covarrubias ddc09b661c Remove HCL examples of roles since only JSON payloads can be used 2022-05-13 10:35:24 -07:00
Blake Covarrubias 1ec836f6fe 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 b173147305
docs: add enterprise image (#13047) 2022-05-12 13:27:11 -07:00
Adrian Todorov a9ea7fb1f7
fix small typo in multi-cluster k8s installs docs 2022-05-12 19:46:45 +02:00
Michael Wilkerson 928fefd2a7
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 9378880c42
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 499fbdabaf
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 24e573edc8
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 4a2b61a1f4
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 1bac1544d0
docs: add section to 1.12 upgrade notes about new TLS config style (#12880) 2022-05-11 10:28:52 +01:00
Robert 2eb84b5d2c
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 11b12885f3
Document consul_datacenter param. (#13009) 2022-05-10 11:04:13 -07:00
Blake Covarrubias 4c0f840c89 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 05d1f59720
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 a5354b50fb 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 8edee753d1
docs: Fix spelling errors across site (#12973) 2022-05-10 07:28:33 -07:00
Jared Kirschner f4e1ade46a
Merge pull request #12463 from hashicorp/docs/consistency-mode-improvements
Improve consistency mode docs
2022-05-09 23:04:00 -04:00
Jared Kirschner 05a648f530 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 19d91de896
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 a78015c5fd
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 7dbe048dbf
docs: Fix broken links for roles and service identities (#12954) 2022-05-05 16:24:18 -07:00
Mark Anderson 7eda81d00d
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 20321402ce
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 c6ff4ba7d8
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 05dc5a26b7 Docs and changelog edits
Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2022-05-04 08:50:59 -07:00
Mark Anderson d7e7cb09dc Add some docs
Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2022-05-04 08:50:58 -07:00
Blake Covarrubias 54119f3225
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 cf12f8af20
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 c1aacc2728
docs: fix typo 2022-04-29 17:57:21 -04:00
Jared Kirschner 0028d927e3
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 de51780eb8 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 e8a1a1eb68 Dcos: update for API Gateway v0.2.1 2022-04-29 09:52:00 -07:00
Jared Kirschner d04fe6ca2c
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 964afedd13 docs: improve ent overview headings 2022-04-28 16:27:34 -07:00
Jared Kirschner 1ca903d28d docs: explicitly fill all ent feature matrix cells 2022-04-28 12:41:37 -07:00
Jeff-Apple 144a27da3d Docs: updated versions on install page and other minor fixes. 2022-04-27 16:52:52 -07:00
Mike Morris 80417f02dc
website(consul-api-gateway): fixup stray div tag and step 8 link rendering (#12873) 2022-04-27 19:36:01 -04:00
Karl Cardenas dbaed47da2
docs: fixes makdown leakage 2022-04-27 14:15:39 -07:00
Jared Kirschner 33ccefcc4e docs: update HCP Consul feature matrix 2022-04-27 12:44:00 -07:00
Nathan Coleman 8208c2daf9 Update version pin for consul-api-gateway CRD install 2022-04-27 15:07:02 -04:00
Jeff Apple 359d62a49d
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 1e84407681 Update minimum Consul version in Tech Specs 2022-04-27 14:55:55 -04:00
Jeff-Apple 24682ccc8a correction to the API Gateway 0.2 release notes. 2022-04-27 11:53:27 -07:00
Nathan Coleman 0104383203 Instruct user to update apiGateway.image in values.yaml 2022-04-27 14:47:15 -04:00
Jeff-Apple fb1dcc6eb1 Adding release notes for API Gateway v0.2 2022-04-27 11:44:39 -07:00
Nathan Coleman d039e0088f Hide clipboard for codeblocks that shouldn't be copied 2022-04-27 14:37:51 -04:00
trujillo-adam ac04a1251f hid copy fn for codeblocks that don't need it 2022-04-27 11:34:44 -07:00