Merge pull request #12856 from hashicorp/docs-ent-modules

docs: updated connect docs and re-deploying missed changes
This commit is contained in:
Karl Cardenas 2022-04-26 13:13:19 -07:00 committed by GitHub
commit 5c346e5c26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 13 deletions

View File

@ -7,29 +7,41 @@ description: >-
connections, automatically wrapping and verifying TLS connections. connections, automatically wrapping and verifying TLS connections.
--- ---
# Connect Configuration # Service Mesh Configuration
There are many configuration options exposed for Connect. The only option There are many configuration options exposed for Consul service mesh. The only option
that must be set is the "enabled" option on Consul Servers to enable Connect. that must be set is the `connect.enabled` option on Consul servers to enable Consul service mesh.
All other configurations are optional and have reasonable defaults. All other configurations are optional and have reasonable defaults.
-> **Tip:** Connect is enabled by default when running Consul 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.
-> **Tip:** Service mesh is enabled by default when running Consul in
dev mode with `consul agent -dev`. dev mode with `consul agent -dev`.
## Agent Configuration ## Agent Configuration
The first step to use Connect is to enable Connect for your Consul Begin by enabling Connect for your Consul
cluster. By default, Connect is disabled. Enabling Connect requires changing cluster. By default, Connect is disabled. Enabling Connect requires changing
the configuration of only your Consul _servers_ (not client agents). To enable the configuration of only your Consul _servers_ (not client agents). To enable
Connect, add the following to a new or existing Connect, add the following to a new or existing
[server configuration file](/docs/agent/config/config-files). In an existing cluster, this configuration change requires a Consul server restart, which you can perform one server at a time to maintain availability. In HCL: [server configuration file](/docs/agent/config/config-files). In an existing cluster, this configuration change requires a Consul server restart, which you can perform one server at a time to maintain availability. In HCL:
<CodeTabs heading="Enable Consul service mesh" tabs={[ "HCL", "JSON" ]}>
```hcl ```hcl
connect { connect {
enabled = true enabled = true
} }
``` ```
```json
"connect": {
"enabled": true
}
```
</CodeTabs>
This will enable Connect and configure your Consul cluster to use the This will enable Connect and configure your Consul cluster to use the
built-in certificate authority for creating and managing certificates. built-in certificate authority for creating and managing certificates.
You may also configure Consul to use an external You may also configure Consul to use an external

View File

@ -6,15 +6,15 @@ description: >-
and performance, intention and certificate authority replication. and performance, intention and certificate authority replication.
--- ---
# How Connect Works # How Service Mesh Works
This page details the inner workings of some of Connect's core features. This topic describes how many of the core features of Consul's service mesh functionality works.
Understanding how these features work isn't a prerequisite for using Connect, It is not a prerequisite,
but will help you build a mental model of what's going on under the hood, which but this information will help you understand how Consul service mesh behaves in more complex scenarios.
may help you reason about Connect's behavior in more complex deployment
scenarios.
To try Connect locally, complete the [Getting Started with Consul service 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
mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS)
tutorial. tutorial.

View File

@ -142,7 +142,7 @@
"path": "connect" "path": "connect"
}, },
{ {
"title": "How Connect Works", "title": "How Service Mesh Works",
"path": "connect/connect-internals" "path": "connect/connect-internals"
}, },
{ {