Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rename Consul OSS to Consul CE #19009

Merged
merged 3 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/content/api-docs/operator/autopilot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ $ curl \
`leader`, `voter`, `non-voter`, or `staging`.
- `Meta` is the node metadata of this server. Values within this map are used for determining a server's
redundancy zone and upgrade version.
- `NodeType` is the desired type autopilot thinks this server should have. In Consul OSS the only possible
- `NodeType` is the desired type autopilot thinks this server should have. In Consul CE, the only possible
value is `voter` as all present servers should having voting rights. In Consul Enterprise the possible values also
include `read-replica`, `zone-voter`, `zone-standby` and `zone-extra-voter`. `zone-voter` indicates that autopilot
wants this server to be the voter for a particular redundancy zone. When a zone has no voter all nodes will be typed
Expand Down
2 changes: 1 addition & 1 deletion website/content/api-docs/operator/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ $ curl \

<Tabs>

<Tab heading="OSS">
<Tab heading="CE">

```json
{
Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/snapshot/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Command: `consul snapshot agent`
~> The [`agent`](/consul/commands/snapshot/agent) subcommand described here is
available only in [Consul Enterprise](https://www.hashicorp.com/products/consul/)
version 0.7.1 and later. All other [snapshot subcommands](/consul/commands/snapshot)
are available in the open source version of Consul.
are available in the community edition of Consul.

The `snapshot agent` subcommand starts a process that takes snapshots of the
state of the Consul servers and saves them locally, or pushes them to an
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/agent/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ Any metric in this section can be turned off with the [`prefix_filter`](/consul/
These metrics give insight into the health of the cluster as a whole.
Query for the `consul.memberlist.*` and `consul.serf.*` metrics can be appended
with certain labels to further distinguish data between different gossip pools.
The supported label for OSS is `network`, while `segment`, `partition`, `area`
The supported label for CE is `network`, while `segment`, `partition`, `area`
are allowed for <EnterpriseAlert inline />.

| Metric | Description | Unit | Type |
Expand Down Expand Up @@ -763,7 +763,7 @@ Consul servers can report the following metrics about the host's system resource
This feature must be enabled in the [agent telemetry configuration](/consul/docs/agent/config/config-files#telemetry-enable_host_metrics).
Note that if the Consul server is operating inside a container these metrics
still report host resource usage and do not report any resource limits placed
on the container.
on the container.

**Requirements:**
- Consul 1.15.3+
Expand Down
14 changes: 7 additions & 7 deletions website/content/docs/agent/wal-logstore/enable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ While their likelihood remains low to very low, be aware of the following risks
- If WAL corrupts data on a Consul server agent, the server data cannot be recovered. Restart the server with an empty data directory and reload its state from the leader to resolve the issue.
- WAL may corrupt data or contain a defect that causes the server to panic and crash. WAL may not restart if the defect recurs when WAL reads from the logs on startup. Restart the server with an empty data directory and reload its state from the leader to resolve the issue.
- If WAL corrupts data, clients may read corrupted data from the Consul server, such as invalid IP addresses or unmatched tokens. This outcome is unlikely even if a recurring defect causes WAL to corrupt data because replication uses objects cached in memory instead of reads from disk. Restart the server with an empty data directory and reload its state from the leader to resolve the issue.
- If you enable a Consul OSS server to use WAL or enable WAL on a voting server with Consul Enterprise, WAL may corrupt the server's state, become the leader, and replicate the corrupted state to all other servers. In this case, restoring from backup is required to recover a completely uncorrupted state. Test WAL on a non-voting server in Enterprise to prevent this outcome. You can add a new non-voting server to the cluster to test with if there are no existing ones.
- If you enable a Consul CE server to use WAL or enable WAL on a voting server with Consul Enterprise, WAL may corrupt the server's state, become the leader, and replicate the corrupted state to all other servers. In this case, restoring from backup is required to recover a completely uncorrupted state. Test WAL on a non-voting server in Enterprise to prevent this outcome. You can add a new non-voting server to the cluster to test with if there are no existing ones.

## Enable log verification

You must enable log verification on all voting servers in Enterprise and all servers in OSS because the leader writes verification checkpoints.
You must enable log verification on all voting servers in Enterprise and all servers in CE because the leader writes verification checkpoints.

1. On each voting server, add the following to the server's configuration file:

Expand All @@ -64,8 +64,8 @@ You must enable log verification on all voting servers in Enterprise and all ser
}
```

1. Restart the server to apply the changes. The `consul reload` command is not sufficient to apply `raft_logstore` configuration changes.
1. Run the `consul operator raft list-peers` command to wait for each server to become a healthy voter before moving on to the next. This may take a few minutes for large snapshots.
1. Restart the server to apply the changes. The `consul reload` command is not sufficient to apply `raft_logstore` configuration changes.
1. Run the `consul operator raft list-peers` command to wait for each server to become a healthy voter before moving on to the next. This may take a few minutes for large snapshots.

When complete, the server's logs should contain verifier reports that appear like the following example:

Expand All @@ -75,7 +75,7 @@ When complete, the server's logs should contain verifier reports that appear lik

## Select target server to enable WAL

If you are using Consul OSS or Consul Enterprise without non-voting servers, select a follower server to enable WAL. As noted in [Risks](#risks), Consul Enterprise users with non-voting servers should first select a non-voting server, or consider adding another server as a non-voter to test on.
If you are using Consul CE, or Consul Enterprise without non-voting servers, select a follower server to enable WAL. As noted in [Risks](#risks), Consul Enterprise users with non-voting servers should first select a non-voting server, or consider adding another server as a non-voter to test on.

Retrieve the current state of the servers by running the following command:

Expand All @@ -85,7 +85,7 @@ $ consul operator raft list-peers

## Stop target server

Stop the target server gracefully. For example, if you are using `systemd`,
Stop the target server gracefully. For example, if you are using `systemd`,
run the following command:

```shell-session
Expand Down Expand Up @@ -148,4 +148,4 @@ If you disabled configuration management automation, consider reenabling it duri

- If you do not see errors and would like to expand the test further, you can repeat the above procedure on another target server. We suggest waiting after each test expansion and slowly rolling WAL out to other parts of your environment. Once the majority of your servers use WAL, any bugs not yet discovered may result in cluster unavailability.

- If you wish to permanently enable WAL on all servers, repeat the steps described in this topic for each server. Even if `backend = "wal"` is set in logs, servers continue to use BoltDB if they find an existing raft.db file in the data directory.
- If you wish to permanently enable WAL on all servers, repeat the steps described in this topic for each server. Even if `backend = "wal"` is set in logs, servers continue to use BoltDB if they find an existing raft.db file in the data directory.
4 changes: 2 additions & 2 deletions website/content/docs/api-gateway/tech-specs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following table describes the TCP port requirements for each component of th

## Consul server deployments

- Consul Editions supported: OSS and Enterprise
- Consul Editions supported: CE and Enterprise
- Supported Consul Server deployment types:
- Self-Managed
- HCP Consul
Expand All @@ -52,7 +52,7 @@ Consul API gateway can be deployed in the following Kubernetes-based environment
- Google Kubernetes Engine (GKE)
- Azure Kubernetes Service (AKS)

## Supported versions of Kubernetes Gateway API specification
## Supported versions of Kubernetes Gateway API specification

Refer to the [release notes](/consul/docs/release-notes) for your version of Consul.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This topic describes the `exported-services` configuration entry type. The `expo

## Introduction

To configure Consul to export services contained in a Consul Enterprise admin partition or Consul OSS datacenter to one or more additional clusters, create a new configuration entry and declare `exported-services` in the `kind` field. This configuration entry enables you to route traffic between services in different clusters.
To configure Consul to export services contained in a Consul Enterprise admin partition or Consul CE datacenter to one or more additional clusters, create a new configuration entry and declare `exported-services` in the `kind` field. This configuration entry enables you to route traffic between services in different clusters.

You can configure the settings defined in the `exported-services` configuration entry to apply to all namespaces in a Consul Enterprise admin partition.

Expand All @@ -31,7 +31,7 @@ You can configure the settings defined in the `exported-services` configuration
Configure the following parameters to define a `exported-services` configuration entry:

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">
<CodeTabs heading="Exported services configuration syntax" tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

```hcl
Expand Down Expand Up @@ -256,7 +256,7 @@ The following table describes the parameters associated with the `exported-servi
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| `Kind` | String value that enables the configuration entry. The value should always be `exported-services` (HCL and JSON) or `ExportedServices` (YAML) | Required | None |
| `Partition` | <EnterpriseAlert inline /> String value that specifies the name of the partition that contains the services you want to export. | Required | None |
| `Name` | String value that specifies the name of the partition that contains the services you want to export. Must be `default` in Consul OSS. | Required | None |
| `Name` | String value that specifies the name of the partition that contains the services you want to export. Must be `default` in Consul CE. | Required | None |
| `Services` | List of objects that specify which services to export. For details, refer to [`Services`](#services). | Required | None |
| `Meta` | Object that defines a map of the max 64 key/value pairs. | Optional | None |

Expand Down Expand Up @@ -288,7 +288,7 @@ A asterisk wildcard (`*`) cannot be specified as the `SamenessGroup`.


<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

The following example configures Consul to export the `payments` and `refunds` services to the peered `web-shop` cluster.

Expand Down Expand Up @@ -580,7 +580,7 @@ spec:
### Exporting all services

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

The following example configures Consul to export all services in the datacenter to the peered `monitoring` and `platform` clusters.

Expand Down Expand Up @@ -780,7 +780,7 @@ spec:
When an exported service has been imported to another cluster, you can use the `health` REST API endpoint to query the service on the consumer cluster.

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

The following example queries the `finance` peer for the imported `payments` service:

Expand All @@ -795,7 +795,7 @@ If the call in the previous example is made from a service named `web`, then the
- A token with `service:write` permissions to `web`.
- A token with `service:read` and `node:read` to all names in the datacenter.

<CodeTabs heading="Example ACL rules for reading imported services in Consul OSS">
<CodeTabs heading="Example ACL rules for reading imported services in Consul CE">

```hcl
service "web" {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1530,7 +1530,7 @@ Refer to the following examples for common ingress gateway configuration pattern

The following example sets up a TCP listener on an ingress gateway named `us-east-ingress` that proxies traffic to the `db` service. For Consul Enterprise, the `db` service can only listen for traffic in the `default` namespace inside the `team-frontend` admin partition:

#### Consul OSS
#### Consul CE

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down Expand Up @@ -1657,7 +1657,7 @@ The Consul Enterprise version implements the following additional configurations
- The ingress gateway is set up in the `default` [namespace](/consul/docs/enterprise/namespaces) and proxies traffic to all services in the `frontend` namespace.
- The `api` and `web` services are proxied to team-specific [admin partitions](/consul/docs/enterprise/admin-partitions):

#### Consul OSS
#### Consul CE

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down
8 changes: 4 additions & 4 deletions website/content/docs/connect/config-entries/mesh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Settings in this config entry apply across all namespaces and federated datacent
Enforce that service mesh mTLS traffic uses TLS v1.2 or newer.

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down Expand Up @@ -108,7 +108,7 @@ Note that the Kubernetes example does not include a `partition` field. Configura
Only allow transparent proxies to dial addresses in the mesh.

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down Expand Up @@ -189,7 +189,7 @@ Note that the Kubernetes example does not include a `partition` field. Configura
Set the `PeerThroughMeshGateways` parameter to `true` to route peering control plane traffic through mesh gateways.

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down Expand Up @@ -315,7 +315,7 @@ Note that the Kubernetes example does not include a `partition` field. Configura
name: 'namespace',
enterprise: true,
description:
'Must be set to `default`. If running Consul Open Source, the namespace is ignored (see [Kubernetes Namespaces in Consul OSS](/consul/docs/k8s/crds#consul-oss)). If running Consul Enterprise see [Kubernetes Namespaces in Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for additional information.',
'Must be set to `default`. If running Consul Community Edition, the namespace is ignored (see [Kubernetes Namespaces in Consul CE](/consul/docs/k8s/crds#consul-ce)). If running Consul Enterprise see [Kubernetes Namespaces in Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for additional information.',
},
],
hcl: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -971,4 +971,4 @@ spec:

</Tab>

</Tabs>
</Tabs>
Original file line number Diff line number Diff line change
Expand Up @@ -899,7 +899,7 @@ Specifies the name of the service you are setting the defaults for.

### `metadata.namespace` <Enterprise/>

Specifies the Consul namespace that the configuration entry applies to. Refer to [Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for information about how Consul namespaces map to Kubernetes Namespaces. Open source Consul distributions (Consul OSS) ignore the `metadata.namespace` configuration.
Specifies the Consul namespace that the configuration entry applies to. Refer to [Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for information about how Consul namespaces map to Kubernetes Namespaces. Consul Community Edition (Consul CE) ignores the `metadata.namespace` configuration.

- Default: `default`
- Data type: String
Expand Down Expand Up @@ -1336,7 +1336,7 @@ You can also set the global default protocol for all proxies in the [`proxy-defa
### Upstream configuration

<Tabs>
<Tab heading="Consul OSS">
<Tab heading="Consul CE">

The following example sets default connection limits and mesh gateway mode across all upstreams of the `dashboard` service.
It also overrides the mesh gateway mode used when dialing its `counting` upstream service.
Expand Down Expand Up @@ -1612,13 +1612,13 @@ Proxy services must be in transparent proxy mode to configure destinations. Refe
{
name: 'namespace',
description:
'If running Consul Open Source, the namespace is ignored (see [Kubernetes Namespaces in Consul OSS](/consul/docs/k8s/crds#consul-oss)). If running Consul Enterprise see [Kubernetes Namespaces in Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for more details.',
'If running Consul Community Edition, the namespace is ignored (see [Kubernetes Namespaces in Consul CE](/consul/docs/k8s/crds#consul-ce)). If running Consul Enterprise see [Kubernetes Namespaces in Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for more details.',
},
{
name: 'partition',
enterprise: true,
description:
'Specifies the admin partition in which the configuration will apply. The current partition is used if unspecified. Refer to the [Admin Partitions documentation](/consul/docs/enterprise/admin-partitions) for details. The partitions parameter is not supported in Consul OSS.',
'Specifies the admin partition in which the configuration will apply. The current partition is used if unspecified. Refer to the [Admin Partitions documentation](/consul/docs/enterprise/admin-partitions) for details. The partitions parameter is not supported in Consul CE.',
},
],
hcl: false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ Map that contains an arbitrary name for the configuration entry and the namespac

Specifies an arbitrary name for the configuration entry. Note that in other configuration entries, the `metadata.name` field specifies the name of the service that the settings apply to. For service intentions, the service that accepts the configurations is the _destination_ and is specified in the [`spec.destination.name`](#spec-destination-name) field. Refer to the following topics for additional information:

- [ServiceIntentions Special Case (OSS)](/consul/docs/k8s/crds#serviceintentions-special-case)
- [ServiceIntentions Special Case (CE)](/consul/docs/k8s/crds#serviceintentions-special-case)
- [ServiceIntentions Special Case (Enterprise)](/consul/docs/k8s/crds#serviceintentions-special-case-enterprise)

#### Values
Expand All @@ -697,7 +697,7 @@ Specifies an arbitrary name for the configuration entry. Note that in other conf

### `metadata.namespace` <EnterpriseAlert inline />

Specifies the [namespace](/consul/docs/enterprise/namespaces) that the configuration entry applies to. Refer to [Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for information about how Consul namespaces map to Kubernetes Namespaces. Open source Consul distributions (Consul OSS) ignore the `metadata.namespace` configuration.
Specifies the [namespace](/consul/docs/enterprise/namespaces) that the configuration entry applies to. Refer to [Consul Enterprise](/consul/docs/k8s/crds#consul-enterprise) for information about how Consul namespaces map to Kubernetes Namespaces. Consul Community Edition (Consul CE) ignores the `metadata.namespace` configuration.

#### Values

Expand Down
Loading