mirror of https://github.com/status-im/consul.git
revert links to learn
This commit is contained in:
parent
205e866784
commit
110139a4df
|
@ -14,7 +14,7 @@ The `/acl/auth-method` endpoints [create](#create-an-auth-method),
|
||||||
ACL auth methods in Consul.
|
ACL auth methods in Consul.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create an Auth Method
|
## Create an Auth Method
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ The `/acl/binding-rule` endpoints [create](#create-a-binding-rule),
|
||||||
rules in Consul.
|
rules in Consul.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create a Binding Rule
|
## Create a Binding Rule
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ description: The /acl endpoints manage the Consul's ACL system.
|
||||||
The `/acl` endpoints are used to manage ACL tokens and policies in Consul, [bootstrap the ACL system](#bootstrap-acls), [check ACL replication status](#check-acl-replication), and [translate rules](#translate-rules). There are additional pages for managing [tokens](/api-docs/acl/tokens) and [policies](/api-docs/acl/policies) with the `/acl` endpoints.
|
The `/acl` endpoints are used to manage ACL tokens and policies in Consul, [bootstrap the ACL system](#bootstrap-acls), [check ACL replication status](#check-acl-replication), and [translate rules](#translate-rules). There are additional pages for managing [tokens](/api-docs/acl/tokens) and [policies](/api-docs/acl/policies) with the `/acl` endpoints.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Bootstrap ACLs
|
## Bootstrap ACLs
|
||||||
|
|
||||||
|
@ -80,7 +80,7 @@ consider the cluster in a potentially compromised state.
|
||||||
|
|
||||||
The returned token will have unrestricted privileges to manage all details of the system.
|
The returned token will have unrestricted privileges to manage all details of the system.
|
||||||
It can then be used to further configure the ACL system. Please check the
|
It can then be used to further configure the ACL system. Please check the
|
||||||
[ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs) for more details.
|
[ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more details.
|
||||||
|
|
||||||
## Check ACL Replication
|
## Check ACL Replication
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ This endpoint returns the status of the ACL replication processes in the
|
||||||
datacenter. This is intended to be used by operators or by automation checking
|
datacenter. This is intended to be used by operators or by automation checking
|
||||||
to discover the health of ACL replication.
|
to discover the health of ACL replication.
|
||||||
|
|
||||||
Please check the [ACL Replication tutorial](/consul/tutorials/security-operations/access-control-replication-multiple-datacenters?utm_source=docs)
|
Please check the [ACL Replication tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-replication-multiple-datacenters)
|
||||||
for more details.
|
for more details.
|
||||||
|
|
||||||
| Method | Path | Produces |
|
| Method | Path | Produces |
|
||||||
|
|
|
@ -14,7 +14,7 @@ the new ACL [Token](/api-docs/acl/tokens) and [Policy](/api-docs/acl/policies) A
|
||||||
|
|
||||||
The legacy `/acl` endpoints to create, update, destroy, and query legacy ACL tokens in Consul.
|
The legacy `/acl` endpoints to create, update, destroy, and query legacy ACL tokens in Consul.
|
||||||
|
|
||||||
For more information about ACLs, please check the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
For more information about ACLs, please check the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create ACL Token
|
## Create ACL Token
|
||||||
|
|
||||||
|
|
|
@ -13,7 +13,7 @@ The `/acl/policy` endpoints [create](#create-a-policy), [read](#read-a-policy),
|
||||||
[delete](#delete-a-policy) ACL policies in Consul.
|
[delete](#delete-a-policy) ACL policies in Consul.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create a Policy
|
## Create a Policy
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ The `/acl/role` endpoints [create](#create-a-role), [read](#read-a-role),
|
||||||
[update](#update-a-role), [list](#list-roles) and [delete](#delete-a-role) ACL roles in Consul.
|
[update](#update-a-role), [list](#list-roles) and [delete](#delete-a-role) ACL roles in Consul.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create a Role
|
## Create a Role
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ The `/acl/token` endpoints [create](#create-a-token), [read](#read-a-token),
|
||||||
[update](#update-a-token), [list](#list-tokens), [clone](#clone-a-token) and [delete](#delete-a-token) ACL tokens in Consul.
|
[update](#update-a-token), [list](#list-tokens), [clone](#clone-a-token) and [delete](#delete-a-token) ACL tokens in Consul.
|
||||||
|
|
||||||
For more information on how to setup ACLs, please check
|
For more information on how to setup ACLs, please check
|
||||||
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
## Create a Token
|
## Create a Token
|
||||||
|
|
||||||
|
|
|
@ -210,7 +210,7 @@ The corresponding CLI command is [`consul kv put`](/commands/kv/put).
|
||||||
session has locked the key.**
|
session has locked the key.**
|
||||||
|
|
||||||
For an example of how to use the lock feature, check the
|
For an example of how to use the lock feature, check the
|
||||||
[Leader Election tutorial](/consul/tutorials/developer-configuration/application-leader-elections?utm_source=docs).
|
[Leader Election tutorial](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
|
||||||
|
|
||||||
- `release` `(string: "")` - Supply a session ID to use in a release operation. This is
|
- `release` `(string: "")` - Supply a session ID to use in a release operation. This is
|
||||||
useful when paired with `?acquire=` as it allows clients to yield a lock. This
|
useful when paired with `?acquire=` as it allows clients to yield a lock. This
|
||||||
|
|
|
@ -24,7 +24,7 @@ datacenters, so not all servers need to be fully connected. This allows for
|
||||||
complex topologies among Consul datacenters like hub/spoke and more general
|
complex topologies among Consul datacenters like hub/spoke and more general
|
||||||
trees.
|
trees.
|
||||||
|
|
||||||
Please check the [Network Areas tutorial](/consul/tutorials/datacenter-operations/federation-network-areas?utm_source=docs) for more details.
|
Please check the [Network Areas tutorial](https://learn.hashicorp.com/tutorials/consul/federation-network-areas) for more details.
|
||||||
|
|
||||||
## Create Network Area
|
## Create Network Area
|
||||||
|
|
||||||
|
|
|
@ -13,7 +13,7 @@ The `/operator/autopilot` endpoints allow for automatic operator-friendly
|
||||||
management of Consul servers including cleanup of dead servers, monitoring
|
management of Consul servers including cleanup of dead servers, monitoring
|
||||||
the state of the Raft cluster, and stable server introduction.
|
the state of the Raft cluster, and stable server introduction.
|
||||||
|
|
||||||
Please check the [Autopilot tutorial](/consul/tutorials/datacenter-operations/autopilot-datacenter-operations?utm_source=docs) for more details.
|
Please check the [Autopilot tutorial](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations) for more details.
|
||||||
|
|
||||||
## Read Configuration
|
## Read Configuration
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ If ACLs are enabled then a token with operator privileges may be required in
|
||||||
order to use this interface. Check the [ACL Rules documentation](/docs/security/acl/acl-rules#operator-rules)
|
order to use this interface. Check the [ACL Rules documentation](/docs/security/acl/acl-rules#operator-rules)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
Check the [Outage Recovery](/consul/tutorials/datacenter-operations/recovery-outage?utm_source=docs) tutorial for some examples of
|
Check the [Outage Recovery](https://learn.hashicorp.com/tutorials/consul/recovery-outage) tutorial for some examples of
|
||||||
how these capabilities are used.
|
how these capabilities are used.
|
||||||
|
|
||||||
Please choose a sub-section in the navigation for more information.
|
Please choose a sub-section in the navigation for more information.
|
||||||
|
|
|
@ -18,7 +18,7 @@ The network area functionality described here is available only in
|
||||||
later. Network segments are operator-defined sections of agents on the LAN, typically
|
later. Network segments are operator-defined sections of agents on the LAN, typically
|
||||||
isolated from other segments by network configuration.
|
isolated from other segments by network configuration.
|
||||||
|
|
||||||
Please check the [Network Segments tutorial](/consul/tutorials/datacenter-operations/network-partition-datacenters?utm_source=docs) for more details.
|
Please check the [Network Segments tutorial](https://learn.hashicorp.com/tutorials/consul/network-partition-datacenters) for more details.
|
||||||
|
|
||||||
## List Network Segments
|
## List Network Segments
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ service. This is particularly useful in combination with Consul's
|
||||||
[DNS Interface](/docs/discovery/dns#prepared-query-lookups) as it allows for much richer queries than
|
[DNS Interface](/docs/discovery/dns#prepared-query-lookups) as it allows for much richer queries than
|
||||||
would be possible given the limited entry points exposed by DNS.
|
would be possible given the limited entry points exposed by DNS.
|
||||||
|
|
||||||
Check the [Geo Failover tutorial](/consul/tutorials/developer-discovery/automate-geo-failover?utm_source=docs) for details and
|
Check the [Geo Failover tutorial](https://learn.hashicorp.com/tutorials/consul/automate-geo-failover) for details and
|
||||||
examples for using prepared queries to implement geo failover for services.
|
examples for using prepared queries to implement geo failover for services.
|
||||||
|
|
||||||
Check the [prepared query rules](/docs/security/acl/acl-rules#prepared-query-rules)
|
Check the [prepared query rules](/docs/security/acl/acl-rules#prepared-query-rules)
|
||||||
|
|
|
@ -77,7 +77,7 @@ The table below shows this endpoint's support for
|
||||||
86400s). If provided, the session is invalidated if it is not renewed before
|
86400s). If provided, the session is invalidated if it is not renewed before
|
||||||
the TTL expires. The lowest practical TTL should be used to keep the number of
|
the TTL expires. The lowest practical TTL should be used to keep the number of
|
||||||
managed sessions low. When locks are forcibly expired, such as when following
|
managed sessions low. When locks are forcibly expired, such as when following
|
||||||
the [leader election pattern](/consul/tutorials/developer-configuration/application-leader-elections?utm_source=docs) in an application,
|
the [leader election pattern](https://learn.hashicorp.com/tutorials/consul/application-leader-elections) in an application,
|
||||||
sessions may not be reaped for up to double this TTL, so long TTL
|
sessions may not be reaped for up to double this TTL, so long TTL
|
||||||
values (> 1 hour) should be avoided. Valid time units include "s", "m" and "h".
|
values (> 1 hour) should be avoided. Valid time units include "s", "m" and "h".
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ Corresponding HTTP API Endpoint: [\[PUT\] /v1/acl/bootstrap](/api-docs/acl#boots
|
||||||
The `acl bootstrap` command will request Consul to generate a new token with unlimited privileges to use
|
The `acl bootstrap` command will request Consul to generate a new token with unlimited privileges to use
|
||||||
for management purposes and output its details. This can only be done once and afterwards bootstrapping
|
for management purposes and output its details. This can only be done once and afterwards bootstrapping
|
||||||
will be disabled. If all tokens are lost and you need to bootstrap again you can follow the bootstrap
|
will be disabled. If all tokens are lost and you need to bootstrap again you can follow the bootstrap
|
||||||
[reset procedure](/consul/tutorials/security/access-control-troubleshoot?utm_source=docs#reset-the-acl-system).
|
[reset procedure](https://learn.hashicorp.com/consul/security-networking/acl-troubleshooting?utm_source=docs).
|
||||||
|
|
||||||
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
The table below shows this command's [required ACLs](/api#authentication). Configuration of
|
||||||
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
|
||||||
|
|
|
@ -66,7 +66,7 @@ Usage: `consul acl token update [options]`
|
||||||
specified grant equivalent or appropriate access for the existing clients using
|
specified grant equivalent or appropriate access for the existing clients using
|
||||||
this token. You can find examples on how to use the parameter in the [legacy
|
this token. You can find examples on how to use the parameter in the [legacy
|
||||||
token
|
token
|
||||||
migration](/consul/tutorials/security-operations/access-control-token-migration?utm_source=docs)
|
migration](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens)
|
||||||
guide.
|
guide.
|
||||||
|
|
||||||
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
- `-format={pretty|json}` - Command output format. The default value is `pretty`.
|
||||||
|
|
|
@ -57,7 +57,7 @@ consul force-leave ec2-001-staging
|
||||||
```
|
```
|
||||||
|
|
||||||
When run on a server that is part of a
|
When run on a server that is part of a
|
||||||
[WAN gossip pool](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs),
|
[WAN gossip pool](https://learn.hashicorp.com/consul/security-networking/datacenters),
|
||||||
`force-leave` can remove failed servers in other datacenters from the WAN pool.
|
`force-leave` can remove failed servers in other datacenters from the WAN pool.
|
||||||
|
|
||||||
The identifying node-name in a WAN pool is `[node-name].[datacenter]`.
|
The identifying node-name in a WAN pool is `[node-name].[datacenter]`.
|
||||||
|
|
|
@ -132,7 +132,7 @@ Success! Data written to: leaderboard/scores
|
||||||
```
|
```
|
||||||
|
|
||||||
~> **Warning**: For secret and sensitive values, you should consider using a
|
~> **Warning**: For secret and sensitive values, you should consider using a
|
||||||
secret management solution like **[HashiCorp's Vault](/vault/tutorials/secrets-management/static-secrets?utm_source=docs)**.
|
secret management solution like **[HashiCorp's Vault](https://learn.hashicorp.com/tutorials/vault/static-secrets?in=vault/secrets-management)**.
|
||||||
While it is possible to encrypt data before writing it to Consul's KV store,
|
While it is possible to encrypt data before writing it to Consul's KV store,
|
||||||
Consul provides no built-in support for encryption at-rest.
|
Consul provides no built-in support for encryption at-rest.
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ Consul Enterprise license management.
|
||||||
If ACLs are enabled then a token with operator privileges may be required in
|
If ACLs are enabled then a token with operator privileges may be required in
|
||||||
order to use this command. Requests are forwarded internally to the leader
|
order to use this command. Requests are forwarded internally to the leader
|
||||||
if required, so this can be run from any Consul node in a cluster. See the
|
if required, so this can be run from any Consul node in a cluster. See the
|
||||||
[ACL Guide](/consul/tutorials/security/access-control-setup-production?utm_source=docs) for more information.
|
[ACL Guide](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Usage: consul license <subcommand> [options] [args]
|
Usage: consul license <subcommand> [options] [args]
|
||||||
|
|
|
@ -18,11 +18,11 @@ communication is disrupted, the child process is terminated.
|
||||||
|
|
||||||
The number of lock holders is configurable with the `-n` flag. By default,
|
The number of lock holders is configurable with the `-n` flag. By default,
|
||||||
a single holder is allowed, and a lock is used for mutual exclusion. This
|
a single holder is allowed, and a lock is used for mutual exclusion. This
|
||||||
uses the [leader election algorithm](/consul/tutorials/developer-configuration/application-leader-elections?utm_source=docs).
|
uses the [leader election algorithm](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
|
||||||
|
|
||||||
If the lock holder count is more than one, then a semaphore is used instead.
|
If the lock holder count is more than one, then a semaphore is used instead.
|
||||||
A semaphore allows more than a single holder, but this is less efficient than
|
A semaphore allows more than a single holder, but this is less efficient than
|
||||||
a simple lock. This follows the [semaphore algorithm](/consul/tutorials/developer-configuration/distributed-semaphore?utm_source=docs).
|
a simple lock. This follows the [semaphore algorithm](https://learn.hashicorp.com/consul/developer-configuration/semaphore).
|
||||||
|
|
||||||
All locks using the same prefix must agree on the value of `-n`. If conflicting
|
All locks using the same prefix must agree on the value of `-n`. If conflicting
|
||||||
values of `-n` are provided, an error will be returned.
|
values of `-n` are provided, an error will be returned.
|
||||||
|
|
|
@ -21,7 +21,7 @@ and relationships can be made between independent pairs of datacenters, so not a
|
||||||
need to be fully connected. This allows for complex topologies among Consul datacenters like
|
need to be fully connected. This allows for complex topologies among Consul datacenters like
|
||||||
hub/spoke and more general trees.
|
hub/spoke and more general trees.
|
||||||
|
|
||||||
See the [Network Areas Guide](/consul/tutorials/datacenter-operations/federation-network-areas?utm_source=docs) for more details.
|
See the [Network Areas Guide](https://learn.hashicorp.com/tutorials/consul/federation-network-areas) for more details.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Usage: consul operator area <subcommand> [options]
|
Usage: consul operator area <subcommand> [options]
|
||||||
|
|
|
@ -12,7 +12,7 @@ Command: `consul operator autopilot`
|
||||||
|
|
||||||
The Autopilot operator command is used to interact with Consul's Autopilot subsystem. The
|
The Autopilot operator command is used to interact with Consul's Autopilot subsystem. The
|
||||||
command can be used to view or modify the current Autopilot configuration. See the
|
command can be used to view or modify the current Autopilot configuration. See the
|
||||||
[Autopilot Guide](/consul/tutorials/datacenter-operations/autopilot-datacenter-operations?utm_source=docs) for more information about Autopilot.
|
[Autopilot Guide](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations) for more information about Autopilot.
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Usage: consul operator autopilot <subcommand> [options]
|
Usage: consul operator autopilot <subcommand> [options]
|
||||||
|
|
|
@ -18,9 +18,9 @@ outage and even loss of data.
|
||||||
If ACLs are enabled then a token with operator privileges may be required in
|
If ACLs are enabled then a token with operator privileges may be required in
|
||||||
order to use this command. Requests are forwarded internally to the leader
|
order to use this command. Requests are forwarded internally to the leader
|
||||||
if required, so this can be run from any Consul node in a cluster. See the
|
if required, so this can be run from any Consul node in a cluster. See the
|
||||||
[ACL Guide](/consul/tutorials/security/access-control-setup-production?utm_source=docs) for more information.
|
[ACL Guide](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more information.
|
||||||
|
|
||||||
See the [Outage Recovery](/consul/tutorials/datacenter-operations/recovery-outage?utm_source=docs) guide for some examples of how
|
See the [Outage Recovery](https://learn.hashicorp.com/tutorials/consul/recovery-outage) guide for some examples of how
|
||||||
this command is used. For an API to perform these operations programmatically,
|
this command is used. For an API to perform these operations programmatically,
|
||||||
please see the documentation for the [Operator](/api-docs/operator)
|
please see the documentation for the [Operator](/api-docs/operator)
|
||||||
endpoint.
|
endpoint.
|
||||||
|
|
|
@ -106,7 +106,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
- `alt_domain` Equivalent to the [`-alt-domain` command-line flag](/docs/agent/config/cli-flags#_alt_domain)
|
- `alt_domain` Equivalent to the [`-alt-domain` command-line flag](/docs/agent/config/cli-flags#_alt_domain)
|
||||||
|
|
||||||
- `audit` <EnterpriseAlert inline /> - Added in Consul 1.8, the audit object allow users to enable auditing
|
- `audit` <EnterpriseAlert inline /> - Added in Consul 1.8, the audit object allow users to enable auditing
|
||||||
and configure a sink and filters for their audit logs. For more information, review the [audit log tutorial](/consul/tutorials/datacenter-operations/audit-logging?utm_source=docs).
|
and configure a sink and filters for their audit logs. For more information, review the [audit log tutorial](https://learn.hashicorp.com/tutorials/consul/audit-logging).
|
||||||
|
|
||||||
<CodeTabs heading="Example audit configuration">
|
<CodeTabs heading="Example audit configuration">
|
||||||
|
|
||||||
|
@ -182,7 +182,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
respected on bootstrapping. If they are not provided, the defaults will be used.
|
respected on bootstrapping. If they are not provided, the defaults will be used.
|
||||||
In order to change the value of these options after bootstrapping, you will need
|
In order to change the value of these options after bootstrapping, you will need
|
||||||
to use the [Consul Operator Autopilot](/commands/operator/autopilot)
|
to use the [Consul Operator Autopilot](/commands/operator/autopilot)
|
||||||
command. For more information about Autopilot, review the [Autopilot tutorial](/consul/tutorials/datacenter-operations/autopilot-datacenter-operations?utm_source=docs).
|
command. For more information about Autopilot, review the [Autopilot tutorial](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations).
|
||||||
|
|
||||||
The following sub-keys are available:
|
The following sub-keys are available:
|
||||||
|
|
||||||
|
@ -495,7 +495,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
only works with API endpoints, not `/ui` or `/debug`, those must be disabled
|
only works with API endpoints, not `/ui` or `/debug`, those must be disabled
|
||||||
with their respective configuration options. Any CLI commands that use disabled
|
with their respective configuration options. Any CLI commands that use disabled
|
||||||
endpoints will no longer function as well. For more general access control, Consul's
|
endpoints will no longer function as well. For more general access control, Consul's
|
||||||
[ACL system](/consul/tutorials/security/access-control-setup-production?utm_source=docs)
|
[ACL system](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production)
|
||||||
should be used, but this option is useful for removing access to HTTP API endpoints
|
should be used, but this option is useful for removing access to HTTP API endpoints
|
||||||
completely, or on specific agents. This is available in Consul 0.9.0 and later.
|
completely, or on specific agents. This is available in Consul 0.9.0 and later.
|
||||||
|
|
||||||
|
@ -940,7 +940,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
|
|
||||||
This designates the datacenter which is authoritative for ACL information. It must be provided to enable ACLs. All servers and datacenters must agree on the ACL datacenter. Setting it on the servers is all you need for cluster-level enforcement, but for the APIs to forward properly from the clients,
|
This designates the datacenter which is authoritative for ACL information. It must be provided to enable ACLs. All servers and datacenters must agree on the ACL datacenter. Setting it on the servers is all you need for cluster-level enforcement, but for the APIs to forward properly from the clients,
|
||||||
it must be set on them too. In Consul 0.8 and later, this also enables agent-level enforcement
|
it must be set on them too. In Consul 0.8 and later, this also enables agent-level enforcement
|
||||||
of ACLs. Please review the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs) for more details.
|
of ACLs. Please review the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for more details.
|
||||||
|
|
||||||
- `acl_default_policy` ((#acl_default_policy_legacy)) - **Deprecated in Consul 1.4.0. See the [`acl.default_policy`](#acl_default_policy) field instead.**
|
- `acl_default_policy` ((#acl_default_policy_legacy)) - **Deprecated in Consul 1.4.0. See the [`acl.default_policy`](#acl_default_policy) field instead.**
|
||||||
Either "allow" or "deny"; defaults to "allow". The default policy controls the
|
Either "allow" or "deny"; defaults to "allow". The default policy controls the
|
||||||
|
@ -990,7 +990,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
- `acl_replication_token` ((#acl_replication_token_legacy)) - **Deprecated
|
- `acl_replication_token` ((#acl_replication_token_legacy)) - **Deprecated
|
||||||
in Consul 1.4.0. See the [`acl.tokens.replication`](#acl_tokens_replication) field
|
in Consul 1.4.0. See the [`acl.tokens.replication`](#acl_tokens_replication) field
|
||||||
instead.** Only used for servers outside the [`primary_datacenter`](#primary_datacenter)
|
instead.** Only used for servers outside the [`primary_datacenter`](#primary_datacenter)
|
||||||
running Consul 0.7 or later. When provided, this will enable [ACL replication](/consul/tutorials/security-operations/access-control-replication-multiple-datacenters?utm_source=docs)
|
running Consul 0.7 or later. When provided, this will enable [ACL replication](https://learn.hashicorp.com/tutorials/consul/access-control-replication-multiple-datacenters)
|
||||||
using this ACL replication using this token to retrieve and replicate the ACLs
|
using this ACL replication using this token to retrieve and replicate the ACLs
|
||||||
to the non-authoritative local datacenter. In Consul 0.9.1 and later you can enable
|
to the non-authoritative local datacenter. In Consul 0.9.1 and later you can enable
|
||||||
ACL replication using [`acl.enable_token_replication`](#acl_enable_token_replication) and then
|
ACL replication using [`acl.enable_token_replication`](#acl_enable_token_replication) and then
|
||||||
|
@ -1225,7 +1225,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
|
||||||
## DNS and Domain Parameters
|
## DNS and Domain Parameters
|
||||||
|
|
||||||
- `dns_config` This object allows a number of sub-keys
|
- `dns_config` This object allows a number of sub-keys
|
||||||
to be set which can tune how DNS queries are serviced. Check the tutorial on [DNS caching](/consul/tutorials/networking/dns-caching?utm_source=docs) for more detail.
|
to be set which can tune how DNS queries are serviced. Check the tutorial on [DNS caching](https://learn.hashicorp.com/tutorials/consul/dns-caching) for more detail.
|
||||||
|
|
||||||
The following sub-keys are available:
|
The following sub-keys are available:
|
||||||
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ documented below in the
|
||||||
configuration reload.
|
configuration reload.
|
||||||
|
|
||||||
You can test the following configuration options by following the
|
You can test the following configuration options by following the
|
||||||
[Getting Started](/consul/tutorials/getting-started/get-started-install?utm_source=docs)
|
[Getting Started](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs)
|
||||||
tutorials to install a local agent.
|
tutorials to install a local agent.
|
||||||
|
|
||||||
## Ports Used
|
## Ports Used
|
||||||
|
|
|
@ -73,7 +73,7 @@ Refer to the following sections for information about host, port, memory, and ot
|
||||||
- [Server Performance](/docs/install/performance)
|
- [Server Performance](/docs/install/performance)
|
||||||
- [Required Ports](/docs/install/ports)
|
- [Required Ports](/docs/install/ports)
|
||||||
|
|
||||||
The [Datacenter Deploy tutorial](/consul/tutorials/production-deploy/reference-architecture?utm_source=docs) contains additional information, including licensing configuration, environment variables, and other details.
|
The [Datacenter Deploy tutorial](https://learn.hashicorp.com/tutorials/consul/reference-architecture?in=consul/production-deploy#deployment-system-requirements) contains additional information, including licensing configuration, environment variables, and other details.
|
||||||
|
|
||||||
### Maximum Latency Network requirements
|
### Maximum Latency Network requirements
|
||||||
|
|
||||||
|
@ -97,7 +97,7 @@ The `-dev` flag is provided for learning purposes only.
|
||||||
We strongly advise against using it for production environments.
|
We strongly advise against using it for production environments.
|
||||||
|
|
||||||
-> **Getting Started Tutorials**: You can test a local agent by following the
|
-> **Getting Started Tutorials**: You can test a local agent by following the
|
||||||
[Getting Started tutorials](/consul/tutorials/getting-started/get-started-install?utm_source=docs).
|
[Getting Started tutorials](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs).
|
||||||
|
|
||||||
When starting Consul with the `-dev` flag, the only additional information Consul needs to run is the location of a directory for storing agent state data.
|
When starting Consul with the `-dev` flag, the only additional information Consul needs to run is the location of a directory for storing agent state data.
|
||||||
You can specify the location with the `-data-dir` flag or define the location in an external file and point the file with the `-config-file` flag.
|
You can specify the location with the `-data-dir` flag or define the location in an external file and point the file with the `-config-file` flag.
|
||||||
|
|
|
@ -27,13 +27,13 @@ it will dump the current telemetry information to the agent's `stderr`.
|
||||||
|
|
||||||
This telemetry information can be used for debugging or otherwise
|
This telemetry information can be used for debugging or otherwise
|
||||||
getting a better view of what Consul is doing. Review the [Monitoring and
|
getting a better view of what Consul is doing. Review the [Monitoring and
|
||||||
Metrics tutorial](/consul/tutorials/day-2-operations/monitor-datacenter-health?utm_source=docs) to learn how collect and interpret Consul data.
|
Metrics tutorial](https://learn.hashicorp.com/tutorials/consul/monitor-datacenter-health?utm_source=docs) to learn how collect and interpret Consul data.
|
||||||
|
|
||||||
Additionally, if the [`telemetry` configuration options](/docs/agent/config/config-files#telemetry)
|
Additionally, if the [`telemetry` configuration options](/docs/agent/config/config-files#telemetry)
|
||||||
are provided, the telemetry information will be streamed to a
|
are provided, the telemetry information will be streamed to a
|
||||||
[statsite](http://github.com/armon/statsite) or [statsd](http://github.com/etsy/statsd) server where
|
[statsite](http://github.com/armon/statsite) or [statsd](http://github.com/etsy/statsd) server where
|
||||||
it can be aggregated and flushed to Graphite or any other metrics store.
|
it can be aggregated and flushed to Graphite or any other metrics store.
|
||||||
For a configuration example for Telegraf, review the [Monitoring with Telegraf tutorial](/consul/tutorials/day-2-operations/monitor-health-telegraf?utm_source=docs).
|
For a configuration example for Telegraf, review the [Monitoring with Telegraf tutorial](https://learn.hashicorp.com/tutorials/consul/monitor-health-telegraf?utm_source=docs).
|
||||||
|
|
||||||
This
|
This
|
||||||
information can also be viewed with the [metrics endpoint](/api-docs/agent#view-metrics) in JSON
|
information can also be viewed with the [metrics endpoint](/api-docs/agent#view-metrics) in JSON
|
||||||
|
|
|
@ -42,4 +42,4 @@ are used, see the [documentation in our GitHub repo](https://github.com/hashicor
|
||||||
|
|
||||||
## Additional Resources
|
## Additional Resources
|
||||||
|
|
||||||
You can learn more about using Consul API Gateway by completing the [Consul API Gateway tutorial](/consul/tutorials/developer-mesh/kubernetes-api-gateway?utm_source=docs).
|
You can learn more about using Consul API Gateway by completing the [Consul API Gateway tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-api-gateway).
|
||||||
|
|
|
@ -31,7 +31,7 @@ Network coordinates manifest in several ways inside Consul:
|
||||||
|
|
||||||
- [Prepared queries](/api-docs/query) can automatically fail over services
|
- [Prepared queries](/api-docs/query) can automatically fail over services
|
||||||
to other Consul datacenters based on network round trip times. See the
|
to other Consul datacenters based on network round trip times. See the
|
||||||
[Geo Failover](/consul/tutorials/developer-discovery/automate-geo-failover?utm_source=docs) for some examples.
|
[Geo Failover](https://learn.hashicorp.com/tutorials/consul/automate-geo-failover) for some examples.
|
||||||
|
|
||||||
- The [Coordinate endpoint](/api-docs/coordinate) exposes raw network
|
- The [Coordinate endpoint](/api-docs/coordinate) exposes raw network
|
||||||
coordinates for use in other applications.
|
coordinates for use in other applications.
|
||||||
|
|
|
@ -36,7 +36,7 @@ Without a quorum, Consul experiences an outage:
|
||||||
it cannot provide most of its capabilities because they rely on
|
it cannot provide most of its capabilities because they rely on
|
||||||
the availability of this state information.
|
the availability of this state information.
|
||||||
If Consul has an outage, normal operation can be restored by following the
|
If Consul has an outage, normal operation can be restored by following the
|
||||||
[outage recovery guide](/consul/tutorials/datacenter-operations/recovery-outage?utm_source=docs).
|
[outage recovery guide](https://learn.hashicorp.com/tutorials/consul/recovery-outage).
|
||||||
|
|
||||||
If Consul is deployed with 3 servers, the quorum size is 2. The deployment can lose 1
|
If Consul is deployed with 3 servers, the quorum size is 2. The deployment can lose 1
|
||||||
server and still maintain quorum, so it has a fault tolerance of 1.
|
server and still maintain quorum, so it has a fault tolerance of 1.
|
||||||
|
@ -135,5 +135,5 @@ However, Consul redundancy zones can be used even without the backing of infrast
|
||||||
For more information on redundancy zones, refer to:
|
For more information on redundancy zones, refer to:
|
||||||
- [Redundancy zone documentation](/docs/enterprise/redundancy)
|
- [Redundancy zone documentation](/docs/enterprise/redundancy)
|
||||||
for a more detailed explanation
|
for a more detailed explanation
|
||||||
- [Redundancy zone tutorial](/consul/tutorials/datacenter-operations/redundancy-zones?utm_source=docs)
|
- [Redundancy zone tutorial](https://learn.hashicorp.com/tutorials/consul/redundancy-zones?in=consul/enterprise)
|
||||||
to learn how to use them
|
to learn how to use them
|
||||||
|
|
|
@ -17,7 +17,7 @@ page documents the system architecture.
|
||||||
[glossary](/docs/install/glossary) of terms to help
|
[glossary](/docs/install/glossary) of terms to help
|
||||||
clarify what is being discussed.
|
clarify what is being discussed.
|
||||||
|
|
||||||
The architecture concepts in this document can be used with the [Reference Architecture guide](/consul/tutorials/production-deploy/reference-architecture?utm_source=docs) when deploying Consul in production.
|
The architecture concepts in this document can be used with the [Reference Architecture guide](https://learn.hashicorp.com/tutorials/consul/reference-architecture?in=consul/production-deploy#deployment-system-requirements) when deploying Consul in production.
|
||||||
|
|
||||||
## 10,000 foot view
|
## 10,000 foot view
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ From a 10,000 foot altitude the architecture of Consul looks like this:
|
||||||
|
|
||||||
Let's break down this image and describe each piece. First of all, we can see
|
Let's break down this image and describe each piece. First of all, we can see
|
||||||
that there are two datacenters, labeled "one" and "two". Consul has first
|
that there are two datacenters, labeled "one" and "two". Consul has first
|
||||||
class support for [multiple datacenters](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs) and
|
class support for [multiple datacenters](https://learn.hashicorp.com/consul/security-networking/datacenters) and
|
||||||
expects this to be the common case.
|
expects this to be the common case.
|
||||||
|
|
||||||
Within each datacenter, we have a mixture of clients and servers. It is expected
|
Within each datacenter, we have a mixture of clients and servers. It is expected
|
||||||
|
@ -67,7 +67,7 @@ an RPC request to the remote Consul servers for that resource and return the res
|
||||||
If the remote datacenter is not available, then those resources will also not be
|
If the remote datacenter is not available, then those resources will also not be
|
||||||
available, but that won't otherwise affect the local datacenter. There are some special
|
available, but that won't otherwise affect the local datacenter. There are some special
|
||||||
situations where a limited subset of data can be replicated, such as with Consul's built-in
|
situations where a limited subset of data can be replicated, such as with Consul's built-in
|
||||||
[ACL replication](/consul/tutorials/security-operations/access-control-replication-multiple-datacenters?utm_source=docs) capability, or
|
[ACL replication](https://learn.hashicorp.com/tutorials/consul/access-control-replication-multiple-datacenters) capability, or
|
||||||
external tools like [consul-replicate](https://github.com/hashicorp/consul-replicate).
|
external tools like [consul-replicate](https://github.com/hashicorp/consul-replicate).
|
||||||
|
|
||||||
In some places, client agents may cache data from the servers to make it
|
In some places, client agents may cache data from the servers to make it
|
||||||
|
|
|
@ -91,6 +91,6 @@ Get started with service discovery today by leveraging Consul on HCP, Consul on
|
||||||
|
|
||||||
Feel free to get started with Consul by exploring one of these Consul tutorials:
|
Feel free to get started with Consul by exploring one of these Consul tutorials:
|
||||||
|
|
||||||
[Getting Started with Consul on VMs](/consul/tutorials/getting-started?utm_source=docs)
|
[Getting Started with Consul on VMs](https://learn.hashicorp.com/collections/consul/getting-started)
|
||||||
[Getting Started with Consul on HCP](/consul/tutorials/cloud-get-started?utm_source=docs)
|
[Getting Started with Consul on HCP](https://learn.hashicorp.com/collections/consul/cloud-get-started)
|
||||||
[Getting Started with Consul on Kubernetes](/consul/tutorials/gs-consul-service-mesh?utm_source=docs)
|
[Getting Started with Consul on Kubernetes](https://learn.hashicorp.com/collections/consul/gs-consul-service-mesh)
|
|
@ -111,7 +111,7 @@ Consul is platform agnostic which makes it a great fit for all environments, inc
|
||||||
Consul is available as a [self-install](/downloads) project or as a fully managed service mesh solution called [HCP Consul](https://portal.cloud.hashicorp.com/sign-in?utm_source=consul_docs).
|
Consul is available as a [self-install](/downloads) project or as a fully managed service mesh solution called [HCP Consul](https://portal.cloud.hashicorp.com/sign-in?utm_source=consul_docs).
|
||||||
HCP Consul enables users to discover and securely connect services without the added operational burden of maintaining a service mesh on their own.
|
HCP Consul enables users to discover and securely connect services without the added operational burden of maintaining a service mesh on their own.
|
||||||
|
|
||||||
You can learn more about Consul by visiting the Consul [tutorials](/consul/tutorials?utm_source=docs).
|
You can learn more about Consul by visiting the Consul [tutorials](https://learn.hashicorp.com/consul).
|
||||||
|
|
||||||
## Next
|
## Next
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@ Please read the [certificate management overview](/docs/connect/ca)
|
||||||
page first to understand how Consul manages certificates with configurable
|
page first to understand how Consul manages certificates with configurable
|
||||||
CA providers.
|
CA providers.
|
||||||
|
|
||||||
-> **Tip:** Complete the [tutorial](/consul/tutorials/vault-secure/vault-pki-consul-connect-ca?utm_source=docs) to learn how to configure Vault as the Consul Connect service mesh Certification Authority.
|
-> **Tip:** Complete the [tutorial]https://learn.hashicorp.com/tutorials/consul/vault-pki-consul-connect-ca?in=consul/vault-secure) to learn how to configure Vault as the Consul Connect service mesh Certification Authority.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
|
@ -74,7 +74,7 @@ via API.
|
||||||
|
|
||||||
!> **Security note:** Enabling Connect is enough to try the feature but doesn't
|
!> **Security note:** Enabling Connect is enough to try the feature but doesn't
|
||||||
automatically ensure complete security. Please read the [Connect production
|
automatically ensure complete security. Please read the [Connect production
|
||||||
tutorial](/consul/tutorials/developer-mesh/service-mesh-production-checklist?utm_source=docs) to understand the additional steps
|
tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-production-checklist) to understand the additional steps
|
||||||
needed for a secure deployment.
|
needed for a secure deployment.
|
||||||
|
|
||||||
## Centralized Proxy and Service Configuration
|
## Centralized Proxy and Service Configuration
|
||||||
|
|
|
@ -15,7 +15,7 @@ but this information will help you understand how Consul service mesh behaves in
|
||||||
Consul Connect is the component shipped with Consul that enables service mesh functionality. The terms _Consul Connect_ and _Consul service mesh_ are used interchangeably throughout this documentation.
|
Consul Connect is the component shipped with Consul that enables service mesh functionality. The terms _Consul Connect_ and _Consul service mesh_ are used interchangeably throughout this documentation.
|
||||||
|
|
||||||
To try service mesh locally, complete the [Getting Started with Consul service
|
To try service mesh locally, complete the [Getting Started with Consul service
|
||||||
mesh](/consul/tutorials/gs-consul-service-mesh/service-mesh?utm_source=docs)
|
mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=docs)
|
||||||
tutorial.
|
tutorial.
|
||||||
|
|
||||||
## Mutual Transport Layer Security (mTLS)
|
## Mutual Transport Layer Security (mTLS)
|
||||||
|
@ -97,7 +97,7 @@ a long period of inactivity (3 days by default), the cache will empty itself.
|
||||||
|
|
||||||
A sidecar proxy's [upstream configuration](/docs/connect/registration/service-registration#upstream-configuration-reference)
|
A sidecar proxy's [upstream configuration](/docs/connect/registration/service-registration#upstream-configuration-reference)
|
||||||
may specify an alternative datacenter or a prepared query that can address services
|
may specify an alternative datacenter or a prepared query that can address services
|
||||||
in multiple datacenters (such as the [geo failover](/consul/tutorials/developer-discovery/automate-geo-failover?utm_source=docs) pattern).
|
in multiple datacenters (such as the [geo failover](https://learn.hashicorp.com/tutorials/consul/automate-geo-failover) pattern).
|
||||||
|
|
||||||
[Intentions](/docs/connect/intentions) verify connections between services by
|
[Intentions](/docs/connect/intentions) verify connections between services by
|
||||||
source and destination name seamlessly across datacenters.
|
source and destination name seamlessly across datacenters.
|
||||||
|
|
|
@ -26,7 +26,7 @@ As of Consul 1.8.0, mesh gateways can also forward gossip and RPC traffic betwee
|
||||||
This is enabled by [WAN federation via mesh gateways](/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways).
|
This is enabled by [WAN federation via mesh gateways](/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways).
|
||||||
|
|
||||||
For more information about mesh gateways, review the [complete documentation](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters)
|
For more information about mesh gateways, review the [complete documentation](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters)
|
||||||
and the [mesh gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs).
|
and the [mesh gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways).
|
||||||
|
|
||||||
![Mesh Gateway Architecture](/img/mesh-gateways.png)
|
![Mesh Gateway Architecture](/img/mesh-gateways.png)
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ Ingress gateways are tightly integrated with Consul's L7 configuration and enabl
|
||||||
attributes like the request path.
|
attributes like the request path.
|
||||||
|
|
||||||
For more information about ingress gateways, review the [complete documentation](/docs/connect/gateways/ingress-gateway)
|
For more information about ingress gateways, review the [complete documentation](/docs/connect/gateways/ingress-gateway)
|
||||||
and the [ingress gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs).
|
and the [ingress gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways).
|
||||||
|
|
||||||
![Ingress Gateway Architecture](/img/ingress-gateways.png)
|
![Ingress Gateway Architecture](/img/ingress-gateways.png)
|
||||||
|
|
||||||
|
@ -65,6 +65,6 @@ connections through the gateway are authorized. Then traditional tools like fire
|
||||||
connections from the known gateway nodes to the destination services.
|
connections from the known gateway nodes to the destination services.
|
||||||
|
|
||||||
For more information about terminating gateways, review the [complete documentation](/docs/connect/gateways/terminating-gateway)
|
For more information about terminating gateways, review the [complete documentation](/docs/connect/gateways/terminating-gateway)
|
||||||
and the [terminating gateway tutorial](/consul/tutorials/developer-mesh/terminating-gateways-connect-external-services?utm_source=docs).
|
and the [terminating gateway tutorial](https://learn.hashicorp.com/tutorials/consul/teminating-gateways-connect-external-services).
|
||||||
|
|
||||||
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
||||||
|
|
|
@ -31,7 +31,7 @@ Mesh gateways enable the following scenarios:
|
||||||
- **Service-to-service communication across datacenters**. Refer to [Enabling Service-to-service Traffic Across Datacenters](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters) for additional information.
|
- **Service-to-service communication across datacenters**. Refer to [Enabling Service-to-service Traffic Across Datacenters](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters) for additional information.
|
||||||
- **Service-to-service communication across admin partitions**. Since Consul 1.11.0, you can create administrative boundaries for single Consul deployments called "admin partitions". You can use mesh gateways to facilitate cross-partition communication. Refer to [Enabling Service-to-service Traffic Across Admin Partitions](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions) for additional information.
|
- **Service-to-service communication across admin partitions**. Since Consul 1.11.0, you can create administrative boundaries for single Consul deployments called "admin partitions". You can use mesh gateways to facilitate cross-partition communication. Refer to [Enabling Service-to-service Traffic Across Admin Partitions](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions) for additional information.
|
||||||
|
|
||||||
-> **Mesh gateway tutorial**: Follow the [mesh gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs) to learn concepts associated with mesh gateways.
|
-> **Mesh gateway tutorial**: Follow the [mesh gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways) to learn concepts associated with mesh gateways.
|
||||||
|
|
||||||
## Ingress Gateways
|
## Ingress Gateways
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ Ingress gateways are tightly integrated with Consul's L7 configuration and enabl
|
||||||
attributes like the request path.
|
attributes like the request path.
|
||||||
|
|
||||||
For more information about ingress gateways, review the [complete documentation](/docs/connect/gateways/ingress-gateway)
|
For more information about ingress gateways, review the [complete documentation](/docs/connect/gateways/ingress-gateway)
|
||||||
and the [ingress gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-ingress-gateways?utm_source=docs).
|
and the [ingress gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-ingress-gateways).
|
||||||
|
|
||||||
![Ingress Gateway Architecture](/img/ingress-gateways.png)
|
![Ingress Gateway Architecture](/img/ingress-gateways.png)
|
||||||
|
|
||||||
|
@ -70,6 +70,6 @@ connections through the gateway are authorized. Then traditional tools like fire
|
||||||
connections from the known gateway nodes to the destination services.
|
connections from the known gateway nodes to the destination services.
|
||||||
|
|
||||||
For more information about terminating gateways, review the [complete documentation](/docs/connect/gateways/terminating-gateway)
|
For more information about terminating gateways, review the [complete documentation](/docs/connect/gateways/terminating-gateway)
|
||||||
and the [terminating gateway tutorial](/consul/tutorials/developer-mesh/terminating-gateways-connect-external-services?utm_source=docs).
|
and the [terminating gateway tutorial](https://learn.hashicorp.com/tutorials/consul/teminating-gateways-connect-external-services).
|
||||||
|
|
||||||
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
||||||
|
|
|
@ -48,7 +48,7 @@ Currently, [Envoy](https://www.envoyproxy.io/) is the only proxy with ingress ga
|
||||||
## Running and Using an Ingress Gateway
|
## Running and Using an Ingress Gateway
|
||||||
|
|
||||||
For a complete example of how to allow external traffic inside your Consul service mesh,
|
For a complete example of how to allow external traffic inside your Consul service mesh,
|
||||||
review the [ingress gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-ingress-gateways?utm_source=docs).
|
review the [ingress gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-ingress-gateways).
|
||||||
|
|
||||||
## Ingress Gateway Configuration
|
## Ingress Gateway Configuration
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ The following diagram describes the architecture for using mesh gateways for cro
|
||||||
|
|
||||||
![Mesh Gateway Architecture](/img/mesh-gateways.png)
|
![Mesh Gateway Architecture](/img/mesh-gateways.png)
|
||||||
|
|
||||||
-> **Mesh Gateway Tutorial**: Follow the [mesh gateway tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs) to learn important concepts associated with using mesh gateways for connecting services across datacenters.
|
-> **Mesh Gateway Tutorial**: Follow the [mesh gateway tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways) to learn important concepts associated with using mesh gateways for connecting services across datacenters.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ Ensure that your Consul environment meets the following requirements.
|
||||||
* A local Consul agent is required to manage its configuration.
|
* A local Consul agent is required to manage its configuration.
|
||||||
* Consul [Connect](/docs/agent/config/config-files#connect) must be enabled in both datacenters.
|
* Consul [Connect](/docs/agent/config/config-files#connect) must be enabled in both datacenters.
|
||||||
* Each [datacenter](/docs/agent/config/config-files#datacenter) must have a unique name.
|
* Each [datacenter](/docs/agent/config/config-files#datacenter) must have a unique name.
|
||||||
* Each datacenters must be [WAN joined](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs).
|
* Each datacenters must be [WAN joined](https://learn.hashicorp.com/consul/security-networking/datacenters).
|
||||||
* The [primary datacenter](/docs/agent/config/config-files#primary_datacenter) must be set to the same value in both datacenters. This specifies which datacenter is the authority for Connect certificates and is required for services in all datacenters to establish mutual TLS with each other.
|
* The [primary datacenter](/docs/agent/config/config-files#primary_datacenter) must be set to the same value in both datacenters. This specifies which datacenter is the authority for Connect certificates and is required for services in all datacenters to establish mutual TLS with each other.
|
||||||
* [gRPC](/docs/agent/config/config-files#grpc_port) must be enabled.
|
* [gRPC](/docs/agent/config/config-files#grpc_port) must be enabled.
|
||||||
* If you want to [enable gateways globally](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/config/config-files#enable_central_service_config).
|
* If you want to [enable gateways globally](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/config/config-files#enable_central_service_config).
|
||||||
|
|
|
@ -15,7 +15,7 @@ WAN federation via mesh gateways allows for Consul servers in different datacent
|
||||||
to be federated exclusively through mesh gateways.
|
to be federated exclusively through mesh gateways.
|
||||||
|
|
||||||
When setting up a
|
When setting up a
|
||||||
[multi-datacenter](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs)
|
[multi-datacenter](https://learn.hashicorp.com/consul/security-networking/datacenters)
|
||||||
Consul cluster, operators must ensure that all Consul servers in every
|
Consul cluster, operators must ensure that all Consul servers in every
|
||||||
datacenter must be directly connectable over their WAN-advertised network
|
datacenter must be directly connectable over their WAN-advertised network
|
||||||
address from each other.
|
address from each other.
|
||||||
|
@ -63,7 +63,7 @@ means you could introduce a set of firewall rules prohibiting `10.0.0.0/24`
|
||||||
from sending any traffic at all to `10.1.2.0/24` for security isolation.
|
from sending any traffic at all to `10.1.2.0/24` for security isolation.
|
||||||
|
|
||||||
You may already have configured [mesh
|
You may already have configured [mesh
|
||||||
gateways](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs)
|
gateways](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways)
|
||||||
to allow for services in the service mesh to freely connect between datacenters
|
to allow for services in the service mesh to freely connect between datacenters
|
||||||
regardless of the lateral connectivity of the nodes hosting the Consul client
|
regardless of the lateral connectivity of the nodes hosting the Consul client
|
||||||
agents.
|
agents.
|
||||||
|
@ -102,7 +102,7 @@ each datacenter otherwise the WAN will become only partly connected.
|
||||||
|
|
||||||
There are a few necessary additional pieces of configuration beyond those
|
There are a few necessary additional pieces of configuration beyond those
|
||||||
required for standing up a
|
required for standing up a
|
||||||
[multi-datacenter](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs)
|
[multi-datacenter](https://learn.hashicorp.com/consul/security-networking/datacenters)
|
||||||
Consul cluster.
|
Consul cluster.
|
||||||
|
|
||||||
Consul servers in the _primary_ datacenter should add this snippet to the
|
Consul servers in the _primary_ datacenter should add this snippet to the
|
||||||
|
|
|
@ -19,7 +19,7 @@ and forward requests to the appropriate destination.
|
||||||
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
![Terminating Gateway Architecture](/img/terminating-gateways.png)
|
||||||
|
|
||||||
For additional use cases and usage patterns, review the tutorial for
|
For additional use cases and usage patterns, review the tutorial for
|
||||||
[understanding terminating gateways](/consul/tutorials/developer-mesh/service-mesh-terminating-gateways?utm_source=docs).
|
[understanding terminating gateways](https://learn.hashicorp.com/tutorials/consul/service-mesh-terminating-gateways?utm_source=docs).
|
||||||
|
|
||||||
~> **Known limitations:** Terminating gateways currently do not support targeting service subsets with
|
~> **Known limitations:** Terminating gateways currently do not support targeting service subsets with
|
||||||
[L7 configuration](/docs/connect/l7-traffic). They route to all instances of a service with no capabilities
|
[L7 configuration](/docs/connect/l7-traffic). They route to all instances of a service with no capabilities
|
||||||
|
@ -79,7 +79,7 @@ a terminating gateway as long as they discover upstreams with the
|
||||||
## Running and Using a Terminating Gateway
|
## Running and Using a Terminating Gateway
|
||||||
|
|
||||||
For a complete example of how to enable connections from services in the Consul service mesh to
|
For a complete example of how to enable connections from services in the Consul service mesh to
|
||||||
services outside the mesh, review the [terminating gateway tutorial](/consul/tutorials/developer-mesh/terminating-gateways-connect-external-services?utm_source=docs).
|
services outside the mesh, review the [terminating gateway tutorial](https://learn.hashicorp.com/tutorials/consul/teminating-gateways-connect-external-services).
|
||||||
|
|
||||||
## Terminating Gateway Configuration
|
## Terminating Gateway Configuration
|
||||||
|
|
||||||
|
@ -129,4 +129,4 @@ After you define a service-defaults configuration entry for each destination, yo
|
||||||
If a service and a destination service-defaults have the same name, the terminating gateway will use the service.
|
If a service and a destination service-defaults have the same name, the terminating gateway will use the service.
|
||||||
|
|
||||||
For a complete example of how to register external services review the
|
For a complete example of how to register external services review the
|
||||||
[external services tutorial](/consul/tutorials/developer-discovery/service-registration-external-services?utm_source=docs).
|
[external services tutorial](https://learn.hashicorp.com/tutorials/consul/service-registration-external-services).
|
||||||
|
|
|
@ -51,24 +51,24 @@ applications can also send open tracing data through Envoy.
|
||||||
|
|
||||||
There are several ways to try Connect in different environments.
|
There are several ways to try Connect in different environments.
|
||||||
|
|
||||||
- The [Getting Started with Consul Service Mesh collection](/consul/tutorials/gs-consul-service-mesh/service-mesh?utm_source=docs)
|
- The [Getting Started with Consul Service Mesh collection](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=docs)
|
||||||
walks you through installing Consul as service mesh for Kubernetes using the Helm
|
walks you through installing Consul as service mesh for Kubernetes using the Helm
|
||||||
chart, deploying services in the service mesh, and using intentions to secure service
|
chart, deploying services in the service mesh, and using intentions to secure service
|
||||||
communications.
|
communications.
|
||||||
|
|
||||||
- The [Getting Started With Consul Service Mesh for Kubernetes](/consul/tutorials/gs-consul-service-mesh/service-mesh-deploy?utm_source=docs) guide walks you through installing Consul on Kubernetes to set up a service mesh for establishing communication between Kubernetes services.
|
- The [Getting Started With Consul Service Mesh for Kubernetes](https://learn.hashicorp.com/tutorials/consul/service-mesh-deploy?in=consul/gs-consul-service-mesh?utm_source=docs) guide walks you through installing Consul on Kubernetes to set up a service mesh for establishing communication between Kubernetes services.
|
||||||
|
|
||||||
- The [Secure Service-to-Service Communication tutorial](/consul/tutorials/developer-mesh/service-mesh-with-envoy-proxy?utm_source=docs)
|
- The [Secure Service-to-Service Communication tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-with-envoy-proxy?utm_source=docs)
|
||||||
is a simple walk through of connecting two services on your local machine
|
is a simple walk through of connecting two services on your local machine
|
||||||
using Consul Connect's built-in proxy and configuring your first intention. The guide also includes an introduction to
|
using Consul Connect's built-in proxy and configuring your first intention. The guide also includes an introduction to
|
||||||
using Envoy as the Connect sidecar proxy.
|
using Envoy as the Connect sidecar proxy.
|
||||||
|
|
||||||
- The [Kubernetes tutorial](/consul/tutorials/kubernetes/kubernetes-minikube?utm_source=docs)
|
- The [Kubernetes tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-minikube?utm_source=docs)
|
||||||
walks you through configuring Consul Connect in Kubernetes using the Helm
|
walks you through configuring Consul Connect in Kubernetes using the Helm
|
||||||
chart, and using intentions. You can run the guide on Minikube or an existing
|
chart, and using intentions. You can run the guide on Minikube or an existing
|
||||||
Kubernetes cluster.
|
Kubernetes cluster.
|
||||||
|
|
||||||
- The [observability tutorial](/consul/tutorials/service-mesh-observability/kubernetes-layer7-observability?utm_source=docs)
|
- The [observability tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-layer7-observability?in=consul/kubernetes)
|
||||||
shows how to deploy a basic metrics collection and visualization pipeline on
|
shows how to deploy a basic metrics collection and visualization pipeline on
|
||||||
a Minikube or Kubernetes cluster using the official Helm charts for Consul,
|
a Minikube or Kubernetes cluster using the official Helm charts for Consul,
|
||||||
Prometheus, and Grafana.
|
Prometheus, and Grafana.
|
||||||
|
|
|
@ -46,7 +46,7 @@ Envoy 1.16.x and older releases are no longer supported (see [HCSEC-2022-07](htt
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To get started with Envoy and see a working example you can follow the [Using
|
To get started with Envoy and see a working example you can follow the [Using
|
||||||
Envoy with Connect](/consul/tutorials/developer-mesh/service-mesh-with-envoy-proxy?utm_source=docs) tutorial.
|
Envoy with Connect](https://learn.hashicorp.com/tutorials/consul/service-mesh-with-envoy-proxy?utm_source=docs) tutorial.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|
|
@ -12,9 +12,9 @@ description: |-
|
||||||
Connect enables secure service-to-service communication over mutual TLS. This
|
Connect enables secure service-to-service communication over mutual TLS. This
|
||||||
provides both in-transit data encryption as well as authorization. This page
|
provides both in-transit data encryption as well as authorization. This page
|
||||||
will document how to secure Connect. To try Connect locally, complete the
|
will document how to secure Connect. To try Connect locally, complete the
|
||||||
[Getting Started guide](/consul/tutorials/gs-consul-service-mesh/service-mesh?utm_source=docs) or for a full security model reference,
|
[Getting Started guide](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=docs) or for a full security model reference,
|
||||||
see the dedicated [Consul security model](/docs/security) page. When
|
see the dedicated [Consul security model](/docs/security) page. When
|
||||||
setting up Connect in production, review this [tutorial](/consul/tutorials/developer-mesh/service-mesh-production-checklist?utm_source=docs).
|
setting up Connect in production, review this [tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-production-checklist?utm_source=consul.io&utm_medium=docs).
|
||||||
|
|
||||||
Connect will function in any Consul configuration. However, unless the checklist
|
Connect will function in any Consul configuration. However, unless the checklist
|
||||||
below is satisfied, Connect is not providing the security guarantees it was
|
below is satisfied, Connect is not providing the security guarantees it was
|
||||||
|
@ -36,7 +36,7 @@ configuration also forces all service-to-service communication to be explicitly
|
||||||
allowed via an allow [intention](/docs/connect/intentions).
|
allowed via an allow [intention](/docs/connect/intentions).
|
||||||
|
|
||||||
To learn how to enable ACLs, please see the
|
To learn how to enable ACLs, please see the
|
||||||
[tutorial on ACLs](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
[tutorial on ACLs](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
**If ACLs are enabled but are in default allow mode**, then services will be
|
**If ACLs are enabled but are in default allow mode**, then services will be
|
||||||
able to communicate by default. Additionally, if a proper anonymous token
|
able to communicate by default. Additionally, if a proper anonymous token
|
||||||
|
|
|
@ -13,7 +13,7 @@ description: >-
|
||||||
One of the primary roles of the agent is management of system-level and application-level health
|
One of the primary roles of the agent is management of system-level and application-level health
|
||||||
checks. A health check is considered to be application-level if it is associated with a
|
checks. A health check is considered to be application-level if it is associated with a
|
||||||
service. If not associated with a service, the check monitors the health of the entire node.
|
service. If not associated with a service, the check monitors the health of the entire node.
|
||||||
Review the [health checks tutorial](/consul/tutorials/developer-discovery/service-registration-health-checks?utm_source=docs)
|
Review the [health checks tutorial](https://learn.hashicorp.com/tutorials/consul/service-registration-health-checks)
|
||||||
to get a more complete example on how to leverage health check capabilities in Consul.
|
to get a more complete example on how to leverage health check capabilities in Consul.
|
||||||
|
|
||||||
A check is defined in a configuration file or added at runtime over the HTTP interface. Checks
|
A check is defined in a configuration file or added at runtime over the HTTP interface. Checks
|
||||||
|
@ -154,7 +154,7 @@ There are several different kinds of checks:
|
||||||
A script check:
|
A script check:
|
||||||
=======
|
=======
|
||||||
|
|
||||||
Review the [service health checks tutorial](/consul/tutorials/developer-discovery/service-registration-health-checks?utm_source=docs)
|
Review the [service health checks tutorial](https://learn.hashicorp.com/tutorials/consul/service-registration-health-checks)
|
||||||
to get a more complete example on how to leverage health check capabilities in Consul.
|
to get a more complete example on how to leverage health check capabilities in Consul.
|
||||||
|
|
||||||
## Registering a health check
|
## Registering a health check
|
||||||
|
|
|
@ -35,7 +35,7 @@ as the DNS server for a node and provide a
|
||||||
[`recursors`](/docs/agent/config/config-files#recursors) configuration so that non-Consul queries
|
[`recursors`](/docs/agent/config/config-files#recursors) configuration so that non-Consul queries
|
||||||
can also be resolved. The last method is to forward all queries for the "consul."
|
can also be resolved. The last method is to forward all queries for the "consul."
|
||||||
domain to a Consul agent from the existing DNS server. Review the
|
domain to a Consul agent from the existing DNS server. Review the
|
||||||
[DNS Forwarding tutorial](/consul/tutorials/networking/dns-forwarding?utm_source=docs) for examples.
|
[DNS Forwarding tutorial](https://learn.hashicorp.com/tutorials/consul/dns-forwarding?utm_source=docs) for examples.
|
||||||
|
|
||||||
You can experiment with Consul's DNS server on the command line using tools such as `dig`:
|
You can experiment with Consul's DNS server on the command line using tools such as `dig`:
|
||||||
|
|
||||||
|
@ -522,7 +522,7 @@ as there is no way for the query to specify a domain.
|
||||||
By default, all DNS results served by Consul set a 0 TTL value. This disables
|
By default, all DNS results served by Consul set a 0 TTL value. This disables
|
||||||
caching of DNS results. However, there are many situations in which caching is
|
caching of DNS results. However, there are many situations in which caching is
|
||||||
desirable for performance and scalability. This is discussed more in the tutorial
|
desirable for performance and scalability. This is discussed more in the tutorial
|
||||||
for [DNS caching](/consul/tutorials/networking/dns-caching?utm_source=docs).
|
for [DNS caching](https://learn.hashicorp.com/tutorials/consul/dns-caching).
|
||||||
|
|
||||||
## WAN Address Translation
|
## WAN Address Translation
|
||||||
|
|
||||||
|
@ -561,5 +561,5 @@ DNS lookups and required policies when ACLs are enabled:
|
||||||
For guidance on how to configure an appropriate token for DNS, refer to the
|
For guidance on how to configure an appropriate token for DNS, refer to the
|
||||||
securing Consul with ACLs guides for:
|
securing Consul with ACLs guides for:
|
||||||
|
|
||||||
- [Production Environments](/consul/tutorials/security/access-control-setup-production?utm_source=docs#token-for-dns)
|
- [Production Environments](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production#token-for-dns)
|
||||||
- [Development Environments](/consul/tutorials/day-0/access-control-setup?utm_source=docs#enable-acls-on-consul-clients)
|
- [Development Environments](https://learn.hashicorp.com/tutorials/consul/access-control-setup?utm_source=docs#enable-acls-on-consul-clients)
|
||||||
|
|
|
@ -19,7 +19,7 @@ a health check. A health check associated with a service is considered to be an
|
||||||
application-level check. Define services in a configuration file or add it at
|
application-level check. Define services in a configuration file or add it at
|
||||||
runtime using the HTTP interface.
|
runtime using the HTTP interface.
|
||||||
|
|
||||||
Complete the [Getting Started tutorials](/consul/tutorials/getting-started/get-started-service-discovery?utm_source=docs) to get hands-on experience registering a simple service with a health check on your local machine.
|
Complete the [Getting Started tutorials](https://learn.hashicorp.com/tutorials/consul/get-started-service-discovery?utm_source=docs) to get hands-on experience registering a simple service with a health check on your local machine.
|
||||||
|
|
||||||
## Service Definition
|
## Service Definition
|
||||||
|
|
||||||
|
|
|
@ -22,14 +22,14 @@ Having a quorum of servers will decrease the risk of data loss if an outage
|
||||||
occurs.
|
occurs.
|
||||||
|
|
||||||
If you have not used Consul KV, complete this [Getting Started
|
If you have not used Consul KV, complete this [Getting Started
|
||||||
tutorial](/consul/tutorials/getting-started/get-started-key-value-store?utm_source=docs) on HashiCorp.
|
tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-key-value-store?utm_source=docs) on HashiCorp.
|
||||||
|
|
||||||
## Accessing the KV store
|
## Accessing the KV store
|
||||||
|
|
||||||
The KV store can be accessed by the [consul kv CLI
|
The KV store can be accessed by the [consul kv CLI
|
||||||
subcommands](/commands/kv), [HTTP API](/api-docs/kv), and Consul UI.
|
subcommands](/commands/kv), [HTTP API](/api-docs/kv), and Consul UI.
|
||||||
To restrict access, enable and configure
|
To restrict access, enable and configure
|
||||||
[ACLs](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
[ACLs](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
Once the ACL system has been bootstrapped, users and services, will need a
|
Once the ACL system has been bootstrapped, users and services, will need a
|
||||||
valid token with KV [privileges](/docs/security/acl/acl-rules#key-value-rules) to
|
valid token with KV [privileges](/docs/security/acl/acl-rules#key-value-rules) to
|
||||||
access the the data store, this includes even reads. We recommend creating a
|
access the the data store, this includes even reads. We recommend creating a
|
||||||
|
@ -66,7 +66,7 @@ using the API and in shell scripts.
|
||||||
|
|
||||||
If you plan to use Consul KV as part of your configuration management process
|
If you plan to use Consul KV as part of your configuration management process
|
||||||
review the [Consul
|
review the [Consul
|
||||||
Template](/consul/tutorials/developer-configuration/consul-template?utm_source=docs)
|
Template](https://learn.hashicorp.com/tutorials/consul/consul-template?utm_source=docs)
|
||||||
tutorial on how to update configuration based on value updates in the KV. Consul
|
tutorial on how to update configuration based on value updates in the KV. Consul
|
||||||
Template is based on Go Templates and allows for a series of scripted actions
|
Template is based on Go Templates and allows for a series of scripted actions
|
||||||
to be initiated on value changes to a Consul key.
|
to be initiated on value changes to a Consul key.
|
||||||
|
@ -88,8 +88,8 @@ increment to the `LockIndex` and the session value is updated to reflect the
|
||||||
session holding the lock. Review the session documentation for more information
|
session holding the lock. Review the session documentation for more information
|
||||||
on the [integration](/docs/dynamic-app-config/sessions#k-v-integration).
|
on the [integration](/docs/dynamic-app-config/sessions#k-v-integration).
|
||||||
|
|
||||||
Review the following tutorials to learn how to use Consul sessions for [application leader election](/consul/tutorials/developer-configuration/application-leader-elections?utm_source=docs) and
|
Review the following tutorials to learn how to use Consul sessions for [application leader election](https://learn.hashicorp.com/tutorials/consul/application-leader-elections) and
|
||||||
to [build distributed semaphores](/consul/tutorials/developer-configuration/distributed-semaphore?utm_source=docs).
|
to [build distributed semaphores](https://learn.hashicorp.com/consul/developer-configuration/semaphore).
|
||||||
|
|
||||||
### Vault
|
### Vault
|
||||||
|
|
||||||
|
|
|
@ -139,7 +139,7 @@ the goal of Consul to protect against misbehaving clients.
|
||||||
|
|
||||||
The primitives provided by sessions and the locking mechanisms of the KV
|
The primitives provided by sessions and the locking mechanisms of the KV
|
||||||
store can be used to build client-side leader election algorithms.
|
store can be used to build client-side leader election algorithms.
|
||||||
These are covered in more detail in the [Leader Election guide](/consul/tutorials/developer-configuration/application-leader-elections?utm_source=docs).
|
These are covered in more detail in the [Leader Election guide](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
|
||||||
|
|
||||||
## Prepared Query Integration
|
## Prepared Query Integration
|
||||||
|
|
||||||
|
|
|
@ -31,8 +31,8 @@ For a detailed architecture overview, see the [Architecture](/docs/ecs/architect
|
||||||
|
|
||||||
There are several ways to get started with Consul with ECS.
|
There are several ways to get started with Consul with ECS.
|
||||||
|
|
||||||
* The [Serverless Consul Service Mesh with ECS and HCP](/consul/tutorials/cloud-integrations/consul-ecs-hcp?utm_source=docs) learn guide shows how to use Terraform to run Consul service mesh applications on ECS with managed Consul servers running in HashiCorp Cloud Platform (HCP).
|
* The [Serverless Consul Service Mesh with ECS and HCP](https://learn.hashicorp.com/tutorials/consul/consul-ecs-hcp?utm_source=docs) learn guide shows how to use Terraform to run Consul service mesh applications on ECS with managed Consul servers running in HashiCorp Cloud Platform (HCP).
|
||||||
* The [Service Mesh with ECS and Consul on EC2](/consul/tutorials/cloud-integrations/consul-ecs-ec2?utm_source=docs) learn guide shows how to use Terraform to run Consul service mesh applications on ECS with Consul servers running on EC2 instances.
|
* The [Service Mesh with ECS and Consul on EC2](https://learn.hashicorp.com/tutorials/consul/consul-ecs-ec2?utm_source=docs) learn guide shows how to use Terraform to run Consul service mesh applications on ECS with Consul servers running on EC2 instances.
|
||||||
* The [Consul with Dev Server on Fargate](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate) example installation deploys a sample application in ECS using the Fargate launch type.
|
* The [Consul with Dev Server on Fargate](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-fargate) example installation deploys a sample application in ECS using the Fargate launch type.
|
||||||
* The [Consul with Dev Server on EC2](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-ec2) example installation deploys a sample application in ECS using the EC2 launch type.
|
* The [Consul with Dev Server on EC2](https://registry.terraform.io/modules/hashicorp/consul-ecs/aws/latest/examples/dev-server-ec2) example installation deploys a sample application in ECS using the EC2 launch type.
|
||||||
|
|
||||||
|
|
|
@ -13,7 +13,7 @@ This topic describes how to manually deploy the ACL controller, which will autom
|
||||||
|
|
||||||
* Your application tasks must include certain tags to be compatible with the ACL controller.
|
* Your application tasks must include certain tags to be compatible with the ACL controller.
|
||||||
Refer to the [Task Tags](/docs/ecs/manual/install#task-tags) section of the installation page.
|
Refer to the [Task Tags](/docs/ecs/manual/install#task-tags) section of the installation page.
|
||||||
* You should be familiar with configuring Consul's secure features, including how to create ACL tokens and policies. Refer to the [Consul Security tutorials](/consul/tutorials/security?utm_source=docs) for an introduction and the [ACL system](/docs/security/acl) documentation for more information.
|
* You should be familiar with configuring Consul's secure features, including how to create ACL tokens and policies. Refer to the [Consul Security tutorials](https://learn.hashicorp.com/collections/consul/security) for an introduction and the [ACL system](/docs/security/acl) documentation for more information.
|
||||||
* If you are using Consul with multiple ECS clusters, each cluster requires its own instance of the ACL controller.
|
* If you are using Consul with multiple ECS clusters, each cluster requires its own instance of the ACL controller.
|
||||||
|
|
||||||
## Set Up Secrets
|
## Set Up Secrets
|
||||||
|
|
|
@ -21,7 +21,7 @@ You should already have followed the [manual installation instructions](/docs/ec
|
||||||
|
|
||||||
You should be familiar with [specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) on ECS.
|
You should be familiar with [specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) on ECS.
|
||||||
|
|
||||||
You should be familiar with configuring Consul's secure features, including how to create ACL tokens and policies. Refer to the [ACL system documentation](/docs/security/acl) and [Day 1: Security tutorials](/consul/tutorials/security?utm_source=docs) for an introduction and additional information.
|
You should be familiar with configuring Consul's secure features, including how to create ACL tokens and policies. Refer to the [ACL system documentation](/docs/security/acl) and [Day 1: Security tutorials](https://learn.hashicorp.com/collections/consul/security) for an introduction and additional information.
|
||||||
|
|
||||||
## Auth Method
|
## Auth Method
|
||||||
|
|
||||||
|
|
|
@ -24,8 +24,8 @@ Admin partitions exist a level above namespaces in the identity hierarchy. They
|
||||||
|
|
||||||
There are tutorials available to help you get started with admin partitions.
|
There are tutorials available to help you get started with admin partitions.
|
||||||
|
|
||||||
- [Multi-Tenancy with Administrative Partitions](/consul/tutorials/enterprise/consul-admin-partitions?utm_source=docs)
|
- [Multi-Tenancy with Administrative Partitions](https://learn.hashicorp.com/tutorials/consul/consul-admin-partitions?utm_source=docs)
|
||||||
- [Multi Cluster Applications with Consul Enterprise Admin Partitions](/consul/tutorials/kubernetes/kubernetes-admin-partitions?utm_source=docs)
|
- [Multi Cluster Applications with Consul Enterprise Admin Partitions](https://learn.hashicorp.com/tutorials/consul/kubernetes-admin-partitions?utm_source=docs)
|
||||||
|
|
||||||
### Default Admin Partition
|
### Default Admin Partition
|
||||||
|
|
||||||
|
|
|
@ -23,7 +23,7 @@ and contain a timestamp, the operation performed, and the user who initiated the
|
||||||
Audit logging enables security and compliance teams within an organization to get
|
Audit logging enables security and compliance teams within an organization to get
|
||||||
greater insight into Consul access and usage patterns.
|
greater insight into Consul access and usage patterns.
|
||||||
|
|
||||||
Complete the [Capture Consul Events with Audit Logging](/consul/tutorials/datacenter-operations/audit-logging?utm_source=docs) tutorial to learn more about Consul's audit logging functionality,
|
Complete the [Capture Consul Events with Audit Logging](https://learn.hashicorp.com/tutorials/consul/audit-logging) tutorial to learn more about Consul's audit logging functionality,
|
||||||
|
|
||||||
For detailed configuration information on configuring the Consul Enterprise's audit
|
For detailed configuration information on configuring the Consul Enterprise's audit
|
||||||
logging, review the Consul [Audit Log](/docs/agent/config/config-files#audit)
|
logging, review the Consul [Audit Log](/docs/agent/config/config-files#audit)
|
||||||
|
|
|
@ -35,6 +35,6 @@ datacenter backups include (but are not limited to):
|
||||||
- Access Control Lists (ACLs)
|
- Access Control Lists (ACLs)
|
||||||
- Namespaces
|
- Namespaces
|
||||||
|
|
||||||
For more experience leveraging Consul's snapshot functionality, complete the [Datacenter Backups in Consul](/consul/tutorials/production-deploy/backup-and-restore?utm_source=docs) tutorial.
|
For more experience leveraging Consul's snapshot functionality, complete the [Datacenter Backups in Consul](https://learn.hashicorp.com/tutorials/consul/backup-and-restore?utm_source=docs) tutorial.
|
||||||
For detailed configuration information on configuring the Consul Enterprise's snapshot agent, review the
|
For detailed configuration information on configuring the Consul Enterprise's snapshot agent, review the
|
||||||
[Consul Snapshot Agent documentation](/commands/snapshot/agent).
|
[Consul Snapshot Agent documentation](/commands/snapshot/agent).
|
||||||
|
|
|
@ -26,7 +26,7 @@ desirable to have topologies like hub-and-spoke with central management
|
||||||
datacenters and "spoke" datacenters that can't interact with each other.
|
datacenters and "spoke" datacenters that can't interact with each other.
|
||||||
|
|
||||||
[Consul Enterprise](https://www.hashicorp.com/consul) offers a [network
|
[Consul Enterprise](https://www.hashicorp.com/consul) offers a [network
|
||||||
area mechanism](/consul/tutorials/datacenter-operations/federation-network-areas?utm_source=docs) that allows operators to
|
area mechanism](https://learn.hashicorp.com/tutorials/consul/federation-network-areas) that allows operators to
|
||||||
federate Consul datacenters together on a pairwise basis, enabling
|
federate Consul datacenters together on a pairwise basis, enabling
|
||||||
partially-connected network topologies. Once a link is created, Consul agents
|
partially-connected network topologies. Once a link is created, Consul agents
|
||||||
can make queries to the remote datacenter in service of both API and DNS
|
can make queries to the remote datacenter in service of both API and DNS
|
||||||
|
|
|
@ -29,7 +29,7 @@ Refer to the instructions on [upgrading to 1.10.x](/docs/upgrading/instructions/
|
||||||
|
|
||||||
## Q: Is there a tutorial available for the license configuration steps?
|
## Q: Is there a tutorial available for the license configuration steps?
|
||||||
|
|
||||||
Please visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs).
|
Please visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs).
|
||||||
|
|
||||||
## Q: What resources are available?
|
## Q: What resources are available?
|
||||||
|
|
||||||
|
@ -41,7 +41,7 @@ The list below is a great starting point for learning more about the license cha
|
||||||
|
|
||||||
- [License configuration values documentation](/docs/enterprise/license/overview#binaries-without-built-in-licenses)
|
- [License configuration values documentation](/docs/enterprise/license/overview#binaries-without-built-in-licenses)
|
||||||
|
|
||||||
- [Install a HashiCorp Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs)
|
- [Install a HashiCorp Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs)
|
||||||
|
|
||||||
## Q: Do these changes impact all customers/licenses?
|
## Q: Do these changes impact all customers/licenses?
|
||||||
|
|
||||||
|
@ -142,7 +142,7 @@ Please see the [upgrade requirements](faq#q-what-are-the-upgrade-requirements).
|
||||||
|
|
||||||
1. Run [`consul license get -signed`](/commands/license#get) to extract the license from their running cluster. Store the license in a secure location on disk.
|
1. Run [`consul license get -signed`](/commands/license#get) to extract the license from their running cluster. Store the license in a secure location on disk.
|
||||||
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have access to the required license. This could be via the client agent configuration file or an environment variable.
|
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have access to the required license. This could be via the client agent configuration file or an environment variable.
|
||||||
1. Visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
1. Visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
||||||
1. Follow the Consul upgrade [documentation](/docs/upgrading).
|
1. Follow the Consul upgrade [documentation](/docs/upgrading).
|
||||||
|
|
||||||
### Kubernetes
|
### Kubernetes
|
||||||
|
@ -163,14 +163,14 @@ Once you have the license then create a Kubernetes secret containing the license
|
||||||
1. Acquire a valid Consul Enterprise license. If you are an existing HashiCorp enterprise customer you may contact your organization's customer success manager (CSM) or email support-softwaredelivery@hashicorp.com for information on how to get your organization's enterprise license.
|
1. Acquire a valid Consul Enterprise license. If you are an existing HashiCorp enterprise customer you may contact your organization's customer success manager (CSM) or email support-softwaredelivery@hashicorp.com for information on how to get your organization's enterprise license.
|
||||||
1. Store the license in a secure location on disk.
|
1. Store the license in a secure location on disk.
|
||||||
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have the required license. This could be via the client agent configuration file or an environment variable.
|
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have the required license. This could be via the client agent configuration file or an environment variable.
|
||||||
Visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
Visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
||||||
1. Follow the Consul upgrade [documentation](/docs/upgrading).
|
1. Follow the Consul upgrade [documentation](/docs/upgrading).
|
||||||
|
|
||||||
### Kubernetes
|
### Kubernetes
|
||||||
|
|
||||||
1. Acquire a valid Consul Enterprise license. If you are an existing HashiCorp enterprise customer you may contact your organization's customer success manager (CSM) or email support-softwaredelivery@hashicorp.com for information on how to get your organization's enterprise license.
|
1. Acquire a valid Consul Enterprise license. If you are an existing HashiCorp enterprise customer you may contact your organization's customer success manager (CSM) or email support-softwaredelivery@hashicorp.com for information on how to get your organization's enterprise license.
|
||||||
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have the required license. This could be via the client agent configuration file or an environment variable.
|
1. Set up the necessary configuration so that when Consul Enterprise reboots it will have the required license. This could be via the client agent configuration file or an environment variable.
|
||||||
Visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
Visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
||||||
1. Proceed with the `helm` [upgrade instructions](/docs/k8s/upgrade)
|
1. Proceed with the `helm` [upgrade instructions](/docs/k8s/upgrade)
|
||||||
|
|
||||||
## Q: Will Consul downgrades/rollbacks work?
|
## Q: Will Consul downgrades/rollbacks work?
|
||||||
|
|
|
@ -19,7 +19,7 @@ agent's configuration or environment. Also, prior to 1.10.0, server agents would
|
||||||
the license between themselves. This no longer occurs and the license must be present on each server agent
|
the license between themselves. This no longer occurs and the license must be present on each server agent
|
||||||
when it is started.
|
when it is started.
|
||||||
|
|
||||||
-> Visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
-> Visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
||||||
|
|
||||||
### Applying a License
|
### Applying a License
|
||||||
|
|
||||||
|
|
|
@ -21,8 +21,8 @@ to provide self-service through delegation of administrative privileges.
|
||||||
|
|
||||||
For more information on how to use namespaces with Consul Enterprise please review the following tutorials:
|
For more information on how to use namespaces with Consul Enterprise please review the following tutorials:
|
||||||
|
|
||||||
- [Register and Discover Services within Namespaces](/consul/tutorials/namespaces/namespaces-share-datacenter-access?utm_source=docs) - Register multiple services within different namespaces in Consul.
|
- [Register and Discover Services within Namespaces](https://learn.hashicorp.com/tutorials/consul/namespaces-share-datacenter-access?utm_source=docs) - Register multiple services within different namespaces in Consul.
|
||||||
- [Setup Secure Namespaces](/consul/tutorials/namespaces/namespaces-secure-shared-access?utm_source=docs) - Secure resources within a namespace and delegate namespace ACL rights via ACL tokens.
|
- [Setup Secure Namespaces](https://learn.hashicorp.com/tutorials/consul/namespaces-secure-shared-access?utm_source=docs) - Secure resources within a namespace and delegate namespace ACL rights via ACL tokens.
|
||||||
|
|
||||||
## Namespace Definition
|
## Namespace Definition
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ connectivity between agent members on the same segment.
|
||||||
|
|
||||||
![Consul datacenter agent connectivity with network segments](/img/network-segments/consul-network-segments-multiple.png)
|
![Consul datacenter agent connectivity with network segments](/img/network-segments/consul-network-segments-multiple.png)
|
||||||
|
|
||||||
Complete the [Network Segments](/consul/tutorials/datacenter-operations/network-partition-datacenters?utm_source=docs) tutorial to learn more about network segments.
|
Complete the [Network Segments](https://learn.hashicorp.com/tutorials/consul/network-partition-datacenters) tutorial to learn more about network segments.
|
||||||
|
|
||||||
-> **Info:** Network segments enable you to operate a Consul datacenter without full
|
-> **Info:** Network segments enable you to operate a Consul datacenter without full
|
||||||
mesh (LAN) connectivity between agents. To federate multiple Consul datacenters
|
mesh (LAN) connectivity between agents. To federate multiple Consul datacenters
|
||||||
|
@ -59,8 +59,8 @@ forwarding RPCs through the Consul servers in their local cluster, but they
|
||||||
never interact with remote Consul servers directly. There are two tutorials that
|
never interact with remote Consul servers directly. There are two tutorials that
|
||||||
will guide you through inter-cluster network models:
|
will guide you through inter-cluster network models:
|
||||||
|
|
||||||
1. [WAN gossip (OSS)](/consul/tutorials/networking/federation-gossip-wan?utm_source=docs)
|
1. [WAN gossip (OSS)](https://learn.hashicorp.com/consul/security-networking/datacenters)
|
||||||
1. [Network Areas (Enterprise)](/consul/tutorials/datacenter-operations/federation-network-areas?utm_source=docs).
|
1. [Network Areas (Enterprise)](https://learn.hashicorp.com/tutorials/consul/federation-network-areas).
|
||||||
|
|
||||||
**LAN Gossip Pool**: A set of Consul agents that have full mesh connectivity
|
**LAN Gossip Pool**: A set of Consul agents that have full mesh connectivity
|
||||||
among themselves, and use Serf to maintain a shared view of the members of the
|
among themselves, and use Serf to maintain a shared view of the members of the
|
||||||
|
@ -83,7 +83,7 @@ Each additional segment is defined by:
|
||||||
Serf LAN listener on the server
|
Serf LAN listener on the server
|
||||||
|
|
||||||
~> **Note:** Prior to Consul 1.7.3, a Consul server agent configured with too
|
~> **Note:** Prior to Consul 1.7.3, a Consul server agent configured with too
|
||||||
many network segments may not be able to start due to [limitations](/consul/tutorials/datacenter-operations/network-partition-datacenters?utm_source=docs#network-segments-limitations)
|
many network segments may not be able to start due to [limitations](https://learn.hashicorp.com/tutorials/consul/network-partition-datacenters#network-segments-limitations)
|
||||||
in Serf.
|
in Serf.
|
||||||
|
|
||||||
### Example Server Configuration
|
### Example Server Configuration
|
||||||
|
|
|
@ -30,5 +30,5 @@ for server nodes while also providing (and expanding) the capabilities of
|
||||||
[enhanced read scalability](/docs/enterprise/read-scale) by also including recovery
|
[enhanced read scalability](/docs/enterprise/read-scale) by also including recovery
|
||||||
capabilities.
|
capabilities.
|
||||||
|
|
||||||
For more information, complete the [Redundancy Zones](/consul/tutorials/datacenter-operations/autopilot-datacenter-operations?utm_source=docs#redundancy-zones) tutorial
|
For more information, complete the [Redundancy Zones](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations#redundancy-zones) tutorial
|
||||||
and reference the [Consul Autopilot](/commands/operator/autopilot) documentation.
|
and reference the [Consul Autopilot](/commands/operator/autopilot) documentation.
|
||||||
|
|
|
@ -23,4 +23,4 @@ currently in a cluster. When an equal amount of new server nodes are joined runn
|
||||||
will be demoted to non voting members. Demotion of legacy server nodes will not occur until the voting members on the new version match.
|
will be demoted to non voting members. Demotion of legacy server nodes will not occur until the voting members on the new version match.
|
||||||
Once this demotion occurs, the previous versioned servers can be removed from the cluster safely.
|
Once this demotion occurs, the previous versioned servers can be removed from the cluster safely.
|
||||||
|
|
||||||
Review the [Consul operator autopilot](/commands/operator/autopilot) documentation and complete the [Automated Upgrade](/consul/tutorials/datacenter-operations/autopilot-datacenter-operations?utm_source=docs#upgrade-migrations) tutorial to learn more about automated upgrades.
|
Review the [Consul operator autopilot](/commands/operator/autopilot) documentation and complete the [Automated Upgrade](https://learn.hashicorp.com/tutorials/consul/autopilot-datacenter-operations#upgrade-migrations) tutorial to learn more about automated upgrades.
|
||||||
|
|
|
@ -9,9 +9,9 @@ description: |-
|
||||||
|
|
||||||
# Consul Guides
|
# Consul Guides
|
||||||
|
|
||||||
~> The Consul guides are now Consul [tutorials](/consul/tutorials?utm_source=docs).
|
~> The Consul guides are now Consul [tutorials](https://learn.hashicorp.com/consul).
|
||||||
|
|
||||||
[Guides](/consul/tutorials?utm_source=docs) are step by step command-line
|
[Guides](https://learn.hashicorp.com/consul) are step by step command-line
|
||||||
walkthroughs that demonstrate how to perform common operations using Consul, and
|
walkthroughs that demonstrate how to perform common operations using Consul, and
|
||||||
complement the feature-focused Consul documentation.
|
complement the feature-focused Consul documentation.
|
||||||
|
|
||||||
|
|
|
@ -16,4 +16,4 @@ and a link to our guides that guide you through common tasks.
|
||||||
|
|
||||||
- Follow [the documentation](/docs/install) to install Consul either with a precompiled binary or from source.
|
- Follow [the documentation](/docs/install) to install Consul either with a precompiled binary or from source.
|
||||||
- Read more about the [configuration options](/docs/agent/config) for Consul servers and clients.
|
- Read more about the [configuration options](/docs/agent/config) for Consul servers and clients.
|
||||||
- Get started using Consul by completing the step-by-step [tutorials](/consul/tutorials?utm_source=docs).
|
- Get started using Consul by completing the step-by-step [tutorials](https://learn.hashicorp.com/consul).
|
||||||
|
|
|
@ -20,7 +20,7 @@ Downloading a precompiled binary is easiest, and we provide downloads over TLS
|
||||||
along with SHA256 sums to verify the binary. We also distribute a PGP signature
|
along with SHA256 sums to verify the binary. We also distribute a PGP signature
|
||||||
with the SHA256 sums that can be verified.
|
with the SHA256 sums that can be verified.
|
||||||
|
|
||||||
The [Getting Started guides](/consul/tutorials/getting-started/get-started-install?utm_source=docs) provide a quick walkthrough of installing and using Consul on your local machine.
|
The [Getting Started guides](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs) provide a quick walkthrough of installing and using Consul on your local machine.
|
||||||
|
|
||||||
## Precompiled Binaries
|
## Precompiled Binaries
|
||||||
|
|
||||||
|
|
|
@ -112,9 +112,9 @@ Here are some general recommendations:
|
||||||
- For DNS-heavy workloads, configuring all Consul agents in a cluster with the
|
- For DNS-heavy workloads, configuring all Consul agents in a cluster with the
|
||||||
[`allow_stale`](/docs/agent/config/config-files#allow_stale) configuration option will allow reads to
|
[`allow_stale`](/docs/agent/config/config-files#allow_stale) configuration option will allow reads to
|
||||||
scale across all Consul servers, not just the leader. Consul 0.7 and later enables stale reads
|
scale across all Consul servers, not just the leader. Consul 0.7 and later enables stale reads
|
||||||
for DNS by default. See [Stale Reads](/consul/tutorials/networking/dns-caching?utm_source=docs#stale-reads) in the
|
for DNS by default. See [Stale Reads](https://learn.hashicorp.com/tutorials/consul/dns-caching#stale-reads) in the
|
||||||
[DNS Caching](/consul/tutorials/networking/dns-caching?utm_source=docs) guide for more details. It's also good to set
|
[DNS Caching](https://learn.hashicorp.com/tutorials/consul/dns-caching) guide for more details. It's also good to set
|
||||||
reasonable, non-zero [DNS TTL values](/consul/tutorials/networking/dns-caching?utm_source=docs#ttl-values) if your clients will
|
reasonable, non-zero [DNS TTL values](https://learn.hashicorp.com/tutorials/consul/dns-caching#ttl-values) if your clients will
|
||||||
respect them.
|
respect them.
|
||||||
|
|
||||||
- In other applications that perform high volumes of reads against Consul, consider using the
|
- In other applications that perform high volumes of reads against Consul, consider using the
|
||||||
|
|
|
@ -16,13 +16,13 @@ These Consul tools are created and managed by the dedicated engineers at HashiCo
|
||||||
|
|
||||||
- [Envconsul](https://github.com/hashicorp/envconsul) - Read and set environmental variables for processes from Consul.
|
- [Envconsul](https://github.com/hashicorp/envconsul) - Read and set environmental variables for processes from Consul.
|
||||||
- [Consul API Gateway](https://github.com/hashicorp/consul-api-gateway/) - dedicated ingress solution for intelligently routing traffic to applications running on a Consul Service Mesh.
|
- [Consul API Gateway](https://github.com/hashicorp/consul-api-gateway/) - dedicated ingress solution for intelligently routing traffic to applications running on a Consul Service Mesh.
|
||||||
- [Consul ESM](https://github.com/hashicorp/consul-esm) - Provides external service monitoring for Consul. Complete the [tutorial]((/consul/tutorials/developer-discovery/service-registration-external-services?utm_source=docs)) to learn more.
|
- [Consul ESM](https://github.com/hashicorp/consul-esm) - Provides external service monitoring for Consul. Complete the [tutorial]((https://learn.hashicorp.com/tutorials/consul/service-registration-external-services?utm_source=docs)) to learn more.
|
||||||
- [Consul Migrate](https://github.com/hashicorp/consul-migrate) - Data migration tool to handle Consul upgrades to 0.5.1+
|
- [Consul Migrate](https://github.com/hashicorp/consul-migrate) - Data migration tool to handle Consul upgrades to 0.5.1+
|
||||||
- [Consul Replicate](https://github.com/hashicorp/consul-replicate) - Consul cross-DC KV replication daemon.
|
- [Consul Replicate](https://github.com/hashicorp/consul-replicate) - Consul cross-DC KV replication daemon.
|
||||||
- [Consul Template](https://github.com/hashicorp/consul-template) - Generic template rendering and notifications with Consul. Complete the [tutorial](/consul/tutorials/developer-configuration/consul-template?utm_source=docs) to the learn more.
|
- [Consul Template](https://github.com/hashicorp/consul-template) - Generic template rendering and notifications with Consul. Complete the [tutorial](https://learn.hashicorp.com/tutorials/consul/consul-template?utm_source=docs) to the learn more.
|
||||||
- [Consul-Terraform Sync](https://github.com/hashicorp/consul-terraform-sync) -
|
- [Consul-Terraform Sync](https://github.com/hashicorp/consul-terraform-sync) -
|
||||||
enables dynamic updates to network infrastructure devices triggered by service
|
enables dynamic updates to network infrastructure devices triggered by service
|
||||||
changes. Complete the [tutorial](/consul/tutorials/network-infrastructure-automation?utm_source=docs) to learn more.
|
changes. Complete the [tutorial](https://learn.hashicorp.com/collections/consul/network-infrastructure-automation?utm_source=docs) to learn more.
|
||||||
|
|
||||||
## Community Tools
|
## Community Tools
|
||||||
|
|
||||||
|
|
|
@ -43,7 +43,7 @@ Consul-Terraform-Sync compatible Terraform module development process is fairly
|
||||||
|
|
||||||
- Consul [documentation](/docs)
|
- Consul [documentation](/docs)
|
||||||
- Consul-Terraform-Sync [documentation](/docs/nia)
|
- Consul-Terraform-Sync [documentation](/docs/nia)
|
||||||
- Writing Consul-Terraform-Sync compatible Terraform modules using our [guide](/docs/nia/terraform-modules) and [tutorial](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-module?utm_source=docs)
|
- Writing Consul-Terraform-Sync compatible Terraform modules using our [guide](/docs/nia/terraform-modules) and [tutorial](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-module?utm_source=docs)
|
||||||
- Example Terraform Modules for reference: [PAN-OS](https://registry.terraform.io/modules/PaloAltoNetworks/dag-nia/panos/latest), [Simple Print Module](https://registry.terraform.io/modules/findkim/print/cts/latest) and a [Template to structure your Terraform Modules](https://github.com/hashicorp/consul-terraform-sync-template-module)
|
- Example Terraform Modules for reference: [PAN-OS](https://registry.terraform.io/modules/PaloAltoNetworks/dag-nia/panos/latest), [Simple Print Module](https://registry.terraform.io/modules/findkim/print/cts/latest) and a [Template to structure your Terraform Modules](https://github.com/hashicorp/consul-terraform-sync-template-module)
|
||||||
- Publishing to the Terraform Registry [guidelines](https://www.terraform.io/docs/registry/modules/publish.html)
|
- Publishing to the Terraform Registry [guidelines](https://www.terraform.io/docs/registry/modules/publish.html)
|
||||||
|
|
||||||
|
|
|
@ -89,7 +89,7 @@ Here are links to resources, documentation, examples and best practices to guide
|
||||||
|
|
||||||
**API Gateway**
|
**API Gateway**
|
||||||
|
|
||||||
- [Ambassador Integration documentation](/consul/tutorials/developer-mesh/service-mesh-gateway-ambassador?utm_source=docs)
|
- [Ambassador Integration documentation](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateway-ambassador?utm_source=docs)
|
||||||
- [F5 Terminating Gateway Integration Documentation](https://www.hashicorp.com/integrations/f5-networks/consul)
|
- [F5 Terminating Gateway Integration Documentation](https://www.hashicorp.com/integrations/f5-networks/consul)
|
||||||
- [Traefik Integration with Consul Service Mesh](https://traefik.io/blog/integrating-consul-connect-service-mesh-with-traefik-2-5/)
|
- [Traefik Integration with Consul Service Mesh](https://traefik.io/blog/integrating-consul-connect-service-mesh-with-traefik-2-5/)
|
||||||
- [Kong's Ingress Controller Integration with Consul](https://www.hashicorp.com/integrations/kong/consul)
|
- [Kong's Ingress Controller Integration with Consul](https://www.hashicorp.com/integrations/kong/consul)
|
||||||
|
@ -109,10 +109,10 @@ Here are links to resources, documentation, examples and best practices to guide
|
||||||
|
|
||||||
#### Platform:
|
#### Platform:
|
||||||
|
|
||||||
- [Consul-AWS for AWS Cloud Map](/consul/tutorials/cloud-integrations/sync-aws-services?utm_source=docs)
|
- [Consul-AWS for AWS Cloud Map](https://learn.hashicorp.com/tutorials/consul/sync-aws-services?utm_source=docs)
|
||||||
- [Consul Integration with AWS ECS](/docs/ecs/get-started/install)
|
- [Consul Integration with AWS ECS](/docs/ecs/get-started/install)
|
||||||
- [Consul Integration with Layer5 Meshery](https://www.hashicorp.com/integrations/layer5-io/consul)
|
- [Consul Integration with Layer5 Meshery](https://www.hashicorp.com/integrations/layer5-io/consul)
|
||||||
- [Consul Integration with VMware Tanzu Application Service](/consul/tutorials/cloud-integrations/sync-pivotal-cloud-services?utm_source=docs)
|
- [Consul Integration with VMware Tanzu Application Service](https://learn.hashicorp.com/tutorials/consul/sync-pivotal-cloud-services?utm_source=docs)
|
||||||
|
|
||||||
#### Infrastructure:
|
#### Infrastructure:
|
||||||
|
|
||||||
|
@ -133,32 +133,32 @@ Here are links to resources, documentation, examples and best practices to guide
|
||||||
|
|
||||||
**Load Balancer**
|
**Load Balancer**
|
||||||
|
|
||||||
- [Load Balancing with NGINX and Consul Template](/consul/tutorials/load-balancing/load-balancing-nginx?utm_source=docs)
|
- [Load Balancing with NGINX and Consul Template](https://learn.hashicorp.com/tutorials/consul/load-balancing-nginx?utm_source=docs)
|
||||||
- [Load Balancing with HAProxy Service Discovery](/consul/tutorials/load-balancing/load-balancing-haproxy?utm_source=docs)
|
- [Load Balancing with HAProxy Service Discovery](https://learn.hashicorp.com/tutorials/consul/load-balancing-haproxy?utm_source=docs)
|
||||||
|
|
||||||
**Network Infrastructure Automation \(using CTS\):**
|
**Network Infrastructure Automation \(using CTS\):**
|
||||||
|
|
||||||
- [Automate F5 BIG-IP with Consul NIA](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-f5-bigip-fast?utm_source=docs)
|
- [Automate F5 BIG-IP with Consul NIA](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-f5-bigip-fast?utm_source=docs)
|
||||||
- [Automate VMware Advanced Load Balancers (Avi) with Consul NIA](https://www.hashicorp.com/integrations/_vmware/consul)
|
- [Automate VMware Advanced Load Balancers (Avi) with Consul NIA](https://www.hashicorp.com/integrations/_vmware/consul)
|
||||||
|
|
||||||
**Application Delivery Controllers \(ADC\):**
|
**Application Delivery Controllers \(ADC\):**
|
||||||
|
|
||||||
- [Automate A10 ADC with Consul NIA](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-a10-adc?utm_source=docs)
|
- [Automate A10 ADC with Consul NIA](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-a10-adc?utm_source=docs)
|
||||||
- [Automate Citrix ADC with Consul NIA](https://www.hashicorp.com/integrations/citrix-adc/consul)
|
- [Automate Citrix ADC with Consul NIA](https://www.hashicorp.com/integrations/citrix-adc/consul)
|
||||||
|
|
||||||
### 3. Develop and Test
|
### 3. Develop and Test
|
||||||
|
|
||||||
The only knowledge necessary to write a plugin is basic command-line skills and knowledge of the [Go programming language](http://www.golang.org). Use the plugin interface to develop your integration. All integrations should contain unit and acceptance testing.
|
The only knowledge necessary to write a plugin is basic command-line skills and knowledge of the [Go programming language](http://www.golang.org). Use the plugin interface to develop your integration. All integrations should contain unit and acceptance testing.
|
||||||
|
|
||||||
**HCP Consul**: The process to configure a testing instance of HCP consul [is very simple](/consul/tutorials/cloud-get-started/get-started-consul?utm_source=docs). HCP has been designed as a HashiCorp managed service so configuration is minimal as only Consul client agents need to be installed. Furthermore, HashiCorp provides all new users an initial credit which should last approximately 2 months using a [development cluster](https://cloud.hashicorp.com/pricing/consul). When deployed with AWS free tier services, there should be no cost beyond the time spent by the designated tester.
|
**HCP Consul**: The process to configure a testing instance of HCP consul [is very simple](https://learn.hashicorp.com/tutorials/cloud/consul-introduction?utm_source=docs). HCP has been designed as a HashiCorp managed service so configuration is minimal as only Consul client agents need to be installed. Furthermore, HashiCorp provides all new users an initial credit which should last approximately 2 months using a [development cluster](https://cloud.hashicorp.com/pricing/consul). When deployed with AWS free tier services, there should be no cost beyond the time spent by the designated tester.
|
||||||
|
|
||||||
Please note that HCP Consul is currently only deployed on AWS so the partner's application should be able to be deployed or run in AWS. For more information, please refer to [Peering an HVN to an AWS VPC for HCP Consul](https://www.youtube.com/watch?v=vuKjkIGYZlU).
|
Please note that HCP Consul is currently only deployed on AWS so the partner's application should be able to be deployed or run in AWS. For more information, please refer to [Peering an HVN to an AWS VPC for HCP Consul](https://www.youtube.com/watch?v=vuKjkIGYZlU).
|
||||||
|
|
||||||
#### HCP Consul Resource Links:
|
#### HCP Consul Resource Links:
|
||||||
|
|
||||||
- [Getting Started with HCP Consul](/consul/tutorials/cloud-get-started/get-started-consul?utm_source=docs)
|
- [Getting Started with HCP Consul](https://learn.hashicorp.com/tutorials/cloud/consul-introduction?utm_source=docs)
|
||||||
- [Peering an HVN to a VPC for HCP Consul](https://www.youtube.com/watch?v=vuKjkIGYZlU)
|
- [Peering an HVN to a VPC for HCP Consul](https://www.youtube.com/watch?v=vuKjkIGYZlU)
|
||||||
- [Connecting a Consul Client to HCP Consul](/consul/tutorials/cloud-get-started/consul-client-aws-ec2?utm_source=docs)
|
- [Connecting a Consul Client to HCP Consul](https://learn.hashicorp.com/tutorials/cloud/consul-client-aws-ec2?utm_source=docs)
|
||||||
- [Monitoring HCP Consul with Datadog](https://docs.datadoghq.com/integrations/guide/hcp-consul/)
|
- [Monitoring HCP Consul with Datadog](https://docs.datadoghq.com/integrations/guide/hcp-consul/)
|
||||||
|
|
||||||
**Consul Enterprise**: An integration qualifies for Consul Enterprise when it is tested and compatible with Consul Enterprise Namespaces.
|
**Consul Enterprise**: An integration qualifies for Consul Enterprise when it is tested and compatible with Consul Enterprise Namespaces.
|
||||||
|
|
|
@ -10,7 +10,7 @@ description: >-
|
||||||
|
|
||||||
# ACL System ((#version_8_acls))
|
# ACL System ((#version_8_acls))
|
||||||
|
|
||||||
This content has been moved into the [ACL Guide](/consul/tutorials/security/access-control-setup-production?utm_source=docs).
|
This content has been moved into the [ACL Guide](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
|
||||||
|
|
||||||
See [Complete ACL Coverage in Consul 0.8](/docs/security/acl/acl-legacy) for details
|
See [Complete ACL Coverage in Consul 0.8](/docs/security/acl/acl-legacy) for details
|
||||||
about ACL changes in Consul 0.8 and later.
|
about ACL changes in Consul 0.8 and later.
|
||||||
|
|
|
@ -15,7 +15,7 @@ Welcome to the intro guide to Consul! This guide is the best place to start
|
||||||
with Consul. We cover what Consul is, what problems it can solve, how it compares
|
with Consul. We cover what Consul is, what problems it can solve, how it compares
|
||||||
to existing software, and how you can get started using it. If you are familiar
|
to existing software, and how you can get started using it. If you are familiar
|
||||||
with the basics of Consul, the [documentation](/docs) provides a more
|
with the basics of Consul, the [documentation](/docs) provides a more
|
||||||
detailed reference of available features. Complete the [Get Started](/consul/tutorials/getting-started/get-started-install?utm_source=docs) tutorials for a step-by-step guide on how
|
detailed reference of available features. Complete the [Get Started](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs) tutorials for a step-by-step guide on how
|
||||||
to use Consul.
|
to use Consul.
|
||||||
|
|
||||||
## Why Consul?
|
## Why Consul?
|
||||||
|
@ -114,5 +114,5 @@ forward the request to the remote datacenter and return the result.
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
Complete the [Get Started](/consul/tutorials/getting-started/get-started-install?utm_source=docs) tutorials
|
Complete the [Get Started](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs) tutorials
|
||||||
to learn more about Consul and how to get Consul up and running.
|
to learn more about Consul and how to get Consul up and running.
|
||||||
|
|
|
@ -10,7 +10,7 @@ description: >-
|
||||||
|
|
||||||
This topic describes the architecture, components, and resources associated with Consul deployments to Kubernetes. Consul employs the same architectural design on Kubernetes as it does with other platforms (see [Architecture](/docs/architecture)), but Kubernetes provides additional benefits that make operating a Consul cluster easier.
|
This topic describes the architecture, components, and resources associated with Consul deployments to Kubernetes. Consul employs the same architectural design on Kubernetes as it does with other platforms (see [Architecture](/docs/architecture)), but Kubernetes provides additional benefits that make operating a Consul cluster easier.
|
||||||
|
|
||||||
Refer to the standard [production deployment guide](/consul/tutorials?utm_source=docs/datacenter-deploy/deployment-guide) for important information, regardless of the deployment platform.
|
Refer to the standard [production deployment guide](https://learn.hashicorp.com/consul/datacenter-deploy/deployment-guide) for important information, regardless of the deployment platform.
|
||||||
|
|
||||||
## Server Agents
|
## Server Agents
|
||||||
|
|
||||||
|
|
|
@ -178,7 +178,7 @@ $ kubectl apply --filename service-intentions.yaml
|
||||||
serviceintentions.consul.hashicorp.com/ingress-gateway created
|
serviceintentions.consul.hashicorp.com/ingress-gateway created
|
||||||
```
|
```
|
||||||
|
|
||||||
For detailed instructions on how to configure zero-trust networking with intentions please refer to this [guide](/consul/tutorials/service-mesh-security/service-mesh-zero-trust-network?utm_source=docs).
|
For detailed instructions on how to configure zero-trust networking with intentions please refer to this [guide](https://learn.hashicorp.com/tutorials/consul/service-mesh-zero-trust-network?utm_source=docs).
|
||||||
|
|
||||||
## Deploying your application to Kubernetes
|
## Deploying your application to Kubernetes
|
||||||
|
|
||||||
|
|
|
@ -137,7 +137,7 @@ The Prometheus deployment is designed to allow quick bootstrapping for trial and
|
||||||
Prometheus will be installed in the same namespace as Consul, and will be installed
|
Prometheus will be installed in the same namespace as Consul, and will be installed
|
||||||
and uninstalled along with the Consul installation.
|
and uninstalled along with the Consul installation.
|
||||||
|
|
||||||
Grafana can optionally be utilized with Prometheus to display metrics. The installation and configuration of Grafana must be managed separately from the Consul Helm chart. The [Layer 7 Observability with Prometheus, Grafana, and Kubernetes](/consul/tutorials/service-mesh-observability/kubernetes-layer7-observability?utm_source=docs?in=consul/kubernetes)) tutorial provides an installation walkthrough using Helm.
|
Grafana can optionally be utilized with Prometheus to display metrics. The installation and configuration of Grafana must be managed separately from the Consul Helm chart. The [Layer 7 Observability with Prometheus, Grafana, and Kubernetes](https://learn.hashicorp.com/tutorials/consul/kubernetes-layer7-observability?in=consul/kubernetes?in=consul/kubernetes)) tutorial provides an installation walkthrough using Helm.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prometheus:
|
prometheus:
|
||||||
|
|
|
@ -360,7 +360,7 @@ Use these links to navigate to a particular top-level stanza.
|
||||||
See https://www.consul.io/docs/agent/config/cli-flags#_recursor for more details.
|
See https://www.consul.io/docs/agent/config/cli-flags#_recursor for more details.
|
||||||
If this is an empty array (the default), then Consul DNS will only resolve queries for the Consul top level domain (by default `.consul`).
|
If this is an empty array (the default), then Consul DNS will only resolve queries for the Consul top level domain (by default `.consul`).
|
||||||
|
|
||||||
- `tls` ((#v-global-tls)) - Enables TLS (/consul/tutorials/security/tls-encryption-secure?utm_source=docs)
|
- `tls` ((#v-global-tls)) - Enables TLS (https://learn.hashicorp.com/tutorials/consul/tls-encryption-secure?utm_source=docs)
|
||||||
across the cluster to verify authenticity of the Consul servers and clients.
|
across the cluster to verify authenticity of the Consul servers and clients.
|
||||||
Requires Consul v1.4.1+.
|
Requires Consul v1.4.1+.
|
||||||
|
|
||||||
|
@ -621,7 +621,7 @@ Use these links to navigate to a particular top-level stanza.
|
||||||
Vault Secrets backend:
|
Vault Secrets backend:
|
||||||
If you are using Vault as a secrets backend, a Vault Policy must be created which allows `["create", "update"]`
|
If you are using Vault as a secrets backend, a Vault Policy must be created which allows `["create", "update"]`
|
||||||
capabilities on the PKI issuing endpoint, which is usually of the form `pki/issue/consul-server`.
|
capabilities on the PKI issuing endpoint, which is usually of the form `pki/issue/consul-server`.
|
||||||
Please refer the [Consul and Vault tutorial](/consul/tutorials/vault-secure/vault-pki-consul-secure-tls?utm_source=docs) for steps to generate a compatible certificate.
|
Please refer the [Consul and Vault tutorial](https://learn.hashicorp.com/tutorials/consul/vault-pki-consul-secure-tls?utm_source=docs) for steps to generate a compatible certificate.
|
||||||
Note: when using TLS, both the `server.serverCert` and `global.tls.caCert` which points to the CA endpoint of this PKI engine
|
Note: when using TLS, both the `server.serverCert` and `global.tls.caCert` which points to the CA endpoint of this PKI engine
|
||||||
must be provided.
|
must be provided.
|
||||||
|
|
||||||
|
|
|
@ -40,33 +40,33 @@ There are several ways to try Consul with Kubernetes in different environments.
|
||||||
|
|
||||||
**Tutorials**
|
**Tutorials**
|
||||||
|
|
||||||
- The [Getting Started with Consul Service Mesh track](/consul/tutorials/gs-consul-service-mesh/service-mesh-deploy?utm_source=docs)
|
- The [Getting Started with Consul Service Mesh track](https://learn.hashicorp.com/tutorials/consul/service-mesh-deploy?in=consul/gs-consul-service-mesh?utm_source=docs)
|
||||||
provides guidance for installing Consul as service mesh for Kubernetes using the Helm
|
provides guidance for installing Consul as service mesh for Kubernetes using the Helm
|
||||||
chart, deploying services in the service mesh, and using intentions to secure service
|
chart, deploying services in the service mesh, and using intentions to secure service
|
||||||
communications.
|
communications.
|
||||||
|
|
||||||
- The [Migrate to Microservices with Consul Service Mesh on Kubernetes](/consul/tutorials/microservices?utm_source=docs)
|
- The [Migrate to Microservices with Consul Service Mesh on Kubernetes](https://learn.hashicorp.com/collections/consul/microservices?utm_source=docs)
|
||||||
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
||||||
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
||||||
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
||||||
of your microservices journey.
|
of your microservices journey.
|
||||||
|
|
||||||
- The [Consul and Minikube guide](/consul/tutorials/kubernetes/kubernetes-minikube?utm_source=docs) is a quick step-by-step guide for deploying Consul with the official Helm chart on a local instance of Minikube.
|
- The [Consul and Minikube guide](https://learn.hashicorp.com/tutorials/consul/kubernetes-minikube?utm_source=docs) is a quick step-by-step guide for deploying Consul with the official Helm chart on a local instance of Minikube.
|
||||||
|
|
||||||
- Review production best practices and cloud-specific configurations for deploying Consul on managed Kubernetes runtimes.
|
- Review production best practices and cloud-specific configurations for deploying Consul on managed Kubernetes runtimes.
|
||||||
|
|
||||||
- The [Consul on Azure Kubernetes Service (AKS) tutorial](/consul/tutorials/kubernetes/kubernetes-aks-azure?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on AKS. The guide also allows you to practice deploying two microservices.
|
- The [Consul on Azure Kubernetes Service (AKS) tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-aks-azure?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on AKS. The guide also allows you to practice deploying two microservices.
|
||||||
- The [Consul on Amazon Elastic Kubernetes Service (EKS) tutorial](/consul/tutorials/kubernetes/kubernetes-eks-aws?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on EKS. Additionally, it provides guidance on interacting with your datacenter with the Consul UI, CLI, and API.
|
- The [Consul on Amazon Elastic Kubernetes Service (EKS) tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-eks-aws?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on EKS. Additionally, it provides guidance on interacting with your datacenter with the Consul UI, CLI, and API.
|
||||||
- The [Consul on Google Kubernetes Engine (GKE) tutorial](/consul/tutorials/kubernetes/kubernetes-gke-google?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on GKE. Additionally, it provides guidance on interacting with your datacenter with the Consul UI, CLI, and API.
|
- The [Consul on Google Kubernetes Engine (GKE) tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-gke-google?utm_source=docs) is a complete step-by-step guide on how to deploy Consul on GKE. Additionally, it provides guidance on interacting with your datacenter with the Consul UI, CLI, and API.
|
||||||
|
|
||||||
- The [Consul and Kubernetes Reference Architecture](/consul/tutorials/kubernetes/kubernetes-reference-architecture?utm_source=docs) guide provides recommended practices for production.
|
- The [Consul and Kubernetes Reference Architecture](https://learn.hashicorp.com/tutorials/consul/kubernetes-reference-architecture?utm_source=docs) guide provides recommended practices for production.
|
||||||
|
|
||||||
- The [Consul and Kubernetes Deployment](/consul/tutorials/kubernetes/kubernetes-deployment-guide?utm_source=docs) tutorial covers the necessary steps to install and configure a new Consul cluster on Kubernetes in production.
|
- The [Consul and Kubernetes Deployment](https://learn.hashicorp.com/tutorials/consul/kubernetes-deployment-guide?utm_source=docs) tutorial covers the necessary steps to install and configure a new Consul cluster on Kubernetes in production.
|
||||||
|
|
||||||
- The [Secure Consul and Registered Services on Kubernetes](/consul/tutorials/kubernetes/kubernetes-secure-agents?utm_source=docs) tutorial covers
|
- The [Secure Consul and Registered Services on Kubernetes](https://learn.hashicorp.com/tutorials/consul/kubernetes-secure-agents?utm_source=docs) tutorial covers
|
||||||
the necessary steps to secure a Consul cluster running on Kubernetes in production.
|
the necessary steps to secure a Consul cluster running on Kubernetes in production.
|
||||||
|
|
||||||
- The [Layer 7 Observability with Consul Service Mesh](/consul/tutorials/service-mesh-observability/kubernetes-layer7-observability?utm_source=docs) tutorial covers monitoring a
|
- The [Layer 7 Observability with Consul Service Mesh](https://learn.hashicorp.com/tutorials/consul/kubernetes-layer7-observability?in=consul/kubernetes) tutorial covers monitoring a
|
||||||
Consul service mesh running on Kubernetes with Prometheus and Grafana.
|
Consul service mesh running on Kubernetes with Prometheus and Grafana.
|
||||||
|
|
||||||
**Documentation**
|
**Documentation**
|
||||||
|
|
|
@ -23,7 +23,7 @@ You can install Consul on Kubernetes using the following methods:
|
||||||
Refer to the [architecture](/docs/k8s/installation/install#architecture) section to learn more about the general architecture of Consul on Kubernetes.
|
Refer to the [architecture](/docs/k8s/installation/install#architecture) section to learn more about the general architecture of Consul on Kubernetes.
|
||||||
For a hands-on experience with Consul as a service mesh
|
For a hands-on experience with Consul as a service mesh
|
||||||
for Kubernetes, follow the [Getting Started with Consul service
|
for Kubernetes, follow the [Getting Started with Consul service
|
||||||
mesh](/consul/tutorials/gs-consul-service-mesh/service-mesh-deploy?utm_source=docs) tutorial.
|
mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh-deploy?in=consul/gs-consul-service-mesh?utm_source=docs) tutorial.
|
||||||
|
|
||||||
## Consul K8s CLI Installation
|
## Consul K8s CLI Installation
|
||||||
|
|
||||||
|
@ -103,7 +103,7 @@ The [Homebrew](https://brew.sh) package manager is required to complete the foll
|
||||||
We recommend using the Consul Helm chart to install Consul on Kubernetes for multi-cluster installations that involve cross-partition of cross datacenter communication. The Helm chart installs and configures all necessary components to run Consul. The configuration enables you to run a server cluster, a client cluster, or both.
|
We recommend using the Consul Helm chart to install Consul on Kubernetes for multi-cluster installations that involve cross-partition of cross datacenter communication. The Helm chart installs and configures all necessary components to run Consul. The configuration enables you to run a server cluster, a client cluster, or both.
|
||||||
|
|
||||||
Step-by-step tutorials for how to deploy Consul to Kubernetes, please see
|
Step-by-step tutorials for how to deploy Consul to Kubernetes, please see
|
||||||
our [Deploy to Kubernetes](/consul/tutorials/kubernetes-deploy?utm_source=docs)
|
our [Deploy to Kubernetes](https://learn.hashicorp.com/collections/consul/kubernetes-deploy)
|
||||||
collection. This collection includes configuration caveats for single-node deployments.
|
collection. This collection includes configuration caveats for single-node deployments.
|
||||||
|
|
||||||
The Helm chart exposes several useful configurations and automatically
|
The Helm chart exposes several useful configurations and automatically
|
||||||
|
@ -380,7 +380,7 @@ spec:
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
If you are still considering a move to Kubernetes, or to Consul on Kubernetes specifically, our [Migrate to Microservices with Consul Service Mesh on Kubernetes](/consul/tutorials/microservices?utm_source=docs)
|
If you are still considering a move to Kubernetes, or to Consul on Kubernetes specifically, our [Migrate to Microservices with Consul Service Mesh on Kubernetes](https://learn.hashicorp.com/collections/consul/microservices?utm_source=docs)
|
||||||
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
||||||
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
||||||
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
||||||
|
|
|
@ -11,7 +11,7 @@ description: >-
|
||||||
|
|
||||||
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters) and [WAN Federation Via Mesh Gateways](/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways).
|
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters) and [WAN Federation Via Mesh Gateways](/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways).
|
||||||
|
|
||||||
-> Looking for a step-by-step guide? Complete the [Secure and Route Service Mesh Communication Across Kubernetes](/consul/tutorials/kubernetes/kubernetes-mesh-gateways?utm_source=docs) tutorial to learn more.
|
-> Looking for a step-by-step guide? Complete the [Secure and Route Service Mesh Communication Across Kubernetes](https://learn.hashicorp.com/tutorials/consul/kubernetes-mesh-gateways?utm_source=docs) tutorial to learn more.
|
||||||
|
|
||||||
This page describes how to federate multiple Kubernetes clusters. See [Multi-Cluster Overview](/docs/k8s/installation/multi-cluster)
|
This page describes how to federate multiple Kubernetes clusters. See [Multi-Cluster Overview](/docs/k8s/installation/multi-cluster)
|
||||||
for more information on use-cases and how it works.
|
for more information on use-cases and how it works.
|
||||||
|
@ -465,12 +465,12 @@ in the top left:
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
With your Kubernetes clusters federated, complete the [Secure and Route Service Mesh Communication Across Kubernetes](/consul/tutorials/kubernetes/kubernetes-mesh-gateways?utm_source=docs#deploy-microservices) tutorial to learn how to use Consul service mesh to
|
With your Kubernetes clusters federated, complete the [Secure and Route Service Mesh Communication Across Kubernetes](https://learn.hashicorp.com/tutorials/consul/kubernetes-mesh-gateways?utm_source=docs#deploy-microservices) tutorial to learn how to use Consul service mesh to
|
||||||
route between services deployed on each cluster.
|
route between services deployed on each cluster.
|
||||||
|
|
||||||
You can also read our in-depth documentation on [Consul Service Mesh In Kubernetes](/docs/k8s/connect).
|
You can also read our in-depth documentation on [Consul Service Mesh In Kubernetes](/docs/k8s/connect).
|
||||||
|
|
||||||
If you are still considering a move to Kubernetes, or to Consul on Kubernetes specifically, our [Migrate to Microservices with Consul Service Mesh on Kubernetes](/consul/tutorials/microservices?utm_source=docs)
|
If you are still considering a move to Kubernetes, or to Consul on Kubernetes specifically, our [Migrate to Microservices with Consul Service Mesh on Kubernetes](https://learn.hashicorp.com/collections/consul/microservices?utm_source=docs)
|
||||||
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
collection uses an example application written by a fictional company to illustrate why and how organizations can
|
||||||
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
migrate from monolith to microservices using Consul service mesh on Kubernetes. The case study in this collection
|
||||||
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
should provide information valuable for understanding how to develop services that leverage Consul during any stage
|
||||||
|
|
|
@ -144,7 +144,7 @@ acls {
|
||||||
```
|
```
|
||||||
|
|
||||||
-> **NOTE:** You'll also need to set up additional ACL tokens as needed by the
|
-> **NOTE:** You'll also need to set up additional ACL tokens as needed by the
|
||||||
ACL system. See tutorial [Secure Consul with Access Control Lists (ACLs)](/consul/tutorials/security/access-control-setup-production?utm_source=docs#apply-individual-tokens-to-agents)
|
ACL system. See tutorial [Secure Consul with Access Control Lists (ACLs)](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production#apply-individual-tokens-to-agents)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
### Gossip Encryption Key
|
### Gossip Encryption Key
|
||||||
|
|
|
@ -93,7 +93,7 @@ for both in-cluster and out-of-cluster authentication. If `kubectl` works,
|
||||||
then the sync program should work.
|
then the sync program should work.
|
||||||
|
|
||||||
For Consul, if ACLs are configured on the cluster, a Consul
|
For Consul, if ACLs are configured on the cluster, a Consul
|
||||||
[ACL token](/consul/tutorials/security/access-control-setup-production?utm_source=docs)
|
[ACL token](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production)
|
||||||
will need to be provided. Review the [ACL rules](/docs/security/acl/acl-rules)
|
will need to be provided. Review the [ACL rules](/docs/security/acl/acl-rules)
|
||||||
when creating this token so that it only allows the necessary privileges. The catalog
|
when creating this token so that it only allows the necessary privileges. The catalog
|
||||||
sync process accepts this token by using the [`CONSUL_HTTP_TOKEN`](/commands#consul_http_token)
|
sync process accepts this token by using the [`CONSUL_HTTP_TOKEN`](/commands#consul_http_token)
|
||||||
|
|
|
@ -64,7 +64,7 @@ If you intend to invoke Lambda services through a terminating gateway, the gatew
|
||||||
|
|
||||||
* [Terminating gateways documentation](/docs/connect/gateways#terminating-gateways)
|
* [Terminating gateways documentation](/docs/connect/gateways#terminating-gateways)
|
||||||
* [Terminating gateways on Kubernetes documentation](/docs/k8s/connect/terminating-gateways)
|
* [Terminating gateways on Kubernetes documentation](/docs/k8s/connect/terminating-gateways)
|
||||||
* [Connect External Services to Consul With Terminating Gateways tutorial](/consul/tutorials/developer-mesh/terminating-gateways-connect-external-services?utm_source=docs)
|
* [Connect External Services to Consul With Terminating Gateways tutorial](https://learn.hashicorp.com/tutorials/consul/teminating-gateways-connect-external-services)
|
||||||
|
|
||||||
To register a Lambda service with a terminating gateway, add the service to the
|
To register a Lambda service with a terminating gateway, add the service to the
|
||||||
`Services` field of the terminating gateway's `terminating-gateway`
|
`Services` field of the terminating gateway's `terminating-gateway`
|
||||||
|
@ -75,8 +75,8 @@ configuration entry.
|
||||||
You can set up a mesh gateway so that you can invoke Lambda services across datacenters and admin partitions. The mesh gateway must be running and registered in the relevant Consul datacenters and partitions. Refer to the following documentation and tutorials for instructions on how to set up mesh gateways:
|
You can set up a mesh gateway so that you can invoke Lambda services across datacenters and admin partitions. The mesh gateway must be running and registered in the relevant Consul datacenters and partitions. Refer to the following documentation and tutorials for instructions on how to set up mesh gateways:
|
||||||
|
|
||||||
* [Mesh gateway documentation](/docs/connect/gateways#mesh-gateways)
|
* [Mesh gateway documentation](/docs/connect/gateways#mesh-gateways)
|
||||||
* [Connect Services Across Datacenters with Mesh Gateways tutorial](/consul/tutorials/developer-mesh/service-mesh-gateways?utm_source=docs)
|
* [Connect Services Across Datacenters with Mesh Gateways tutorial](https://learn.hashicorp.com/tutorials/consul/service-mesh-gateways)
|
||||||
* [Secure Service Mesh Communication Across Kubernetes Clusters tutorial](/consul/tutorials/kubernetes/kubernetes-mesh-gateways?utm_source=docs?in=consul/kubernetes)
|
* [Secure Service Mesh Communication Across Kubernetes Clusters tutorial](https://learn.hashicorp.com/tutorials/consul/kubernetes-mesh-gateways?utm_source=docs?in=consul/kubernetes)
|
||||||
|
|
||||||
When using admin partitions, you must add Lambda services to the `Services`
|
When using admin partitions, you must add Lambda services to the `Services`
|
||||||
field of [the `exported-services` configuration
|
field of [the `exported-services` configuration
|
||||||
|
|
|
@ -55,6 +55,6 @@ Each driver includes a set of providers that [enables support](/docs/nia/terrafo
|
||||||
|
|
||||||
## Security Guidelines
|
## Security Guidelines
|
||||||
|
|
||||||
The [Secure Consul-Terraform-Sync for Production](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-secure?utm_source=docs)
|
The [Secure Consul-Terraform-Sync for Production](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-secure?utm_source=docs)
|
||||||
tutorial contains a checklist of best practices to secure your
|
tutorial contains a checklist of best practices to secure your
|
||||||
CTS installation for a production environment.
|
CTS installation for a production environment.
|
||||||
|
|
|
@ -128,7 +128,7 @@ consul {
|
||||||
| `service_registration` | Optional| [service_registration](/docs/nia/configuration#service-registration) | Options for how CTS will register itself as a service with a health check to Consul. ||
|
| `service_registration` | Optional| [service_registration](/docs/nia/configuration#service-registration) | Options for how CTS will register itself as a service with a health check to Consul. ||
|
||||||
|
|
||||||
##### ACL Requirements
|
##### ACL Requirements
|
||||||
The following table describes the ACL policies required by CTS. For more information, refer to the [Secure Consul-Terraform-Sync for Production](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-secure?utm_source=docs#configure-acl-privileges-for-consul-terraform-sync) tutorial.
|
The following table describes the ACL policies required by CTS. For more information, refer to the [Secure Consul-Terraform-Sync for Production](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-secure?utm_source=docs#configure-acl-privileges-for-consul-terraform-sync) tutorial.
|
||||||
|
|
||||||
| Policy | Resources |
|
| Policy | Resources |
|
||||||
| ------ | --------- |
|
| ------ | --------- |
|
||||||
|
@ -622,7 +622,7 @@ driver "terraform" {
|
||||||
|
|
||||||
- `backend` - (obj) The backend stores [Terraform state files](https://www.terraform.io/docs/state/index.html) for each task. This option is similar to the [Terraform backend configuration](https://www.terraform.io/docs/configuration/backend.html). CTS supports Terraform backends used as a state store.
|
- `backend` - (obj) The backend stores [Terraform state files](https://www.terraform.io/docs/state/index.html) for each task. This option is similar to the [Terraform backend configuration](https://www.terraform.io/docs/configuration/backend.html). CTS supports Terraform backends used as a state store.
|
||||||
- Supported backend options: [azurerm](https://www.terraform.io/docs/backends/types/azurerm.html), [consul](https://www.terraform.io/docs/backends/types/consul.html), [cos](https://www.terraform.io/docs/backends/types/cos.html), [gcs](https://www.terraform.io/docs/backends/types/gcs.html), [kubernetes](https://www.terraform.io/docs/backends/types/kubernetes.html), [local](https://www.terraform.io/docs/backends/types/local.html), [manta](https://www.terraform.io/docs/backends/types/manta.html), [pg](https://www.terraform.io/docs/backends/types/pg.html) (Terraform v0.14+), [s3](https://www.terraform.io/docs/backends/types/s3.html). Visit the Terraform documentation links for details on backend configuration options.
|
- Supported backend options: [azurerm](https://www.terraform.io/docs/backends/types/azurerm.html), [consul](https://www.terraform.io/docs/backends/types/consul.html), [cos](https://www.terraform.io/docs/backends/types/cos.html), [gcs](https://www.terraform.io/docs/backends/types/gcs.html), [kubernetes](https://www.terraform.io/docs/backends/types/kubernetes.html), [local](https://www.terraform.io/docs/backends/types/local.html), [manta](https://www.terraform.io/docs/backends/types/manta.html), [pg](https://www.terraform.io/docs/backends/types/pg.html) (Terraform v0.14+), [s3](https://www.terraform.io/docs/backends/types/s3.html). Visit the Terraform documentation links for details on backend configuration options.
|
||||||
- If omitted, CTS will generate default values and use configurations from the [`consul` block](#consul) to configure [Consul as the backend](https://www.terraform.io/docs/backends/types/consul.html), which stores Terraform statefiles in the Consul KV. The [ACL token provided for Consul authentication](#consul) is used to read and write to the KV store and requires [Consul KV privileges](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-secure?utm_source=docs#configure-acl-privileges-for-consul-terraform-sync). The Consul KV path is the base path to store state files for tasks. The full path of each state file will have the task identifier appended to the end of the path, e.g. `consul-terraform-sync/terraform-env:task-name`.
|
- If omitted, CTS will generate default values and use configurations from the [`consul` block](#consul) to configure [Consul as the backend](https://www.terraform.io/docs/backends/types/consul.html), which stores Terraform statefiles in the Consul KV. The [ACL token provided for Consul authentication](#consul) is used to read and write to the KV store and requires [Consul KV privileges](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-secure?utm_source=docs#configure-acl-privileges-for-consul-terraform-sync). The Consul KV path is the base path to store state files for tasks. The full path of each state file will have the task identifier appended to the end of the path, e.g. `consul-terraform-sync/terraform-env:task-name`.
|
||||||
- The remote enhanced backend is not supported with the Terraform driver to run operations in Terraform Cloud. Use the [Terraform Cloud driver](#terraform-cloud-driver) to integrate CTS with Terraform Cloud for remote workspaces and remote operations.
|
- The remote enhanced backend is not supported with the Terraform driver to run operations in Terraform Cloud. Use the [Terraform Cloud driver](#terraform-cloud-driver) to integrate CTS with Terraform Cloud for remote workspaces and remote operations.
|
||||||
- `log` - (bool) Enable all Terraform output (stderr and stdout) to be included in the CTS log. This is useful for debugging and development purposes. It may be difficult to work with log aggregators that expect uniform log format.
|
- `log` - (bool) Enable all Terraform output (stderr and stdout) to be included in the CTS log. This is useful for debugging and development purposes. It may be difficult to work with log aggregators that expect uniform log format.
|
||||||
- `path` - (string) The file path to install Terraform or discover an existing Terraform binary. If omitted, Terraform will be installed in the same directory as the CTS daemon. To resolve an incompatible Terraform version or to change versions will require removing the existing binary or change to a different path.
|
- `path` - (string) The file path to install Terraform or discover an existing Terraform binary. If omitted, Terraform will be installed in the same directory as the CTS daemon. To resolve an incompatible Terraform version or to change versions will require removing the existing binary or change to a different path.
|
||||||
|
|
|
@ -53,7 +53,7 @@ If a license needs to be manually set, choose one of the following methods (in o
|
||||||
```
|
```
|
||||||
|
|
||||||
~> **Note**: the [options to set the license and the order of precedence](/docs/enterprise/license/overview#binaries-without-built-in-licenses) are the same as Consul Enterprise server agents.
|
~> **Note**: the [options to set the license and the order of precedence](/docs/enterprise/license/overview#binaries-without-built-in-licenses) are the same as Consul Enterprise server agents.
|
||||||
Visit the [Enterprise License Tutorial](/consul/tutorials/enterprise/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
Visit the [Enterprise License Tutorial](https://learn.hashicorp.com/tutorials/consul/hashicorp-enterprise-license?utm_source=docs) for detailed steps on how to install the license key.
|
||||||
|
|
||||||
### Updating the License Manually
|
### Updating the License Manually
|
||||||
To update the license when it expires or is near the expiration date and automatic license retrieval is disabled:
|
To update the license when it expires or is near the expiration date and automatic license retrieval is disabled:
|
||||||
|
|
|
@ -11,7 +11,7 @@ Network Infrastructure Automation (NIA) enables dynamic updates to network infra
|
||||||
|
|
||||||
CTS executes one or more automation tasks with the most recent service variable values from the Consul service catalog. Each task consists of a runbook automation written as a CTS compatible Terraform module using resources and data sources for the underlying network infrastructure. The `consul-terraform-sync` daemon runs on the same node as a Consul agent.
|
CTS executes one or more automation tasks with the most recent service variable values from the Consul service catalog. Each task consists of a runbook automation written as a CTS compatible Terraform module using resources and data sources for the underlying network infrastructure. The `consul-terraform-sync` daemon runs on the same node as a Consul agent.
|
||||||
|
|
||||||
CTS is available as an open source and enterprise distribution. Follow the [Network Infrastructure Automation introduction tutorial](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-intro?utm_source=docs) to get started with CTS OSS or read more about [CTS Enterprise](/docs/nia/enterprise).
|
CTS is available as an open source and enterprise distribution. Follow the [Network Infrastructure Automation introduction tutorial](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-intro?utm_source=docs) to get started with CTS OSS or read more about [CTS Enterprise](/docs/nia/enterprise).
|
||||||
|
|
||||||
## Use Cases
|
## Use Cases
|
||||||
|
|
||||||
|
@ -61,7 +61,7 @@ CTS is available as an open source and enterprise distribution. Follow the [Netw
|
||||||
|
|
||||||
## Getting Started With Network Infrastructure Automation
|
## Getting Started With Network Infrastructure Automation
|
||||||
|
|
||||||
The [Network Infrastructure Automation (NIA)](/consul/tutorials/network-infrastructure-automation?utm_source=docs)
|
The [Network Infrastructure Automation (NIA)](https://learn.hashicorp.com/collections/consul/network-infrastructure-automation?utm_source=docs)
|
||||||
collection contains examples on how to configure CTS to
|
collection contains examples on how to configure CTS to
|
||||||
perform Network Infrastructure Automation. The collection contains also a
|
perform Network Infrastructure Automation. The collection contains also a
|
||||||
tutorial to secure your CTS configuration for a production
|
tutorial to secure your CTS configuration for a production
|
||||||
|
|
|
@ -7,7 +7,7 @@ description: >-
|
||||||
|
|
||||||
# Install Consul-Terraform-Sync
|
# Install Consul-Terraform-Sync
|
||||||
|
|
||||||
Refer to the [introduction](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-intro?utm_source=docs) tutorial for details about installing, configuring, and running Consul-Terraform-Sync (CTS) on your local machine with the Terraform driver.
|
Refer to the [introduction](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-intro?utm_source=docs) tutorial for details about installing, configuring, and running Consul-Terraform-Sync (CTS) on your local machine with the Terraform driver.
|
||||||
|
|
||||||
## Install Consul-Terraform-Sync
|
## Install Consul-Terraform-Sync
|
||||||
|
|
||||||
|
|
|
@ -25,13 +25,13 @@ Below are several steps towards a minimum Consul setup required for running CTS.
|
||||||
|
|
||||||
CTS is a daemon that runs alongside Consul, similar to other Consul ecosystem tools like Consul Template. CTS is not included with the Consul binary and needs to be installed separately.
|
CTS is a daemon that runs alongside Consul, similar to other Consul ecosystem tools like Consul Template. CTS is not included with the Consul binary and needs to be installed separately.
|
||||||
|
|
||||||
To install a local Consul agent, refer to the [Getting Started: Install Consul Tutorial](/consul/tutorials/getting-started/get-started-install?utm_source=docs).
|
To install a local Consul agent, refer to the [Getting Started: Install Consul Tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=docs).
|
||||||
|
|
||||||
For information on compatible Consul versions, refer to the [Consul compatibility matrix](/docs/nia/compatibility#consul).
|
For information on compatible Consul versions, refer to the [Consul compatibility matrix](/docs/nia/compatibility#consul).
|
||||||
|
|
||||||
### Run an Agent
|
### Run an Agent
|
||||||
|
|
||||||
The Consul agent must be running in order to dynamically update network devices. To run the local Consul agent, you can run Consul in development mode which can be started with `consul agent -dev` for simplicity. For more details on running Consul agent, refer to the [Getting Started: Run the Consul Agent Tutorial](/consul/tutorials/getting-started/get-started-agent?utm_source=docs).
|
The Consul agent must be running in order to dynamically update network devices. To run the local Consul agent, you can run Consul in development mode which can be started with `consul agent -dev` for simplicity. For more details on running Consul agent, refer to the [Getting Started: Run the Consul Agent Tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-agent?in=consul/getting-started).
|
||||||
|
|
||||||
When running a Consul agent with CTS in production, we suggest to keep a few considerations in mind. CTS uses [blocking queries](/api-docs/features/blocking) to monitor task dependencies, like changes to registered services. This results in multiple long running TCP connections between CTS and the agent to poll changes for each dependency. Monitoring a high number of services may quickly hit the default Consul agent connection limits.
|
When running a Consul agent with CTS in production, we suggest to keep a few considerations in mind. CTS uses [blocking queries](/api-docs/features/blocking) to monitor task dependencies, like changes to registered services. This results in multiple long running TCP connections between CTS and the agent to poll changes for each dependency. Monitoring a high number of services may quickly hit the default Consul agent connection limits.
|
||||||
|
|
||||||
|
@ -58,13 +58,13 @@ The above example registers a service named "web" with your Consul agent. This r
|
||||||
|
|
||||||
For more details on registering a service by HTTP API request, refer to the [register service API docs](/api-docs/agent/service#register-service).
|
For more details on registering a service by HTTP API request, refer to the [register service API docs](/api-docs/agent/service#register-service).
|
||||||
|
|
||||||
For more details on registering a service by loading a service definition, refer to the [Getting Started: Register a Service with Consul Service Discovery Tutorial](/consul/tutorials/getting-started/get-started-service-discovery?utm_source=docs?in=consul/getting-started).
|
For more details on registering a service by loading a service definition, refer to the [Getting Started: Register a Service with Consul Service Discovery Tutorial](https://learn.hashicorp.com/tutorials/consul/get-started-service-discovery?in=consul/getting-started).
|
||||||
|
|
||||||
### Run a Cluster
|
### Run a Cluster
|
||||||
|
|
||||||
The previous steps of installing and running a single Consul agent then registering a single service is sufficient to meaningfully start running CTS.
|
The previous steps of installing and running a single Consul agent then registering a single service is sufficient to meaningfully start running CTS.
|
||||||
|
|
||||||
If you would like to run a Consul cluster rather than a single agent, refer to [Getting Started: Create a Local Consul Datacenter](/consul/tutorials/getting-started/get-started-create-datacenter?utm_source=docs). This will walk you through the steps of running multiple Consul agents and then joining them together into a cluster.
|
If you would like to run a Consul cluster rather than a single agent, refer to [Getting Started: Create a Local Consul Datacenter](https://learn.hashicorp.com/tutorials/consul/get-started-create-datacenter?in=consul/getting-started). This will walk you through the steps of running multiple Consul agents and then joining them together into a cluster.
|
||||||
|
|
||||||
## Network Infrastructure (using a Terraform Provider)
|
## Network Infrastructure (using a Terraform Provider)
|
||||||
|
|
||||||
|
|
|
@ -31,4 +31,4 @@ description: >-
|
||||||
|
|
||||||
CTS allows you to inspect your configuration before applying any change and to run in once mode, meaning that you can verify the changes are correctly applied in a test run before running it in unsupervised daemon mode.
|
CTS allows you to inspect your configuration before applying any change and to run in once mode, meaning that you can verify the changes are correctly applied in a test run before running it in unsupervised daemon mode.
|
||||||
|
|
||||||
To learn more on these options check the [Consul-Terraform-Sync Run Modes and Status Inspection](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-run-and-inspect?utm_source=docs) tutorial.
|
To learn more on these options check the [Consul-Terraform-Sync Run Modes and Status Inspection](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-run-and-inspect?utm_source=docs) tutorial.
|
||||||
|
|
|
@ -21,7 +21,7 @@ description: >-
|
||||||
|
|
||||||
## What's Changed
|
## What's Changed
|
||||||
|
|
||||||
- The legacy ACL system that was deprecated in Consul 1.4.0 has been removed. Before upgrading you should verify that all tokens and policies have been migrated to the newer ACL system. Complete the [Migrate Legacy ACL Tokens](/consul/tutorials/security-operations/access-control-token-migration?utm_source=docs) tutorial to learn more.
|
- The legacy ACL system that was deprecated in Consul 1.4.0 has been removed. Before upgrading you should verify that all tokens and policies have been migrated to the newer ACL system. Complete the [Migrate Legacy ACL Tokens](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens) tutorial to learn more.
|
||||||
|
|
||||||
- The `agent_master` ACL token has been renamed to `agent_recovery` ACL token. In addition, the `consul acl set-agent-token master` command has been replaced with `consul acl set-agent-token recovery`. See [ACL Agent Recovery Token](/docs/security/acl/acl-tokens#acl-agent-recovery-token) and [Consul ACL Set Agent Token](/commands/acl/set-agent-token) for more information.
|
- The `agent_master` ACL token has been renamed to `agent_recovery` ACL token. In addition, the `consul acl set-agent-token master` command has been replaced with `consul acl set-agent-token recovery`. See [ACL Agent Recovery Token](/docs/security/acl/acl-tokens#acl-agent-recovery-token) and [Consul ACL Set Agent Token](/commands/acl/set-agent-token) for more information.
|
||||||
|
|
||||||
|
|
|
@ -234,5 +234,5 @@ Note that client agents have to be restarted for ACL related configuration chang
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
After completing the above steps, a federated Consul cluster can be used with ACLs. Refer to
|
After completing the above steps, a federated Consul cluster can be used with ACLs. Refer to
|
||||||
[ACL Replication Guide](/consul/tutorials/security-operations/access-control-replication-multiple-datacenters?utm_source=docs?in=consul/security-operations)
|
[ACL Replication Guide](https://learn.hashicorp.com/tutorials/consul/access-control-replication-multiple-datacenters?in=consul/security-operations)
|
||||||
for more on this topic.
|
for more on this topic.
|
||||||
|
|
|
@ -15,7 +15,7 @@ description: >-
|
||||||
~> **Alert: Deprecation Notice**
|
~> **Alert: Deprecation Notice**
|
||||||
The ACL system described here was Consul's original ACL implementation.
|
The ACL system described here was Consul's original ACL implementation.
|
||||||
The legacy ACL system was deprecated in Consul 1.4.0 and removed in Consul 1.11.0.
|
The legacy ACL system was deprecated in Consul 1.4.0 and removed in Consul 1.11.0.
|
||||||
The documentation for the new ACL system can be found [here](/docs/security/acl). For information on how to migrate to the new ACL System, please read the [Migrate Legacy ACL Tokens](/consul/tutorials/security-operations/access-control-token-migration?utm_source=docs) tutorial.
|
The documentation for the new ACL system can be found [here](/docs/security/acl). For information on how to migrate to the new ACL System, please read the [Migrate Legacy ACL Tokens](https://learn.hashicorp.com/consul/day-2-agent-authentication/migrate-acl-tokens) tutorial.
|
||||||
|
|
||||||
The legacy documentation has two sections.
|
The legacy documentation has two sections.
|
||||||
|
|
||||||
|
|
|
@ -324,7 +324,7 @@ A policy that has been implemented must still be linked to a token before the po
|
||||||
|
|
||||||
The person responsible for administrating ACLs can use the command line or call the API endpoint to link policies to tokens. Tokens can also be generated dynamically from an external system using Consul's [auth methods](/docs/security/acl/auth-methods) functionality.
|
The person responsible for administrating ACLs can use the command line or call the API endpoint to link policies to tokens. Tokens can also be generated dynamically from an external system using Consul's [auth methods](/docs/security/acl/auth-methods) functionality.
|
||||||
|
|
||||||
Refer to the [tokens documentation](/docs/security/acl/acl-tokens), as well as the [ACL tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs#create-the-agent-token), for details about creating and linking policies to tokens.
|
Refer to the [tokens documentation](/docs/security/acl/acl-tokens), as well as the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production#create-the-agent-token), for details about creating and linking policies to tokens.
|
||||||
|
|
||||||
## Policy Attributes
|
## Policy Attributes
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,7 @@ The person responsible for administrating ACLs can use the API or CLI to create
|
||||||
Refer to the [ACL API](/api-docs/acl) and [ACL CLI](/commands/acl) documentation for instructions on how to create and link tokens. Tokens can also be created dynamically from trusted external system using an
|
Refer to the [ACL API](/api-docs/acl) and [ACL CLI](/commands/acl) documentation for instructions on how to create and link tokens. Tokens can also be created dynamically from trusted external system using an
|
||||||
[auth method](/docs/security/acl/auth-methods).
|
[auth method](/docs/security/acl/auth-methods).
|
||||||
|
|
||||||
Refer to the [Secure Consul with Access Control Lists (ACLs)](/consul/tutorials/security/access-control-setup-production?utm_source=docs?in=consul/security) tutorial for help getting started with creating tokens. The tutorial includes an interactive sandbox so that you can perform the procedures without configuring your local environment.
|
Refer to the [Secure Consul with Access Control Lists (ACLs)](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production?in=consul/security) tutorial for help getting started with creating tokens. The tutorial includes an interactive sandbox so that you can perform the procedures without configuring your local environment.
|
||||||
|
|
||||||
## Passing Tokens
|
## Passing Tokens
|
||||||
|
|
||||||
|
@ -213,7 +213,7 @@ token and links it with the built-in [global management](/docs/security/acl/acl-
|
||||||
The bearer will have have unrestricted privileges to resources and APIs.
|
The bearer will have have unrestricted privileges to resources and APIs.
|
||||||
The `SecretID` attribute will be set to the value of the configuration entry.
|
The `SecretID` attribute will be set to the value of the configuration entry.
|
||||||
|
|
||||||
See the [Bootstrapping ACLs tutorial](/consul/tutorials/security/access-control-setup-production?utm_source=docs) for guidance on bootstrapping.
|
See the [Bootstrapping ACLs tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production) for guidance on bootstrapping.
|
||||||
|
|
||||||
<!-- Consider removing this content now that we have versioned docs
|
<!-- Consider removing this content now that we have versioned docs
|
||||||
In Consul 1.4 - 1.10, this was called the `master` token. It was renamed to `initial_management` token in Consul 1.11.
|
In Consul 1.4 - 1.10, this was called the `master` token. It was renamed to `initial_management` token in Consul 1.11.
|
||||||
|
|
|
@ -13,10 +13,10 @@ Refer to the following tutorials for step-by-step instructions on how to get sta
|
||||||
|
|
||||||
- [Bootstrap and Explore ACLs]
|
- [Bootstrap and Explore ACLs]
|
||||||
- [Secure Consul with ACLs]
|
- [Secure Consul with ACLs]
|
||||||
- [Troubleshoot the ACL System](/consul/tutorials/security/access-control-troubleshoot?utm_source=docs)
|
- [Troubleshoot the ACL System](https://learn.hashicorp.com/consul/security-networking/acl-troubleshooting?utm_source=docs)
|
||||||
|
|
||||||
[bootstrap and explore acls]: /consul/tutorials/day-0/access-control-setup?utm_source=docs
|
[bootstrap and explore acls]: https://learn.hashicorp.com/tutorials/consul/access-control-setup-production?utm_source=docs
|
||||||
[secure consul with acls]: /consul/tutorials/security/access-control-setup-production?utm_source=docs
|
[secure consul with acls]: https://learn.hashicorp.com/tutorials/consul/access-control-setup-production
|
||||||
|
|
||||||
Refer to the [ACL API reference](/api-docs/acl) and [ACL CLI reference](/commands/acl) for additional usage information.
|
Refer to the [ACL API reference](/api-docs/acl) and [ACL CLI reference](/commands/acl) for additional usage information.
|
||||||
|
|
||||||
|
|
|
@ -14,8 +14,8 @@ method of encryption is described on the [encryption internals page](/docs/secur
|
||||||
There are two separate encryption systems, one for gossip traffic and one for RPC.
|
There are two separate encryption systems, one for gossip traffic and one for RPC.
|
||||||
|
|
||||||
To configure the encryption systems on a new cluster, review this following tutorials to
|
To configure the encryption systems on a new cluster, review this following tutorials to
|
||||||
[enable gossip encryption](/consul/tutorials/security/gossip-encryption-secure?utm_source=docs) and
|
[enable gossip encryption](https://learn.hashicorp.com/tutorials/consul/gossip-encryption-secure?utm_source=consul.io&utm_medium=docs) and
|
||||||
[TLS encryption for agent communication](/consul/tutorials/security/tls-encryption-secure?utm_source=docs).
|
[TLS encryption for agent communication](https://learn.hashicorp.com/tutorials/consul/tls-encryption-secure?utm_source=docs).
|
||||||
|
|
||||||
## Gossip Encryption
|
## Gossip Encryption
|
||||||
|
|
||||||
|
@ -61,7 +61,7 @@ order to send and receive cluster information.
|
||||||
## Configuring Gossip Encryption on an existing cluster
|
## Configuring Gossip Encryption on an existing cluster
|
||||||
|
|
||||||
As of version 0.8.4, Consul supports upshifting to encrypted gossip on a running cluster
|
As of version 0.8.4, Consul supports upshifting to encrypted gossip on a running cluster
|
||||||
through the following process. Review this [step-by-step tutorial](/consul/tutorials/security/gossip-encryption-secure?utm_source=docs#enable-gossip-encryption-existing-cluster)
|
through the following process. Review this [step-by-step tutorial](https://learn.hashicorp.com/tutorials/consul/gossip-encryption-secure?utm_source=consul.io&utm_medium=docs#enable-gossip-encryption-existing-cluster)
|
||||||
to encrypt gossip on an existing cluster.
|
to encrypt gossip on an existing cluster.
|
||||||
|
|
||||||
## RPC Encryption with TLS
|
## RPC Encryption with TLS
|
||||||
|
@ -70,7 +70,7 @@ Consul supports using TLS to verify the authenticity of servers and clients. To
|
||||||
Consul requires that all clients and servers have key pairs that are generated by a single
|
Consul requires that all clients and servers have key pairs that are generated by a single
|
||||||
Certificate Authority. This can be a private CA, used only internally. The
|
Certificate Authority. This can be a private CA, used only internally. The
|
||||||
CA then signs keys for each of the agents, as in
|
CA then signs keys for each of the agents, as in
|
||||||
[this tutorial on generating both a CA and signing keys](/consul/tutorials/security/tls-encryption-secure?utm_source=docs).
|
[this tutorial on generating both a CA and signing keys](https://learn.hashicorp.com/tutorials/consul/tls-encryption-secure?utm_source=docs).
|
||||||
|
|
||||||
~> Certificates need to be created with x509v3 extendedKeyUsage attributes for both clientAuth and serverAuth since Consul uses a single cert/key pair for both server and client communications.
|
~> Certificates need to be created with x509v3 extendedKeyUsage attributes for both clientAuth and serverAuth since Consul uses a single cert/key pair for both server and client communications.
|
||||||
|
|
||||||
|
@ -108,6 +108,6 @@ and is secured using a symmetric key. See above for enabling gossip encryption.
|
||||||
As of version 0.8.4, Consul supports migrating to TLS-encrypted traffic on a running cluster
|
As of version 0.8.4, Consul supports migrating to TLS-encrypted traffic on a running cluster
|
||||||
without downtime. This process assumes a starting point with no TLS settings configured and involves
|
without downtime. This process assumes a starting point with no TLS settings configured and involves
|
||||||
an intermediate step in order to get to full TLS encryption. Review the
|
an intermediate step in order to get to full TLS encryption. Review the
|
||||||
[Securing RPC Communication with TLS Encryption tutorial](/consul/tutorials/security/tls-encryption-secure?utm_source=docs)
|
[Securing RPC Communication with TLS Encryption tutorial](https://learn.hashicorp.com/tutorials/consul/tls-encryption-secure?utm_source=docs)
|
||||||
for the step-by-step process to configure TLS on a new or existing cluster. Note the call outs there
|
for the step-by-step process to configure TLS on a new or existing cluster. Note the call outs there
|
||||||
for existing cluster configuration.
|
for existing cluster configuration.
|
||||||
|
|
|
@ -185,7 +185,7 @@ environment and adapt these configurations accordingly.
|
||||||
enable multi-tenant environments. Consul OSS clusters always operate within the “default” namespace.
|
enable multi-tenant environments. Consul OSS clusters always operate within the “default” namespace.
|
||||||
|
|
||||||
- **Gossip Encryption** - A shared, base64-encoded 32-byte symmetric key is required to [encrypt Serf gossip
|
- **Gossip Encryption** - A shared, base64-encoded 32-byte symmetric key is required to [encrypt Serf gossip
|
||||||
communication](/consul/tutorials/security/gossip-encryption-secure?utm_source=docs) within a cluster using
|
communication](https://learn.hashicorp.com/tutorials/consul/gossip-encryption-secure?utm_source=consul.io&utm_medium=docs) within a cluster using
|
||||||
AES GCM. The key size determines which AES encryption types to use; 16, 24, or 32 bytes to select AES-128, AES-192,
|
AES GCM. The key size determines which AES encryption types to use; 16, 24, or 32 bytes to select AES-128, AES-192,
|
||||||
or AES-256 respectively. 32-byte keys are ultimately preferable and is the default size generated by the
|
or AES-256 respectively. 32-byte keys are ultimately preferable and is the default size generated by the
|
||||||
[`keygen`](/commands/keygen) command. This key should be
|
[`keygen`](/commands/keygen) command. This key should be
|
||||||
|
@ -289,18 +289,18 @@ environment and adapt these configurations accordingly.
|
||||||
|
|
||||||
- **mTLS** - Enabling the HTTPS with mutual TLS authentication is recommended, but requires extra tooling to terminate
|
- **mTLS** - Enabling the HTTPS with mutual TLS authentication is recommended, but requires extra tooling to terminate
|
||||||
the mTLS connection, preferably on an operator's local machine using a proxy script. To do this, follow the tutorial on
|
the mTLS connection, preferably on an operator's local machine using a proxy script. To do this, follow the tutorial on
|
||||||
[Configuring the Consul UI for HTTPS](/consul/tutorials/security-operations/tls-encryption-openssl-secure?utm_source=docs#configure-the-consul-ui-for-https)
|
[Configuring the Consul UI for HTTPS](https://learn.hashicorp.com/tutorials/consul/tls-encryption-openssl-secure#configure-the-consul-ui-for-https)
|
||||||
and in Step 2 use "Option 1: add a client certificate to your browser".
|
and in Step 2 use "Option 1: add a client certificate to your browser".
|
||||||
|
|
||||||
- **TLS** - Enabling the HTTPS is recommended where mTLS may not be required for UI access, such as when ACLs are
|
- **TLS** - Enabling the HTTPS is recommended where mTLS may not be required for UI access, such as when ACLs are
|
||||||
configured with a default deny. To do this, follow the tutorial on
|
configured with a default deny. To do this, follow the tutorial on
|
||||||
[Configuring the Consul UI for HTTPS](/consul/tutorials/security-operations/tls-encryption-openssl-secure?utm_source=docs#configure-the-consul-ui-for-https)
|
[Configuring the Consul UI for HTTPS](https://learn.hashicorp.com/tutorials/consul/tls-encryption-openssl-secure#configure-the-consul-ui-for-https)
|
||||||
and in Step 2 use "Option 2: verify_incoming_rpc".
|
and in Step 2 use "Option 2: verify_incoming_rpc".
|
||||||
|
|
||||||
- **ACL** - ACLs with a default deny policy enables safer UI access by preventing unauthorized access to sensitive
|
- **ACL** - ACLs with a default deny policy enables safer UI access by preventing unauthorized access to sensitive
|
||||||
components within the cluster. To do this, follow the tutorial on
|
components within the cluster. To do this, follow the tutorial on
|
||||||
[Securing Consul with Access Control Lists (ACLs)](/consul/tutorials/security/access-control-setup-production?utm_source=docs),
|
[Securing Consul with Access Control Lists (ACLs)](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production),
|
||||||
which includes a section on [creating ACL tokens that provide a desired level UI access](/consul/tutorials/security/access-control-setup-production?utm_source=docs#consul-ui-token).
|
which includes a section on [creating ACL tokens that provide a desired level UI access](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production#consul-ui-token).
|
||||||
|
|
||||||
- **Restrict HTTP Writes** - Using the [`allow_write_http_from`](/docs/agent/config/config-files#allow_write_http_from)
|
- **Restrict HTTP Writes** - Using the [`allow_write_http_from`](/docs/agent/config/config-files#allow_write_http_from)
|
||||||
configuration option to restrict write access for agent endpoints to hosts on the specified list of CIDRs.
|
configuration option to restrict write access for agent endpoints to hosts on the specified list of CIDRs.
|
||||||
|
|
|
@ -9,7 +9,7 @@ description: >-
|
||||||
|
|
||||||
Network Infrastructure Automation (NIA) enables dynamic updates to network infrastructure devices triggered by service changes using the [Consul Terraform Sync](https://github.com/hashicorp/consul-terraform-sync) (`consul-terraform-sync`) daemon. This daemon uses Consul's catalog to monitor networking information about services along with [Terraform](https://www.terraform.io/)'s provider ecosystem to apply relevant changes to network infrastructure.
|
Network Infrastructure Automation (NIA) enables dynamic updates to network infrastructure devices triggered by service changes using the [Consul Terraform Sync](https://github.com/hashicorp/consul-terraform-sync) (`consul-terraform-sync`) daemon. This daemon uses Consul's catalog to monitor networking information about services along with [Terraform](https://www.terraform.io/)'s provider ecosystem to apply relevant changes to network infrastructure.
|
||||||
|
|
||||||
The [Secure Consul-Terraform-Sync for Production](/consul/tutorials/network-infrastructure-automation/consul-terraform-sync-secure?utm_source=docs)
|
The [Secure Consul-Terraform-Sync for Production](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-secure?utm_source=docs)
|
||||||
tutorial contains a checklist of best practices to secure your
|
tutorial contains a checklist of best practices to secure your
|
||||||
Consul-Terraform-Sync installation for a production environment.
|
Consul-Terraform-Sync installation for a production environment.
|
||||||
|
|
||||||
|
|
|
@ -197,15 +197,15 @@ as doing so gives the Consul client unnecessary access to all network traffic on
|
||||||
We recommend raising an issue with the CNI you're using to add support for `hostPort`
|
We recommend raising an issue with the CNI you're using to add support for `hostPort`
|
||||||
and switching back to `hostPort` eventually.
|
and switching back to `hostPort` eventually.
|
||||||
|
|
||||||
[troubleshooting]: /consul/tutorials?utm_source=docs/day-2-operations/advanced-operations/troubleshooting
|
[troubleshooting]: https://learn.hashicorp.com/consul/day-2-operations/advanced-operations/troubleshooting
|
||||||
[node_name]: /docs/agent/config/config-files#node_name
|
[node_name]: /docs/agent/config/config-files#node_name
|
||||||
[retry_join]: /docs/agent/config/cli-flags#retry-join
|
[retry_join]: /docs/agent/config/cli-flags#retry-join
|
||||||
[license]: /commands/license
|
[license]: /commands/license
|
||||||
[releases]: https://releases.hashicorp.com/consul/
|
[releases]: https://releases.hashicorp.com/consul/
|
||||||
[files]: https://easyengine.io/tutorials/linux/increase-open-files-limit
|
[files]: https://easyengine.io/tutorials/linux/increase-open-files-limit
|
||||||
[certificates]: /consul/tutorials?utm_source=docs/advanced/day-1-operations/certificates
|
[certificates]: https://learn.hashicorp.com/consul/advanced/day-1-operations/certificates
|
||||||
[systemd]: /consul/tutorials?utm_source=docs/advanced/day-1-operations/deployment-guide#configure-systemd
|
[systemd]: https://learn.hashicorp.com/consul/advanced/day-1-operations/deployment-guide#configure-systemd
|
||||||
[monitoring]: /consul/tutorials?utm_source=docs/advanced/day-1-operations/monitoring
|
[monitoring]: https://learn.hashicorp.com/consul/advanced/day-1-operations/monitoring
|
||||||
[bind]: /docs/agent/config/cli-flags#_bind
|
[bind]: /docs/agent/config/cli-flags#_bind
|
||||||
[jq]: https://stedolan.github.io/jq/
|
[jq]: https://stedolan.github.io/jq/
|
||||||
[go-sockaddr]: https://godoc.org/github.com/hashicorp/go-sockaddr/template
|
[go-sockaddr]: https://godoc.org/github.com/hashicorp/go-sockaddr/template
|
||||||
|
|
|
@ -18,7 +18,7 @@ It is always safer to spin up a new Kubernetes cluster but that is not an
|
||||||
option for most teams. Consul supports [upgrading in place](/docs/k8s/upgrade).
|
option for most teams. Consul supports [upgrading in place](/docs/k8s/upgrade).
|
||||||
|
|
||||||
Non-production environments should be upgraded first. If upgrading
|
Non-production environments should be upgraded first. If upgrading
|
||||||
a Consul version, Consul data should be [backed up](/consul/tutorials/kubernetes-production/kubernetes-disaster-recovery?utm_source=docs).
|
a Consul version, Consul data should be [backed up](https://learn.hashicorp.com/tutorials/consul/kubernetes-disaster-recovery).
|
||||||
|
|
||||||
### Q: How can I run tcpdump on Consul servers?
|
### Q: How can I run tcpdump on Consul servers?
|
||||||
|
|
||||||
|
@ -159,7 +159,7 @@ If the remote datacenter is not available, then those resources will also not be
|
||||||
available from that datacenter. That will not affect the requests to the local
|
available from that datacenter. That will not affect the requests to the local
|
||||||
datacenter. There are some special situations where a limited subset of data
|
datacenter. There are some special situations where a limited subset of data
|
||||||
can be replicated, such as with Consul's built-in
|
can be replicated, such as with Consul's built-in
|
||||||
[ACL replication](/consul/tutorials/security-operations/access-control-replication-multiple-datacenters?utm_source=docs)
|
[ACL replication](https://learn.hashicorp.com/tutorials/consul/access-control-replication-multiple-datacenters)
|
||||||
capability, or external tools like
|
capability, or external tools like
|
||||||
[consul-replicate](https://github.com/hashicorp/consul-replicate).
|
[consul-replicate](https://github.com/hashicorp/consul-replicate).
|
||||||
|
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue