From 6907c7e3db1d780505933427ff743d011ac79ceb Mon Sep 17 00:00:00 2001 From: Jeff Escalante Date: Mon, 13 Apr 2020 17:24:10 -0400 Subject: [PATCH] fix broken links --- website/_redirects | 1 + website/components/before-after/index.jsx | 26 ++++++++++++------- website/pages/api-docs/acl-legacy.mdx | 2 +- website/pages/api-docs/acl/index.mdx | 2 +- website/pages/api-docs/agent/service.mdx | 2 +- website/pages/api-docs/operator/area.mdx | 2 +- website/pages/discovery/index.jsx | 6 +++-- website/pages/docs/acl/acl-legacy.mdx | 6 ++--- website/pages/docs/acl/acl-rules.mdx | 4 +-- website/pages/docs/acl/acl-system.mdx | 24 ++++++++--------- website/pages/docs/agent/dns.mdx | 2 +- website/pages/docs/agent/options.mdx | 24 ++++++++--------- website/pages/docs/commands/connect/envoy.mdx | 2 +- website/pages/docs/connect/ca/index.mdx | 2 +- website/pages/docs/connect/proxies/envoy.mdx | 4 +-- website/pages/docs/guides/acl-legacy.mdx | 2 +- .../docs/guides/kuberenetes-deployment.mdx | 2 +- website/pages/docs/k8s/connect.mdx | 4 +-- website/pages/docs/k8s/helm.mdx | 4 +-- .../clients-outside-kubernetes.mdx | 2 +- website/pages/docs/k8s/installation/index.mdx | 2 +- website/pages/docs/k8s/service-sync.mdx | 4 +-- .../pages/docs/upgrading/upgrade-specific.mdx | 24 ++++++++--------- website/pages/home/index.jsx | 2 -- 24 files changed, 82 insertions(+), 73 deletions(-) diff --git a/website/_redirects b/website/_redirects index 7e01f0249c..337d21e901 100644 --- a/website/_redirects +++ b/website/_redirects @@ -154,6 +154,7 @@ /docs/connect/ca.html /docs/connect/ca 301! /docs/connect/native.html /docs/connect/native 301! /docs/connect/platform/nomad.html /docs/connect/nomad 301! +/docs/connect/platform/nomad /docs/connect/nomad 301! /docs/platform/k8s/run.html /docs/k8s/installation 301! /docs/platform/k8s/run /docs/k8s/installation 301! diff --git a/website/components/before-after/index.jsx b/website/components/before-after/index.jsx index 5ccd8a1888..3a009f5cbb 100644 --- a/website/components/before-after/index.jsx +++ b/website/components/before-after/index.jsx @@ -9,10 +9,10 @@ function BeforeAfterDiagram({ afterDescription, }) { return ( -
+
- - + + - +

{beforeHeading}

- {beforeSubTitle} - {beforeSubTitle} + {beforeSubTitle} + {beforeSubTitle} {beforeDescription &&

{beforeDescription}

}
- +

{afterHeading}

- {afterSubTitle} + {afterSubTitle}
- {afterSubTitle} + {afterSubTitle}
{afterDescription &&

{afterDescription}

}
diff --git a/website/pages/api-docs/acl-legacy.mdx b/website/pages/api-docs/acl-legacy.mdx index a7f28d1e2b..068d800e41 100644 --- a/website/pages/api-docs/acl-legacy.mdx +++ b/website/pages/api-docs/acl-legacy.mdx @@ -403,7 +403,7 @@ $ curl \ - `ReplicatedIndex` is the last index that was successfully replicated. You can compare this to the `X-Consul-Index` header returned by the - [`/v1/acl/list`](#acl_list) endpoint to determine if the replication process + [`/v1/acl/list`](#list-acls) endpoint to determine if the replication process has gotten all available ACLs. Replication runs as a background process approximately every 30 seconds, and that local updates are rate limited to 100 updates/second, so so it may take several minutes to perform the initial sync diff --git a/website/pages/api-docs/acl/index.mdx b/website/pages/api-docs/acl/index.mdx index f6feda0b0f..d4542091c5 100644 --- a/website/pages/api-docs/acl/index.mdx +++ b/website/pages/api-docs/acl/index.mdx @@ -155,7 +155,7 @@ $ curl \ - `ReplicatedIndex` - The last index that was successfully replicated. Which data the replicated index refers to depends on the replication type. For `legacy` replication this can be compared with the value of the `X-Consul-Index` header - returned by the [`/v1/acl/list`](/api/acl/legacy#acl_list) endpoint to + returned by the [`/v1/acl/list`](/api/acl/legacy#list-acls) endpoint to determine if the replication process has gotten all available ACLs. When in either `tokens` or `policies` mode, this index can be compared with the value of the `X-Consul-Index` header returned by the [`/v1/acl/policies`](/api/acl/policies#list-policies) diff --git a/website/pages/api-docs/agent/service.mdx b/website/pages/api-docs/agent/service.mdx index 935cd052a6..852c6df360 100644 --- a/website/pages/api-docs/agent/service.mdx +++ b/website/pages/api-docs/agent/service.mdx @@ -257,7 +257,7 @@ Those endpoints might be useful for the following use-cases: ##### Note If you know the ID of service you want to target, it is recommended to use -[`/v1/agent/health/service/id/:service_id`](/api/agent/service#get-local-service-health-by-id) +[`/v1/agent/health/service/id/:service_id`](/api/agent/service#get-local-service-health-by-its-id) so you have the result for the service only. When requesting `/v1/agent/health/service/name/:service_name`, the caller will receive the worst state of all services having the given name. diff --git a/website/pages/api-docs/operator/area.mdx b/website/pages/api-docs/operator/area.mdx index e06302f827..413cc948da 100644 --- a/website/pages/api-docs/operator/area.mdx +++ b/website/pages/api-docs/operator/area.mdx @@ -63,7 +63,7 @@ The table below shows this endpoint's support for `hostname:port`. Consul will spawn a background task that tries to periodically join the servers in this list and will run until a join succeeds. If this list is not supplied, joining can be done with a call to the - [join endpoint](#area-join) once the network area is created. + [join endpoint](#join-network-area) once the network area is created. - `UseTLS` `(bool: )` - Specifies whether gossip over this area should be encrypted with TLS if possible. diff --git a/website/pages/discovery/index.jsx b/website/pages/discovery/index.jsx index 97285dfca3..c950825f5a 100644 --- a/website/pages/discovery/index.jsx +++ b/website/pages/discovery/index.jsx @@ -422,8 +422,9 @@ $ curl http://localhost:8500/v1/catalog/datacenters 'Twitch - Driving Towards a Modern Infrastructure', description: 'In this talk from HashiConf 2015, Tarrant Rollins discusses how Twitch uses HashiCorp Consul to overcome legacy infrastructure and solve complex problems.', + caseStudyLink: + 'https://www.hashicorp.com/resources/twitch-driving-towards-a-modern-infrastructure', caseStudyResource: { - slug: 'twitch-driving-towards-a-modern-infrastructure', image: { url: '/img/consul-connect/case-studies/case-study_01.jpg', @@ -452,8 +453,9 @@ $ curl http://localhost:8500/v1/catalog/datacenters 'Jet.com - Nomad Auto-Proxy with Consul-Template and NGINX', description: 'Justen Walker explains how Jet.com uses HashiCorp Consul and Nomad to allow hundreds of developers to have self-service access, despite relying on NGINX static configs—and with a remarkably small DevOps team.', + caseStudyLink: + 'https://www.hashicorp.com/resources/jet-com-nomad-auto-proxy-consul-template-nginx', caseStudyResource: { - slug: 'jet-com-nomad-auto-proxy-consul-template-nginx', image: { url: '/img/consul-connect/case-studies/case-study_02.jpg', diff --git a/website/pages/docs/acl/acl-legacy.mdx b/website/pages/docs/acl/acl-legacy.mdx index 36b5872882..ca2378108e 100644 --- a/website/pages/docs/acl/acl-legacy.mdx +++ b/website/pages/docs/acl/acl-legacy.mdx @@ -955,7 +955,7 @@ here, with examples: that is used and known by many clients to provide geo-failover behavior for a database. -- [Template queries](/api/query#templates) +- [Template queries](/api/query#prepared-query-templates) queries work like static queries with a `Name` defined, except that a catch-all template with an empty `Name` requires an ACL token that can write to any query prefix. @@ -1115,7 +1115,7 @@ a large set of ACLs. If there's a partition or other outage affecting the authoritative datacenter, and the [`acl_down_policy`](/docs/agent/options#acl_down_policy) is set to "extend-cache", tokens will be resolved during the outage using the -replicated set of ACLs. An [ACL replication status](/api/acl/acl#acl_replication_status) +replicated set of ACLs. An [ACL replication status](/api/acl/acl#check-acl-replication) endpoint is available to monitor the health of the replication process. Also note that in recent versions of Consul (greater than 1.2.0), using `acl_down_policy = "async-cache"` refreshes token asynchronously when an ACL is @@ -1133,7 +1133,7 @@ using a process like this: 1. Enable ACL replication in all datacenters to allow continuation of service during the migration, and to populate the target datacenter. Verify replication is healthy and caught up to the current ACL index in the target datacenter - using the [ACL replication status](/api/acl/acl#acl_replication_status) + using the [ACL replication status](/api/acl/acl#check-acl-replication) endpoint. 2. Turn down the old authoritative datacenter servers. 3. Rolling restart the agents in the target datacenter and change the diff --git a/website/pages/docs/acl/acl-rules.mdx b/website/pages/docs/acl/acl-rules.mdx index db8488d219..086eb805db 100644 --- a/website/pages/docs/acl/acl-rules.mdx +++ b/website/pages/docs/acl/acl-rules.mdx @@ -44,7 +44,7 @@ Policies can have several control levels: - `read`: allow the resource to be read but not modified. - `write`: allow the resource to be read and modified. - `deny`: do not allow the resource to be read or modified. -- `list`: allows access to all the keys under a segment in the Consul KV. Note, this policy can only be used with the `key_prefix` resource and [`acl.enable_key_list_policy`](/docs/agent/options#acl_enable_key_list) must be set to true. +- `list`: allows access to all the keys under a segment in the Consul KV. Note, this policy can only be used with the `key_prefix` resource and [`acl.enable_key_list_policy`](/docs/agent/options#acl_enable_key_list_policy) must be set to true. When using prefix-based rules, the most specific prefix match determines the action. This allows for flexible rules like an empty prefix to allow read-only access to all @@ -413,7 +413,7 @@ here, with examples: that is used and known by many clients to provide geo-failover behavior for a database. -- [Template queries](/api/query#templates) +- [Template queries](/api/query#prepared-query-templates) queries work like static queries with a `Name` defined, except that a catch-all template with an empty `Name` requires an ACL token that can write to any query prefix. diff --git a/website/pages/docs/acl/acl-system.mdx b/website/pages/docs/acl/acl-system.mdx index a5f9dd46c8..b67a6c7e1a 100644 --- a/website/pages/docs/acl/acl-system.mdx +++ b/website/pages/docs/acl/acl-system.mdx @@ -198,18 +198,18 @@ be used to explicitly deny access to resources. The following table summarizes the ACL resources that are available for constructing rules: -| Resource | Scope | -| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acl`](#acl-rules) | Operations for managing the ACL system [ACL API](/api/acl/acl) | -| [`agent`](#agent-rules) | Utility operations in the [Agent API](/api/agent), other than service and check registration | -| [`event`](#event-rules) | Listing and firing events in the [Event API](/api/event) | -| [`key`](#key-value-rules) | Key/value store operations in the [KV Store API](/api/kv) | -| [`keyring`](#keyring-rules) | Keyring operations in the [Keyring API](/api/operator/keyring) | -| [`node`](#node-rules) | Node-level catalog operations in the [Catalog API](/api/catalog), [Health API](/api/health), [Prepared Query API](/api/query), [Network Coordinate API](/api/coordinate), and [Agent API](/api/agent) | -| [`operator`](#operator-rules) | Cluster-level operations in the [Operator API](/api/operator), other than the [Keyring API](/api/operator/keyring) | -| [`query`](#prepared-query-rules) | Prepared query operations in the [Prepared Query API](/api/query) | -| [`service`](#service-rules) | Service-level catalog operations in the [Catalog API](/api/catalog), [Health API](/api/health), [Prepared Query API](/api/query), and [Agent API](/api/agent) | -| [`session`](#session-rules) | Session operations in the [Session API](/api/session) | +| Resource | Scope | +| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`acl`](/docs/acl/acl-rules#acl-resource-rules) | Operations for managing the ACL system [ACL API](/api/acl/acl) | +| [`agent`](/docs/acl/acl-rules#agent-rules) | Utility operations in the [Agent API](/api/agent), other than service and check registration | +| [`event`](/docs/acl/acl-rules#event-rules) | Listing and firing events in the [Event API](/api/event) | +| [`key`](/docs/acl/acl-rules#key-value-rules) | Key/value store operations in the [KV Store API](/api/kv) | +| [`keyring`](/docs/acl/acl-rules#keyring-rules) | Keyring operations in the [Keyring API](/api/operator/keyring) | +| [`node`](/docs/acl/acl-rules#node-rules) | Node-level catalog operations in the [Catalog API](/api/catalog), [Health API](/api/health), [Prepared Query API](/api/query), [Network Coordinate API](/api/coordinate), and [Agent API](/api/agent) | +| [`operator`](/docs/acl/acl-rules#operator-rules) | Cluster-level operations in the [Operator API](/api/operator), other than the [Keyring API](/api/operator/keyring) | +| [`query`](/docs/acl/acl-rules#prepared-query-rules) | Prepared query operations in the [Prepared Query API](/api/query) | +| [`service`](/docs/acl/acl-rules#service-rules) | Service-level catalog operations in the [Catalog API](/api/catalog), [Health API](/api/health), [Prepared Query API](/api/query), and [Agent API](/api/agent) | +| [`session`](/docs/acl/acl-rules#session-rules) | Session operations in the [Session API](/api/session) | Since Consul snapshots actually contain ACL tokens, the [Snapshot API](/api/snapshot) requires a token with "write" privileges for the ACL system. diff --git a/website/pages/docs/agent/dns.mdx b/website/pages/docs/agent/dns.mdx index d139bd90a6..b4b893640d 100644 --- a/website/pages/docs/agent/dns.mdx +++ b/website/pages/docs/agent/dns.mdx @@ -224,7 +224,7 @@ The `query or name` is the ID or given name of an existing queries but provide a much richer set of features, such as filtering by multiple tags and automatically failing over to look for services in remote datacenters if no healthy nodes are available in the local datacenter. Consul 0.6.4 and later also -added support for [prepared query templates](/api/query#templates) +added support for [prepared query templates](/api/query#prepared-query-templates) which can match names using a prefix match, allowing one template to apply to potentially many services. diff --git a/website/pages/docs/agent/options.mdx b/website/pages/docs/agent/options.mdx index 42a314c648..79b696d5c6 100644 --- a/website/pages/docs/agent/options.mdx +++ b/website/pages/docs/agent/options.mdx @@ -298,7 +298,7 @@ The options below are all specified on the command-line. [go-sockaddr](https://godoc.org/github.com/hashicorp/go-sockaddr/template) template -- `-retry-join` - Similar to [`-join`](#_join) but allows retrying a join until +- `-retry-join` ((#\_retry_join)) - Similar to [`-join`](#_join) but allows retrying a join until it is successful. Once it joins successfully to a member in a list of members it will never attempt to join again. Agents will then solely maintain their membership via gossip. This is useful for cases where you know the address will @@ -1461,7 +1461,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." to use for automatically assigned [exposed check listeners](/docs/connect/registration/service-registration#expose-paths-configuration-reference). Default 21755. Set to `0` to disable automatic port assignment. -- `primary_datacenter` ((#primary_datacenter)) - This designates the datacenter +- `primary_datacenter` - This designates the datacenter which is authoritative for ACL information, intentions and is the root Certificate Authority for Connect. It must be provided to enable ACLs. All servers and datacenters must agree on the primary datacenter. Setting it on the servers is all you need @@ -1469,14 +1469,14 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." it must be set on them too. In Consul 0.8 and later, this also enables agent-level enforcement of ACLs. -- `primary_gateways` ((#primary_gateways)) Equivalent to the [`-primary-gateway` +- `primary_gateways` Equivalent to the [`-primary-gateway` command-line flag](#_primary_gateway). Takes a list of addresses to use as the mesh gateways for the primary datacenter when authoritative replicated catalog - data is not present. Discovery happens every [`primary_gateways_interval`](#_primary_gateways_interval) + data is not present. Discovery happens every [`primary_gateways_interval`](#primary_gateways_interval) until at least one primary mesh gateway is discovered. This was added in Consul 1.8.x **TODO(wanfed)**. -- `primary_gateways_interval` ((#primary_gateways_interval)) Time to wait +- `primary_gateways_interval` Time to wait between [`primary_gateways`](#primary_gateways) discovery attempts. Defaults to 30s. This was added in Consul 1.8.x **TODO(wanfed)**. @@ -1486,7 +1486,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." - `raft_protocol` ((#raft_protocol)) Equivalent to the [`-raft-protocol` command-line flag](#_raft_protocol). -- `raft_snapshot_threshold` This controls +- `raft_snapshot_threshold` ((#\_raft_snapshot_threshold)) This controls the minimum number of raft commit entries between snapshots that are saved to disk. This is a low-level parameter that should rarely need to be changed. Very busy clusters experiencing excessive disk IO may increase this value to reduce disk @@ -1497,7 +1497,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." significantly as more logs will need to be replayed. In Consul 1.1.0 and later this defaults to 16384, and in prior versions it was set to 8192. -- `raft_snapshot_interval` This controls how often servers check if they +- `raft_snapshot_interval` ((#\_raft_snapshot_interval)) This controls how often servers check if they need to save a snapshot to disk. This is a low-level parameter that should rarely need to be changed. Very busy clusters experiencing excessive disk IO may increase this value to reduce disk IO, and minimize the chances of all servers taking snapshots at the same time. Increasing this trades off disk IO for disk space since the log will grow much larger and the space in the raft.db file can't be reclaimed till the next snapshot. Servers may take longer to recover from crashes or failover if this is increased significantly as more logs will need to be replayed. In Consul 1.1.0 and later this defaults to `30s`, and in prior versions it was set to `5s`. @@ -1766,11 +1766,11 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'." The following endpoints translate addresses: - - [`/v1/catalog/nodes`](/api/catalog#catalog_nodes) - - [`/v1/catalog/node/`](/api/catalog#catalog_node) - - [`/v1/catalog/service/`](/api/catalog#catalog_service) - - [`/v1/health/service/`](/api/health#health_service) - - [`/v1/query//execute`](/api/query#execute) + - [`/v1/catalog/nodes`](/api/catalog#list-nodes) + - [`/v1/catalog/node/`](/api/catalog#retrieve-map-of-services-for-a-node) + - [`/v1/catalog/service/`](/api/catalog#list-nodes-for-service) + - [`/v1/health/service/`](/api/health#list-nodes-for-service) + - [`/v1/query//execute`](/api/query#execute-prepared-query) - `ui` - Equivalent to the [`-ui`](#_ui) command-line flag. diff --git a/website/pages/docs/commands/connect/envoy.mdx b/website/pages/docs/commands/connect/envoy.mdx index 8f1d2c6725..2f18d6a77f 100644 --- a/website/pages/docs/commands/connect/envoy.mdx +++ b/website/pages/docs/commands/connect/envoy.mdx @@ -81,7 +81,7 @@ proxy configuration needed. directly through to the `envoy` invocation. See [Envoy's documentation](https://www.envoyproxy.io/docs) for more details. The command always specifies `--config-file` and `--v2-config-only` and by default passes - `--disable-hot-restart` see [hot restart](#hot-restart). + `--disable-hot-restart` see [hot restart](#envoy-hot-restart). #### Envoy Sidecar Proxy Options diff --git a/website/pages/docs/connect/ca/index.mdx b/website/pages/docs/connect/ca/index.mdx index 135b2156da..fd60353c14 100644 --- a/website/pages/docs/connect/ca/index.mdx +++ b/website/pages/docs/connect/ca/index.mdx @@ -26,7 +26,7 @@ Consul will support pluggable CA systems using external binaries. CA initialization happens automatically when a new Consul leader is elected as long as -[Connect is enabled](/docs/connect/configuration#enable-connect-on-the-cluster) +[Connect is enabled](/docs/connect/configuration#agent-configuration) and the CA system hasn't already been initialized. This initialization process will generate the initial root certificates and setup the internal Consul server state. diff --git a/website/pages/docs/connect/proxies/envoy.mdx b/website/pages/docs/connect/proxies/envoy.mdx index 6eca62bc36..2accdda7c6 100644 --- a/website/pages/docs/connect/proxies/envoy.mdx +++ b/website/pages/docs/connect/proxies/envoy.mdx @@ -46,7 +46,7 @@ compatible Envoy versions. [CVE-2019-9901](https://github.com/envoyproxy/envoy/issues/6435). Both are related to HTTP request parsing and so only affect Consul Connect users if they have configured HTTP routing rules via the ["escape -hatch"](#custom-configuration). Still, we recommend that you use the most +hatch"](#escape-hatch-overrides). Still, we recommend that you use the most recent supported Envoy for your Consul version where possible. - Envoy 1.10.0 requires setting [`-envoy-version`](/docs/commands/connect/envoy#envoy-version) in the `consul connect envoy` command. This was introduced in Consul 1.7.0. @@ -284,7 +284,7 @@ definition](/docs/connect/registration/service-registration) or These fields may also be overridden explicitly in the [proxy service definition](/docs/connect/registration/service-registration), or defined in the [global `proxy-defaults` configuration -entry](/docs/agent/config_entries#proxy-defaults-proxy-defaults) to act as +entry](/docs/agent/config_entries/proxy-defaults) to act as defaults that are inherited by all services. Prior to 1.8.0 these settings were specific to Mesh Gateways. The deprecated diff --git a/website/pages/docs/guides/acl-legacy.mdx b/website/pages/docs/guides/acl-legacy.mdx index 8e2d75e13e..5f0cf7871c 100644 --- a/website/pages/docs/guides/acl-legacy.mdx +++ b/website/pages/docs/guides/acl-legacy.mdx @@ -943,7 +943,7 @@ here, with examples: that is used and known by many clients to provide geo-failover behavior for a database. -- [Template queries](/api/query#templates) +- [Template queries](/api/query#prepared-query-templates) queries work like static queries with a `Name` defined, except that a catch-all template with an empty `Name` requires an ACL token that can write to any query prefix. diff --git a/website/pages/docs/guides/kuberenetes-deployment.mdx b/website/pages/docs/guides/kuberenetes-deployment.mdx index 1a400e1604..8ec427de3a 100644 --- a/website/pages/docs/guides/kuberenetes-deployment.mdx +++ b/website/pages/docs/guides/kuberenetes-deployment.mdx @@ -31,7 +31,7 @@ You can deploy a complete Consul datacenter using the official Helm chart. By default, the chart will install three Consul servers and client on all Kubernetes nodes. You can review the [Helm chart -values](https://www.consul.io/docs/platform/k8s/helm.html#configuration-values-) +values](https://www.consul.io/docs/platform/k8s/helm.html#configuration-values) to learn more about the default settings. ### Download the Helm Chart diff --git a/website/pages/docs/k8s/connect.mdx b/website/pages/docs/k8s/connect.mdx index 1ce708b839..2182eea326 100644 --- a/website/pages/docs/k8s/connect.mdx +++ b/website/pages/docs/k8s/connect.mdx @@ -227,7 +227,7 @@ Annotations can be used to configure the injection behavior. ~> **WARNING:** Setting a namespace when not using Consul Enterprise or using a version < 1.7 is not supported. It will be treated as part of the service name. - - [Prepared Query](/docs/connect/proxies#upstreams) + - [Prepared Query](/docs/connect/proxies#dynamic-upstreams-require-native-integration) ```yaml annotations: @@ -326,7 +326,7 @@ Installation of the mutating admission webhook is automated using the [Helm chart](/docs/platform/k8s/run). To install the Connect injector, enable the Connect injection feature using -[Helm values](/docs/platform/k8s/helm#configuration-values-) and +[Helm values](/docs/platform/k8s/helm#configuration-values) and upgrade the installation using `helm upgrade` for existing installs or `helm install` for a fresh install. The Connect injector **also requires** [client agents](/docs/platform/k8s/helm#v-client) are enabled on diff --git a/website/pages/docs/k8s/helm.mdx b/website/pages/docs/k8s/helm.mdx index 36b2f0076f..65c0387ea1 100644 --- a/website/pages/docs/k8s/helm.mdx +++ b/website/pages/docs/k8s/helm.mdx @@ -423,7 +423,7 @@ and consider if they're appropriate for your deployment. to run. - `configSecret` ((#v-client-snapshotagent-configsecret)) - A Kubernetes secret that should be - manually created to contain the entire config to be used on the snapshot agent. This is the preferred method of configuration since there are usually storage credentials present. Please see [Snapshot agent config](/docs/commands/snapshot/agent#config-file-options-) for details. + manually created to contain the entire config to be used on the snapshot agent. This is the preferred method of configuration since there are usually storage credentials present. Please see [Snapshot agent config](/docs/commands/snapshot/agent#config-file-options) for details. - secretName ((#v-client-snapshotagent-configsecret-secretname)) `(string: null)` - The name of the Kubernetes secret. @@ -448,7 +448,7 @@ and consider if they're appropriate for your deployment. resources necessary for the catalog sync process to run. - `image` ((#v-synccatalog-image)) (`string: global.imageK8S`) - The name of the Docker image - (including any tag) for [consul-k8s](/docs/platform/k8s#quot-consul-k8s-quot-project) + (including any tag) for [consul-k8s](/docs/platform/k8s#getting-started-with-consul-and-kubernetes) to run the sync program. - `default` ((#v-synccatalog-default)) (`boolean: true`) - If true, all valid services in K8S are diff --git a/website/pages/docs/k8s/installation/clients-outside-kubernetes.mdx b/website/pages/docs/k8s/installation/clients-outside-kubernetes.mdx index 483a174d65..698d885cb9 100644 --- a/website/pages/docs/k8s/installation/clients-outside-kubernetes.mdx +++ b/website/pages/docs/k8s/installation/clients-outside-kubernetes.mdx @@ -14,7 +14,7 @@ Consul clients running on non-Kubernetes nodes can join a Consul cluster running ## Auto-join The recommended way to join a cluster running within Kubernetes is to -use the ["k8s" cloud auto-join provider](/docs/agent/cloud-auto-join#kubernetes-k8s-). +use the ["k8s" cloud auto-join provider](/docs/agent/cloud-auto-join#kubernetes-k8s). The auto-join provider dynamically discovers IP addresses to join using the Kubernetes API. It authenticates with Kubernetes using a standard diff --git a/website/pages/docs/k8s/installation/index.mdx b/website/pages/docs/k8s/installation/index.mdx index 9a4a8c1a40..1e8820d1df 100644 --- a/website/pages/docs/k8s/installation/index.mdx +++ b/website/pages/docs/k8s/installation/index.mdx @@ -42,7 +42,7 @@ upgrade, etc. the Consul cluster. The Helm chart has no required configuration and will install a Consul cluster with sane defaults out of the box. Prior to going to production, it is highly recommended that you -[learn about the configuration options](/docs/platform/k8s/helm#configuration-values-). +[learn about the configuration options](/docs/platform/k8s/helm#configuration-values). ~> **Security Warning:** By default, the chart will install an insecure configuration of Consul. This provides a less complicated out-of-box experience for new users, diff --git a/website/pages/docs/k8s/service-sync.mdx b/website/pages/docs/k8s/service-sync.mdx index b53980c39b..89b64d3d10 100644 --- a/website/pages/docs/k8s/service-sync.mdx +++ b/website/pages/docs/k8s/service-sync.mdx @@ -44,7 +44,7 @@ with the address to a Consul agent as well as any additional access information such as ACL tokens. To install the sync process, enable the catalog sync feature using -[Helm values](/docs/platform/k8s/helm#configuration-values-) and +[Helm values](/docs/platform/k8s/helm#configuration-values) and upgrade the installation using `helm upgrade` for existing installs or `helm install` for a fresh install. @@ -156,7 +156,7 @@ is routable and configured by some other system. ClusterIP services are synced by default as of `consul-k8s` version 0.3.0. In many Kubernetes clusters, ClusterIPs may not be accessible outside of the cluster, so you may end up with services registered in Consul that are not routable. To -skip syncing ClusterIP services, set [`syncClusterIPServices`](/docs/platform/k8s/helm#v-synccatalog-clusterip-sync) +skip syncing ClusterIP services, set [`syncClusterIPServices`](/docs/platform/k8s/helm#v-synccatalog-syncclusteripservices) to `false` in the Helm chart values file. ### Sync Enable/Disable diff --git a/website/pages/docs/upgrading/upgrade-specific.mdx b/website/pages/docs/upgrading/upgrade-specific.mdx index 534e454619..6695cbca61 100644 --- a/website/pages/docs/upgrading/upgrade-specific.mdx +++ b/website/pages/docs/upgrading/upgrade-specific.mdx @@ -343,15 +343,15 @@ upgrading. Here's the complete list of removed options and their equivalents: | Removed Option | Equivalent | | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `-dc` | [`-datacenter`](/docs/agent/options#_datacenter) | -| `-retry-join-azure-tag-name` | [`-retry-join`](/docs/agent/options#microsoft-azure) | -| `-retry-join-azure-tag-value` | [`-retry-join`](/docs/agent/options#microsoft-azure) | -| `-retry-join-ec2-region` | [`-retry-join`](/docs/agent/options#amazon-ec2) | -| `-retry-join-ec2-tag-key` | [`-retry-join`](/docs/agent/options#amazon-ec2) | -| `-retry-join-ec2-tag-value` | [`-retry-join`](/docs/agent/options#amazon-ec2) | -| `-retry-join-gce-credentials-file` | [`-retry-join`](/docs/agent/options#google-compute-engine) | -| `-retry-join-gce-project-name` | [`-retry-join`](/docs/agent/options#google-compute-engine) | -| `-retry-join-gce-tag-name` | [`-retry-join`](/docs/agent/options#google-compute-engine) | -| `-retry-join-gce-zone-pattern` | [`-retry-join`](/docs/agent/options#google-compute-engine) | +| `-retry-join-azure-tag-name` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-azure-tag-value` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-ec2-region` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-ec2-tag-key` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-ec2-tag-value` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-gce-credentials-file` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-gce-project-name` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-gce-tag-name` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `-retry-join-gce-zone-pattern` | [`-retry-join`](/docs/agent/options#_retry_join) | | `addresses.rpc` | None, the RPC server for CLI commands is no longer supported. | | `advertise_addrs` | [`ports`](/docs/agent/options#ports) with [`advertise_addr`](/docs/agent/options#advertise_addr) and/or [`advertise_addr_wan`](/docs/agent/options#advertise_addr_wan) | | `dogstatsd_addr` | [`telemetry.dogstatsd_addr`](/docs/agent/options#telemetry-dogstatsd_addr) | @@ -359,9 +359,9 @@ upgrading. Here's the complete list of removed options and their equivalents: | `http_api_response_headers` | [`http_config.response_headers`](/docs/agent/options#response_headers) | | `ports.rpc` | None, the RPC server for CLI commands is no longer supported. | | `recursor` | [`recursors`](https://github.com/hashicorp/consul/blob/master/website/pages/docs/agent/options.mdx#recursors) | -| `retry_join_azure` | [`-retry-join`](/docs/agent/options#microsoft-azure) | -| `retry_join_ec2` | [`-retry-join`](/docs/agent/options#amazon-ec2) | -| `retry_join_gce` | [`-retry-join`](/docs/agent/options#google-compute-engine) | +| `retry_join_azure` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `retry_join_ec2` | [`-retry-join`](/docs/agent/options#_retry_join) | +| `retry_join_gce` | [`-retry-join`](/docs/agent/options#_retry_join) | | `statsd_addr` | [`telemetry.statsd_address`](https://github.com/hashicorp/consul/blob/master/website/pages/docs/agent/options.mdx#telemetry-statsd_address) | | `statsite_addr` | [`telemetry.statsite_address`](https://github.com/hashicorp/consul/blob/master/website/pages/docs/agent/options.mdx#telemetry-statsite_address) | | `statsite_prefix` | [`telemetry.metrics_prefix`](/docs/agent/options#telemetry-metrics_prefix) | diff --git a/website/pages/home/index.jsx b/website/pages/home/index.jsx index d9dfcf4d0a..e2599802f4 100644 --- a/website/pages/home/index.jsx +++ b/website/pages/home/index.jsx @@ -25,7 +25,6 @@ export default function HomePage() { url: '/downloads', external: false, theme: '', - gaPrefix: null, }, { title: 'Get Started', @@ -33,7 +32,6 @@ export default function HomePage() { 'https://learn.hashicorp.com/consul/getting-started/install', external: false, theme: '', - gaPrefix: null, }, ], helpText: