From 18a5edd23265566e3a8c0e8953c870080b36185b Mon Sep 17 00:00:00 2001 From: cui fliter Date: Tue, 1 Aug 2023 01:56:09 +0800 Subject: [PATCH] docs: Fix some comments (#17118) Signed-off-by: cui fliter --- agent/connect/ca/provider.go | 2 +- agent/connect/parsing.go | 2 +- agent/consul/auto_config_backend.go | 2 +- agent/consul/prepared_query_endpoint_test.go | 2 +- agent/consul/server.go | 2 +- agent/consul/state/catalog.go | 4 ++-- agent/consul/state/catalog_events.go | 2 +- agent/proxycfg/proxycfg.go | 2 +- agent/structs/acl.go | 2 +- agent/structs/prepared_query.go | 2 +- agent/xds/delta.go | 2 +- command/connect/envoy/bootstrap_tpl.go | 2 +- connect/tls.go | 2 +- envoyextensions/extensioncommon/envoy_extender.go | 2 +- proto/private/pbpeering/peering.pb.go | 2 +- proto/private/pbpeering/peering.proto | 2 +- sdk/iptables/iptables.go | 2 +- test/integration/connect/envoy/case-stats-proxy/verify.bats | 2 +- website/content/api-docs/acl/index.mdx | 2 +- website/content/api-docs/catalog.mdx | 2 +- website/content/api-docs/status.mdx | 2 +- website/content/commands/connect/envoy.mdx | 2 +- website/content/commands/debug.mdx | 2 +- website/content/commands/snapshot/agent.mdx | 2 +- website/content/docs/agent/config/cli-flags.mdx | 2 +- website/content/docs/agent/config/config-files.mdx | 2 +- website/content/docs/agent/telemetry.mdx | 4 ++-- website/content/docs/api-gateway/configuration/routes.mdx | 2 +- website/content/docs/api-gateway/tech-specs.mdx | 2 +- website/content/docs/dynamic-app-config/kv.mdx | 2 +- website/content/docs/ecs/manual/secure-configuration.mdx | 4 ++-- .../docs/k8s/connect/cluster-peering/usage/manage-peering.mdx | 4 ++-- website/content/docs/nia/configuration.mdx | 2 +- website/content/docs/nia/usage/errors-ref.mdx | 2 +- .../content/docs/release-notes/consul-api-gateway/v0_1_x.mdx | 2 +- website/content/docs/security/acl/acl-roles.mdx | 4 ++-- website/content/docs/security/acl/auth-methods/index.mdx | 2 +- website/content/docs/upgrading/upgrade-specific.mdx | 2 +- 38 files changed, 43 insertions(+), 43 deletions(-) diff --git a/agent/connect/ca/provider.go b/agent/connect/ca/provider.go index 2ef34228bc..d8061005e9 100644 --- a/agent/connect/ca/provider.go +++ b/agent/connect/ca/provider.go @@ -152,7 +152,7 @@ type PrimaryProvider interface { SignIntermediate(*x509.CertificateRequest) (string, error) // CrossSignCA must accept a CA certificate from another CA provider and cross - // sign it exactly as it is such that it forms a chain back the the + // sign it exactly as it is such that it forms a chain back the // CAProvider's current root. Specifically, the Distinguished Name, Subject // Alternative Name, SubjectKeyID and other relevant extensions must be kept. // The resulting certificate must have a distinct Serial Number and the diff --git a/agent/connect/parsing.go b/agent/connect/parsing.go index a89544532f..d0eb55d7b0 100644 --- a/agent/connect/parsing.go +++ b/agent/connect/parsing.go @@ -148,7 +148,7 @@ func ParseSigner(pemValue string) (crypto.Signer, error) { } // ParseCSR parses a CSR from a PEM-encoded value. The certificate request -// must be the the first block in the PEM value. +// must be the first block in the PEM value. func ParseCSR(pemValue string) (*x509.CertificateRequest, error) { // The _ result below is not an error but the remaining PEM bytes. block, _ := pem.Decode([]byte(pemValue)) diff --git a/agent/consul/auto_config_backend.go b/agent/consul/auto_config_backend.go index 78413fe012..f56e4249bd 100644 --- a/agent/consul/auto_config_backend.go +++ b/agent/consul/auto_config_backend.go @@ -34,7 +34,7 @@ func (b autoConfigBackend) GetCARoots() (*structs.IndexedCARoots, error) { } // DatacenterJoinAddresses will return all the strings suitable for usage in -// retry join operations to connect to the the LAN or LAN segment gossip pool. +// retry join operations to connect to the LAN or LAN segment gossip pool. func (b autoConfigBackend) DatacenterJoinAddresses(partition, segment string) ([]string, error) { members, err := b.Server.LANMembers(LANMemberFilter{ Segment: segment, diff --git a/agent/consul/prepared_query_endpoint_test.go b/agent/consul/prepared_query_endpoint_test.go index af1fd65a87..f8dae39b0a 100644 --- a/agent/consul/prepared_query_endpoint_test.go +++ b/agent/consul/prepared_query_endpoint_test.go @@ -2808,7 +2808,7 @@ func TestPreparedQuery_Wrapper(t *testing.T) { t.Fatalf("bad: %v", ret) } // Since we have no idea when the joinWAN operation completes - // we keep on querying until the the join operation completes. + // we keep on querying until the join operation completes. retry.Run(t, func(r *retry.R) { r.Check(s1.forwardDC("Status.Ping", "dc2", &struct{}{}, &struct{}{})) }) diff --git a/agent/consul/server.go b/agent/consul/server.go index 6e5ea29da0..032eb00bd9 100644 --- a/agent/consul/server.go +++ b/agent/consul/server.go @@ -242,7 +242,7 @@ type Server struct { // serf cluster that spans datacenters eventChWAN chan serf.Event - // wanMembershipNotifyCh is used to receive notifications that the the + // wanMembershipNotifyCh is used to receive notifications that the // serfWAN wan pool may have changed. // // If this is nil, notification is skipped. diff --git a/agent/consul/state/catalog.go b/agent/consul/state/catalog.go index 040a960814..07e965d6b2 100644 --- a/agent/consul/state/catalog.go +++ b/agent/consul/state/catalog.go @@ -3972,7 +3972,7 @@ func updateGatewayService(tx WriteTxn, idx uint64, mapping *structs.GatewayServi } // checkWildcardForGatewaysAndUpdate checks whether a service matches a -// wildcard definition in gateway config entries and if so adds it the the +// wildcard definition in gateway config entries and if so adds it the // gateway-services table. func checkGatewayWildcardsAndUpdate(tx WriteTxn, idx uint64, svc *structs.ServiceName, ns *structs.NodeService, kind structs.GatewayServiceKind) error { sn := structs.ServiceName{Name: structs.WildcardSpecifier, EnterpriseMeta: svc.EnterpriseMeta} @@ -4020,7 +4020,7 @@ func checkGatewayWildcardsAndUpdate(tx WriteTxn, idx uint64, svc *structs.Servic } // checkGatewayAndUpdate checks whether a service matches a -// wildcard definition in gateway config entries and if so adds it the the +// wildcard definition in gateway config entries and if so adds it the // gateway-services table. func checkGatewayAndUpdate(tx WriteTxn, idx uint64, svc *structs.ServiceName, kind structs.GatewayServiceKind) error { sn := structs.ServiceName{Name: svc.Name, EnterpriseMeta: svc.EnterpriseMeta} diff --git a/agent/consul/state/catalog_events.go b/agent/consul/state/catalog_events.go index 0cd7258d5e..6be12ec2a3 100644 --- a/agent/consul/state/catalog_events.go +++ b/agent/consul/state/catalog_events.go @@ -645,7 +645,7 @@ func getPayloadCheckServiceNode(payload stream.Payload) *structs.CheckServiceNod } // newServiceHealthEventsForNode returns health events for all services on the -// given node. This mirrors some of the the logic in the oddly-named +// given node. This mirrors some of the logic in the oddly-named // parseCheckServiceNodes but is more efficient since we know they are all on // the same node. func newServiceHealthEventsForNode(tx ReadTxn, idx uint64, node string, entMeta *acl.EnterpriseMeta, peerName string) ([]stream.Event, error) { diff --git a/agent/proxycfg/proxycfg.go b/agent/proxycfg/proxycfg.go index f73e6ac726..759c0b7339 100644 --- a/agent/proxycfg/proxycfg.go +++ b/agent/proxycfg/proxycfg.go @@ -45,7 +45,7 @@ // ConfigSource - on a client agent this would be a local config source, on a // server it would be a catalog config source. // 4. On server, the catalog config source will check if service is registered locally. -// 4a. If the service *is* registered locally it hands off the the local config +// 4a. If the service *is* registered locally it hands off the local config // source, which calls Watch on the proxycfg manager (and serves the pre- // fetched data). // 5. Otherwise, it fetches the service from the state store. diff --git a/agent/structs/acl.go b/agent/structs/acl.go index d239b88222..1533fd6577 100644 --- a/agent/structs/acl.go +++ b/agent/structs/acl.go @@ -1296,7 +1296,7 @@ type ACLTokenListResponse struct { } // ACLTokenBatchGetRequest is used for reading multiple tokens, this is -// different from the the token list request in that only tokens with the +// different from the token list request in that only tokens with the // the requested ids are returned type ACLTokenBatchGetRequest struct { AccessorIDs []string // List of accessor ids to fetch diff --git a/agent/structs/prepared_query.go b/agent/structs/prepared_query.go index 71b0eba81b..bf1581975e 100644 --- a/agent/structs/prepared_query.go +++ b/agent/structs/prepared_query.go @@ -341,7 +341,7 @@ type PreparedQueryExecuteRemoteRequest struct { Connect bool // QueryOptions (unfortunately named here) controls the consistency - // settings for the the service lookups. + // settings for the service lookups. QueryOptions } diff --git a/agent/xds/delta.go b/agent/xds/delta.go index f84b633a85..0b3fbc2f95 100644 --- a/agent/xds/delta.go +++ b/agent/xds/delta.go @@ -117,7 +117,7 @@ func (s *Server) processDelta(stream ADSDeltaStream, reqCh <-chan *envoy_discove // type => name => proto resourceMap = xdscommon.EmptyIndexedResources() - // currentVersions is the the xDS versioning represented by Resources. + // currentVersions is the xDS versioning represented by Resources. // // type => name => version (as consul knows right now) currentVersions = make(map[string]map[string]string) diff --git a/command/connect/envoy/bootstrap_tpl.go b/command/connect/envoy/bootstrap_tpl.go index 26b8e2118b..6d1946c90d 100644 --- a/command/connect/envoy/bootstrap_tpl.go +++ b/command/connect/envoy/bootstrap_tpl.go @@ -8,7 +8,7 @@ package envoy type BootstrapTplArgs struct { GRPC - // ProxyCluster is the cluster name for the the Envoy `node` specification and + // ProxyCluster is the cluster name for the Envoy `node` specification and // is typically the same as the ProxyID. ProxyCluster string diff --git a/connect/tls.go b/connect/tls.go index a0e0286bc1..ed34b3315b 100644 --- a/connect/tls.go +++ b/connect/tls.go @@ -425,7 +425,7 @@ func (cfg *dynamicTLSConfig) Ready() bool { return cfg.VerifyLeafWithRoots() == nil } -// ReadyWait returns a chan that is closed when the the Service becomes ready +// ReadyWait returns a chan that is closed when the Service becomes ready // for use for the first time. Note that if the Service is ready when it is // called it returns a nil chan. Ready means that it has root and leaf // certificates configured but not that the combination is valid nor that diff --git a/envoyextensions/extensioncommon/envoy_extender.go b/envoyextensions/extensioncommon/envoy_extender.go index 8cf0bc289e..a1c01f33d7 100644 --- a/envoyextensions/extensioncommon/envoy_extender.go +++ b/envoyextensions/extensioncommon/envoy_extender.go @@ -17,7 +17,7 @@ type EnvoyExtender interface { // Extend updates indexed xDS structures to include patches for // built-in extensions. It is responsible for applying extensions to - // the the appropriate xDS resources. If any portion of this function fails, + // the appropriate xDS resources. If any portion of this function fails, // it will attempt continue and return an error. The caller can then determine // if it is better to use a partially applied extension or error out. Extend(*xdscommon.IndexedResources, *RuntimeConfig) (*xdscommon.IndexedResources, error) diff --git a/proto/private/pbpeering/peering.pb.go b/proto/private/pbpeering/peering.pb.go index 65a75ada26..69af206ca4 100644 --- a/proto/private/pbpeering/peering.pb.go +++ b/proto/private/pbpeering/peering.pb.go @@ -324,7 +324,7 @@ type Peering struct { PeerCAPems []string `protobuf:"bytes,8,rep,name=PeerCAPems,proto3" json:"PeerCAPems,omitempty"` // PeerServerName is the name of the remote server as it relates to TLS. PeerServerName string `protobuf:"bytes,9,opt,name=PeerServerName,proto3" json:"PeerServerName,omitempty"` - // PeerServerAddresses contains all the the connection addresses for the remote peer. + // PeerServerAddresses contains all the connection addresses for the remote peer. PeerServerAddresses []string `protobuf:"bytes,10,rep,name=PeerServerAddresses,proto3" json:"PeerServerAddresses,omitempty"` // StreamStatus contains information computed on read based on the state of the stream. // diff --git a/proto/private/pbpeering/peering.proto b/proto/private/pbpeering/peering.proto index 098c8f6387..e72d5eb768 100644 --- a/proto/private/pbpeering/peering.proto +++ b/proto/private/pbpeering/peering.proto @@ -229,7 +229,7 @@ message Peering { // PeerServerName is the name of the remote server as it relates to TLS. string PeerServerName = 9; - // PeerServerAddresses contains all the the connection addresses for the remote peer. + // PeerServerAddresses contains all the connection addresses for the remote peer. repeated string PeerServerAddresses = 10; // StreamStatus contains information computed on read based on the state of the stream. diff --git a/sdk/iptables/iptables.go b/sdk/iptables/iptables.go index 5b965a6322..32f089a6c9 100644 --- a/sdk/iptables/iptables.go +++ b/sdk/iptables/iptables.go @@ -149,7 +149,7 @@ func Setup(cfg Config) error { // Redirect remaining outbound traffic to Envoy. cfg.IptablesProvider.AddRule("iptables", "-t", "nat", "-A", ProxyOutputChain, "-j", ProxyOutputRedirectChain) - // We are using "insert" (-I) instead of "append" (-A) so the the provided rules take precedence over default ones. + // We are using "insert" (-I) instead of "append" (-A) so the provided rules take precedence over default ones. for _, outboundPort := range cfg.ExcludeOutboundPorts { cfg.IptablesProvider.AddRule("iptables", "-t", "nat", "-I", ProxyOutputChain, "-p", "tcp", "--dport", outboundPort, "-j", "RETURN") } diff --git a/test/integration/connect/envoy/case-stats-proxy/verify.bats b/test/integration/connect/envoy/case-stats-proxy/verify.bats index 2d02010dc1..a200a5a313 100644 --- a/test/integration/connect/envoy/case-stats-proxy/verify.bats +++ b/test/integration/connect/envoy/case-stats-proxy/verify.bats @@ -40,7 +40,7 @@ load helpers must_match_in_stats_proxy_response localhost:1239 \ 'stats' '^http.envoy_metrics.downstream_rq_active' - # Response should include the the local cluster request. + # Response should include the local cluster request. retry_default \ must_match_in_stats_proxy_response localhost:1239 \ 'stats' 'cluster.local_agent.upstream_rq_active' diff --git a/website/content/api-docs/acl/index.mdx b/website/content/api-docs/acl/index.mdx index 835a8e28dd..57a527d99d 100644 --- a/website/content/api-docs/acl/index.mdx +++ b/website/content/api-docs/acl/index.mdx @@ -444,7 +444,7 @@ replication enabled. login. This must be of type [`oidc`](/consul/docs/security/acl/auth-methods/oidc). - `State` `(string: )` - Opaque state ID that is part of the - Authorization URL and will be included in the the redirect following + Authorization URL and will be included in the redirect following successful authentication on the provider. - `Code` `(string: )` - Provider-generated authorization code that diff --git a/website/content/api-docs/catalog.mdx b/website/content/api-docs/catalog.mdx index c7f715849c..b60759465f 100644 --- a/website/content/api-docs/catalog.mdx +++ b/website/content/api-docs/catalog.mdx @@ -55,7 +55,7 @@ The table below shows this endpoint's support for - `NodeMeta` `(map: nil)` - Specifies arbitrary KV metadata pairs for filtering purposes. -- `Service` `(Service: nil)` - Contains an object the specifies the service to register. The the `Service.Service` field is required. If `Service.ID` is not provided, the default is the `Service.Service`. +- `Service` `(Service: nil)` - Contains an object the specifies the service to register. The `Service.Service` field is required. If `Service.ID` is not provided, the default is the `Service.Service`. You can only specify one service with a given `ID` per node. We recommend using valid DNS labels for service definition names. Refer to the Internet Engineering Task Force's [RFC 1123](https://datatracker.ietf.org/doc/html/rfc1123#page-72) for additional information. Service names that conform to standard usage ensures compatibility with external DNSs. Refer to [Services Configuration Reference](/consul/docs/services/configuration/services-configuration-reference#name) for additional information. The following fields are optional: diff --git a/website/content/api-docs/status.mdx b/website/content/api-docs/status.mdx index 1a14e5d4fc..2eb466b97f 100644 --- a/website/content/api-docs/status.mdx +++ b/website/content/api-docs/status.mdx @@ -51,7 +51,7 @@ $ curl http://127.0.0.1:8500/v1/status/leader ## List Raft Peers -This endpoint retrieves the Raft peers for the datacenter in which the the agent +This endpoint retrieves the Raft peers for the datacenter in which the agent is running. This list of peers is strongly consistent and can be useful in determining when a given server has successfully joined the cluster. diff --git a/website/content/commands/connect/envoy.mdx b/website/content/commands/connect/envoy.mdx index bb2cc5d77e..e86e3d4291 100644 --- a/website/content/commands/connect/envoy.mdx +++ b/website/content/commands/connect/envoy.mdx @@ -342,7 +342,7 @@ immediately unlinks it so it can't be read by any other process that doesn't already have the file descriptor. It then writes the bootstrap JSON, and unsets the CLOEXEC bit on the file handle so that it remains available to the Envoy process after exec. Finally it `exec`s Envoy with `--config-file /dev/fd/X` -where `X` is the the file descriptor number of the temp file. +where `X` is the file descriptor number of the temp file. This ensures that Envoy can read the file without any other normal user process being able to (assuming they don't have privileged access to /proc). Once the diff --git a/website/content/commands/debug.mdx b/website/content/commands/debug.mdx index 1514158ff9..0473c32cc8 100644 --- a/website/content/commands/debug.mdx +++ b/website/content/commands/debug.mdx @@ -86,7 +86,7 @@ information when `debug` is running. By default, it captures all information. This command can be run from any host with the Consul binary, but requires network access to the target agent in order to retrieve data. Once retrieved, -the data is written to the the specified path (defaulting to the current +the data is written to the specified path (defaulting to the current directory) on the host where the command runs. By default the command will capture all available data from the default diff --git a/website/content/commands/snapshot/agent.mdx b/website/content/commands/snapshot/agent.mdx index 9f7c5d1d50..541a470864 100644 --- a/website/content/commands/snapshot/agent.mdx +++ b/website/content/commands/snapshot/agent.mdx @@ -339,7 +339,7 @@ no `aws-s3-static-snapshot-name` configured. | `ListBucket` | `arn:aws:s3:::` | Required only when snapshot rotation is enabled | | `ListBucketVersions` | `arn:aws:s3:::` | Required only when snapshot rotation is enabled | -Within the table `` refers to the the key used to store the snapshot. When `aws-s3-static-snapshot-name` is configured the `` is simply the value of that configuration. Otherwise the `` will be the `/consul-*.snap`. +Within the table `` refers to the key used to store the snapshot. When `aws-s3-static-snapshot-name` is configured the `` is simply the value of that configuration. Otherwise the `` will be the `/consul-*.snap`. The following example IAM policy document assumes that the `aws-s3-bucket` is `consul-data` with defaults for `aws-s3-key-prefix`, `aws-s3-static-snapshot-name` and `retain`: diff --git a/website/content/docs/agent/config/cli-flags.mdx b/website/content/docs/agent/config/cli-flags.mdx index 82d44d0252..cf83e7ef64 100644 --- a/website/content/docs/agent/config/cli-flags.mdx +++ b/website/content/docs/agent/config/cli-flags.mdx @@ -273,7 +273,7 @@ information. - `-config-dir` ((#\_config_dir)) - A directory of configuration files to load. Consul will load all files in this directory with the suffix ".json" or ".hcl". - The load order is alphabetical, and the the same merge routine is used as with + The load order is alphabetical, and the same merge routine is used as with the [`config-file`](#_config_file) option above. This option can be specified multiple times to load multiple directories. Sub-directories of the config directory are not loaded. For more information on the format of the configuration files, see diff --git a/website/content/docs/agent/config/config-files.mdx b/website/content/docs/agent/config/config-files.mdx index f314acd38c..2d91c6e8a7 100644 --- a/website/content/docs/agent/config/config-files.mdx +++ b/website/content/docs/agent/config/config-files.mdx @@ -948,7 +948,7 @@ Refer to the [formatting specification](https://golang.org/pkg/time/#ParseDurati `service:write` permissions for service "B", the agent will successfully register service "A" and fail to register service "B". Failed registration requests are eventually retried as part of [anti-entropy enforcement](/consul/docs/architecture/anti-entropy). If a registration request is - failing due to missing permissions, the the token for this agent can be updated with + failing due to missing permissions, the token for this agent can be updated with additional policy rules or the `config_file_service_registration` token can be replaced using the [Set Agent Token](/consul/commands/acl/set-agent-token) CLI command. diff --git a/website/content/docs/agent/telemetry.mdx b/website/content/docs/agent/telemetry.mdx index a1ab4969ce..d561e6b068 100644 --- a/website/content/docs/agent/telemetry.mdx +++ b/website/content/docs/agent/telemetry.mdx @@ -566,7 +566,7 @@ These metrics are used to monitor the health of the Consul servers. | `consul.rpc.raft_handoff` | Increments when a server accepts a Raft-related RPC connection. | connections | counter | | `consul.rpc.request` | Increments when a server receives a Consul-related RPC request. | requests | counter | | `consul.rpc.request_error` | Increments when a server returns an error from an RPC request. | errors | counter | -| `consul.rpc.query` | Increments when a server receives a read RPC request, indicating the rate of new read queries. See consul.rpc.queries_blocking for the current number of in-flight blocking RPC calls. This metric changed in 1.7.0 to only increment on the the start of a query. The rate of queries will appear lower, but is more accurate. | queries | counter | +| `consul.rpc.query` | Increments when a server receives a read RPC request, indicating the rate of new read queries. See consul.rpc.queries_blocking for the current number of in-flight blocking RPC calls. This metric changed in 1.7.0 to only increment on the start of a query. The rate of queries will appear lower, but is more accurate. | queries | counter | | `consul.rpc.queries_blocking` | The current number of in-flight blocking queries the server is handling. | queries | gauge | | `consul.rpc.cross-dc` | Increments when a server sends a (potentially blocking) cross datacenter RPC query. | queries | counter | | `consul.rpc.consistentRead` | Measures the time spent confirming that a consistent read can be performed. | ms | timer | @@ -603,7 +603,7 @@ Label based RPC metrics were added in Consul 1.12.0 as a Beta feature to better ### Labels -The the server workload metrics above come with the following labels: +The server workload metrics above come with the following labels: | Label Name | Description | Possible values | | ------------------------------------- | -------------------------------------------------------------------- | --------------------------------------- | diff --git a/website/content/docs/api-gateway/configuration/routes.mdx b/website/content/docs/api-gateway/configuration/routes.mdx index 973ebed025..57c111a722 100644 --- a/website/content/docs/api-gateway/configuration/routes.mdx +++ b/website/content/docs/api-gateway/configuration/routes.mdx @@ -210,7 +210,7 @@ The following table describes the parameters for `path`: | Parameter | Description | Type | Required | | --- | --- | --- | --- | | `replacePrefixMatch` | Specifies a value that replaces the path prefix for incoming HTTP requests. The operation only affects the path prefix. The rest of the path is unchanged. | String | Required | -| `type` | Specifies the type of replacement to use for the URL path. You can specify the following values:
  • `ReplacePrefixMatch`: Replaces the the matched prefix of the URL path (default).
| String | Optional | +| `type` | Specifies the type of replacement to use for the URL path. You can specify the following values:
  • `ReplacePrefixMatch`: Replaces the matched prefix of the URL path (default).
| String | Optional | ### rules.matches diff --git a/website/content/docs/api-gateway/tech-specs.mdx b/website/content/docs/api-gateway/tech-specs.mdx index 22fa8d30b5..21763f1b04 100644 --- a/website/content/docs/api-gateway/tech-specs.mdx +++ b/website/content/docs/api-gateway/tech-specs.mdx @@ -63,7 +63,7 @@ The following resources are allocated for each component of the API gateway. ### Gateway controller pod - **CPU**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. -- **Memory**: None. Either the the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. +- **Memory**: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration. ### Gateway instance pod diff --git a/website/content/docs/dynamic-app-config/kv.mdx b/website/content/docs/dynamic-app-config/kv.mdx index 5986cb0741..80da28e9e4 100644 --- a/website/content/docs/dynamic-app-config/kv.mdx +++ b/website/content/docs/dynamic-app-config/kv.mdx @@ -33,7 +33,7 @@ To restrict access, enable and configure [ACLs](/consul/tutorials/security/access-control-setup-production). Once the ACL system has been bootstrapped, users and services, will need a valid token with KV [privileges](/consul/docs/security/acl/acl-rules#key-value-rules) to -access the the data store, this includes even reads. We recommend creating a +access the data store, this includes even reads. We recommend creating a token with limited privileges, for example, you could create a token with write privileges on one key for developers to update the value related to their application. diff --git a/website/content/docs/ecs/manual/secure-configuration.mdx b/website/content/docs/ecs/manual/secure-configuration.mdx index 5a94ed4acd..3a2c7fdf29 100644 --- a/website/content/docs/ecs/manual/secure-configuration.mdx +++ b/website/content/docs/ecs/manual/secure-configuration.mdx @@ -89,7 +89,7 @@ The following flags are required: | `-type` | string | Must be `aws-iam`. | | `-name` | string | A name of your choice. Must be unique among all auth methods. | | `-description` | string | A description of your choice. | -| `-config` | string | A JSON string containing the [configuration](/consul/docs/security/acl/auth-methods/aws-iam#config-parameters) for the the auth method. | +| `-config` | string | A JSON string containing the [configuration](/consul/docs/security/acl/auth-methods/aws-iam#config-parameters) for the auth method. | In the `-config` option, the following fields are required: @@ -177,7 +177,7 @@ The following flags are required: | `-type` | string | Must be `aws-iam`. | | `-name` | string | A name of your choice. Must be unique among all auth methods. | | `-description` | string | A description of your choice. | -| `-config` | string | A JSON string containing the [configuration](/consul/docs/security/acl/auth-methods/aws-iam#config-parameters) for the the auth method. | +| `-config` | string | A JSON string containing the [configuration](/consul/docs/security/acl/auth-methods/aws-iam#config-parameters) for the auth method. | In the `-config` option, the following fields are required: diff --git a/website/content/docs/k8s/connect/cluster-peering/usage/manage-peering.mdx b/website/content/docs/k8s/connect/cluster-peering/usage/manage-peering.mdx index bc622fe15d..42f8fc5983 100644 --- a/website/content/docs/k8s/connect/cluster-peering/usage/manage-peering.mdx +++ b/website/content/docs/k8s/connect/cluster-peering/usage/manage-peering.mdx @@ -100,7 +100,7 @@ To end a peering connection in Kubernetes deployments, delete both the `PeeringA $ kubectl --context $CLUSTER1_CONTEXT delete --filename acceptor.yaml ```` -To confirm that you deleted your peering connection in `cluster-01`, query the the `/health` HTTP endpoint: +To confirm that you deleted your peering connection in `cluster-01`, query the `/health` HTTP endpoint: 1. Exec into the server pod for the first cluster. @@ -114,7 +114,7 @@ To confirm that you deleted your peering connection in `cluster-01`, query the t $ export CONSUL_HTTP_TOKEN= ``` -1. Query the the `/health` HTTP endpoint. Peered services with deleted connections should no longe appear. +1. Query the `/health` HTTP endpoint. Peered services with deleted connections should no longe appear. ```shell-session $ curl "localhost:8500/v1/health/connect/backend?peer=cluster-02" diff --git a/website/content/docs/nia/configuration.mdx b/website/content/docs/nia/configuration.mdx index bd67ef5c07..f54a4ef51e 100644 --- a/website/content/docs/nia/configuration.mdx +++ b/website/content/docs/nia/configuration.mdx @@ -84,7 +84,7 @@ license { ### Auto-retrieval -You can use the `auto_retrieval` block to configure the the automatic license retrieval in CTS. When enabled, CTS attempts to retrieve a new license from its configured Consul Enterprise backend once a day. If CTS cannot retrieve a license and the current license is reaching its expiration date, CTS attempts to retrieve a license with increased frequency, as defined by the [License Expiration Date Handling](/consul/docs/nia/enterprise/license#license-expiration-handling). +You can use the `auto_retrieval` block to configure the automatic license retrieval in CTS. When enabled, CTS attempts to retrieve a new license from its configured Consul Enterprise backend once a day. If CTS cannot retrieve a license and the current license is reaching its expiration date, CTS attempts to retrieve a license with increased frequency, as defined by the [License Expiration Date Handling](/consul/docs/nia/enterprise/license#license-expiration-handling). ~> Enabling `auto_retrieval` is recommended when using HCP Consul, as HCP Consul licenses expire more frequently than Consul Enterprise licenses. Without auto-retrieval enabled, you have to restart CTS every time you load a new license. diff --git a/website/content/docs/nia/usage/errors-ref.mdx b/website/content/docs/nia/usage/errors-ref.mdx index fafb9faf1e..4cbb525a3a 100644 --- a/website/content/docs/nia/usage/errors-ref.mdx +++ b/website/content/docs/nia/usage/errors-ref.mdx @@ -11,7 +11,7 @@ This topic explains error messages you may encounter when using Consul-Terraform ## Example error log messages -If you configured the CTS cluster to run in [high availability mode](/consul/docs/nia/usage/run-ha) and the the local module is missing, then the following message appears in the log: +If you configured the CTS cluster to run in [high availability mode](/consul/docs/nia/usage/run-ha) and the local module is missing, then the following message appears in the log: ```shell-session [ERROR] ha.compat: error="compatibility check failure: stat ./example-module: no such file or directory" diff --git a/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx index 293b3ffa83..efb65ec71a 100644 --- a/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx +++ b/website/content/docs/release-notes/consul-api-gateway/v0_1_x.mdx @@ -19,7 +19,7 @@ gateway functionality. It provides additional capabilities that ingress gateway 1. It allows you to configure and deploy new gateways at any time, without rerunning the Consul Helm chart. The configuration of a running gateway can - be changed dynamically at anytime, usually without disrupting any the the + be changed dynamically at anytime, usually without disrupting any the traffic flowing through it. 1. Listeners on a gateway can use TLS server certificates signed by any certificate authority (CA). This allows you to use certificates from public diff --git a/website/content/docs/security/acl/acl-roles.mdx b/website/content/docs/security/acl/acl-roles.mdx index 0f451596c9..6f094931ee 100644 --- a/website/content/docs/security/acl/acl-roles.mdx +++ b/website/content/docs/security/acl/acl-roles.mdx @@ -93,7 +93,7 @@ Use the following syntax to define a service identity: - `ServiceIdentities.ServiceName`: String value that specifies the name of the service you want to associate with the policy. - `ServiceIdentities.Datacenters`: Array that specifies the names of datacenters in which the service identity applies. This field is optional. -Refer to the the [API documentation for roles](/consul/api-docs/acl/roles#sample-payload) for additional information and examples. +Refer to the [API documentation for roles](/consul/api-docs/acl/roles#sample-payload) for additional information and examples. -> **Scope for Namespace and Admin Partition** - In Consul Enterprise, service identities inherit the namespace or admin partition scope of the corresponding ACL token or role. @@ -230,7 +230,7 @@ Use the following syntax to define a node identity: - `NodeIdentities.NodeName`: String value that specifies the name of the node you want to associate with the policy. - `NodeIdentities.Datacenter`: String value that specifies the name of the datacenter in which the node identity applies. -Refer to the the [API documentation for roles](/consul/api-docs/acl/roles#sample-payload) for additional information and examples. +Refer to the [API documentation for roles](/consul/api-docs/acl/roles#sample-payload) for additional information and examples. -> **Consul Enterprise Namespacing** - Node Identities can only be applied to tokens and roles in the `default` namespace. The generated policy rules allow for `service:read` permissions on all services in all namespaces. diff --git a/website/content/docs/security/acl/auth-methods/index.mdx b/website/content/docs/security/acl/auth-methods/index.mdx index c26cb05d21..decab07108 100644 --- a/website/content/docs/security/acl/auth-methods/index.mdx +++ b/website/content/docs/security/acl/auth-methods/index.mdx @@ -74,7 +74,7 @@ tokens without operator intervention. Successful authentication with an auth method returns a set of trusted identity attributes corresponding to the authenticated identity. Those attributes are matched against all configured binding rules for that auth -method to determine what privileges to grant the the Consul ACL token it will +method to determine what privileges to grant the Consul ACL token it will ultimately create. Each binding rule is composed of two portions: diff --git a/website/content/docs/upgrading/upgrade-specific.mdx b/website/content/docs/upgrading/upgrade-specific.mdx index 985a703353..a5ef59339d 100644 --- a/website/content/docs/upgrading/upgrade-specific.mdx +++ b/website/content/docs/upgrading/upgrade-specific.mdx @@ -864,7 +864,7 @@ API so existing integrations that create tokens (e.g. Vault) will continue to work. The "legacy" tokens generated though will not be able to take advantage of new policy features. It's recommended that you complete migration of all tokens as soon as possible after upgrade, as well as updating any integrations to work -with the the new ACL [Token](/consul/api-docs/acl/tokens) and +with the new ACL [Token](/consul/api-docs/acl/tokens) and [Policy](/consul/api-docs/acl/policies) APIs. ### Multi-datacenter service mesh