Merge pull request #11810 from hashicorp/update-enterprise-packaging-in-feature-docs

Update enterprise packaging in feature docs
This commit is contained in:
Jared Kirschner 2022-04-28 19:38:59 -04:00 committed by GitHub
commit d04fe6ca2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 138 additions and 46 deletions

View File

@ -7,8 +7,11 @@ description: Consul Enterprise enables you to create partitions that can be admi
# Consul Enterprise Admin Partitions
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires version 1.11.0+ of
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
This topic provides and overview of admin partitions, which are entities that define one or more administrative boundaries for single Consul deployments.

View File

@ -8,14 +8,17 @@ description: >-
# Audit Logging
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul Enterprise v1.8.0 adds audit logging as a feature that captures a clear and
With Consul Enterprise v1.8.0+, audit logging can be used to capture a clear and
actionable log of authenticated events (both attempted and committed) that Consul
processes via its HTTP API and compiles them into a JSON format for easy export.
These events contain a timestamp, the operation performed, and the user who initiated the action.
processes via its HTTP API. These events are compiled them into a JSON format for easy export
and contain a timestamp, the operation performed, and the user who initiated the action.
Audit logging enables security and compliance teams within an organization to get
greater insight into Consul access and usage patterns.

View File

@ -10,8 +10,11 @@ description: >-
# Automated Backups
<EnterpriseAlert>
This feature is available in all versions of{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul Enterprise enables you to run

View File

@ -10,8 +10,11 @@ description: >-
# Consul Enterprise Advanced Federation
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul's core federation capability uses the same gossip mechanism that is used

View File

@ -8,22 +8,83 @@ description: >-
# Consul Enterprise
[Consul Enterprise](https://www.hashicorp.com/consul) features address the organizational complexities of collaboration, operations, scale and governance. It includes capabilities that improve failure resilience, read scalability, and managing access in accordance with organizational policies. It also adds support for application and service architectures across complex network topologies. If you have already purchased Consul Enterprise, please see the [licensing section](#licensing) below.
[Consul Enterprise](https://www.hashicorp.com/products/consul/)
features address the organizational complexities of collaboration, operations, scale, and governance.
If you have purchased or wish to try out Consul Enterprise,
refer to [how to access Consul Enterprise](#access-consul-enterprise).
Features include:
## Enterprise Features
- [Admin Partitions](/docs/enterprise/admin-partitions)
- [Audit Logging](/docs/enterprise/audit-logging)
- [Automated Backups](/docs/enterprise/backups)
- [Automated Upgrades](/docs/enterprise/upgrades)
- [Enhanced Read Scalability](/docs/enterprise/read-scale)
- [Redundancy Zones](/docs/enterprise/redundancy)
- [Advanced Federation for Complex Network Topologies](/docs/enterprise/federation)
- [Network Segments](/docs/enterprise/network-segments)
- [Namespaces](/docs/enterprise/namespaces)
- [NIA with Terraform Enterprise](/docs/nia/enterprise)
- [Sentinel](/docs/enterprise/sentinel)
- [OIDC Auth Method](/docs/security/acl/auth-methods/oidc)
The following features are [available in several forms of Consul Enterprise](#consul-enterprise-feature-availability).
These features are part of [Consul
Enterprise](https://www.hashicorp.com/consul).
### Multi-Tenancy
- [Admin Partitions](/docs/enterprise/admin-partitions): Define administrative boundaries between tenants within a single Consul datacenter
- [Namespaces](/docs/enterprise/namespaces): Define resource boundaries within a single admin partition for further organizational flexibility
### Resiliency
- [Automated Backups](/docs/enterprise/backups): Donfigure the automatic backup of Consul state
- [Redundancy Zones](/docs/enterprise/redundancy): Deploy backup voting Consul servers to efficiently improve Consul fault tolerance
### Scalability
- [Read Replicas](/docs/enterprise/read-scale): Deploy non-voting Consul servers to enhance the scalability of read requests
### Operational Simplification
- [Automated Upgrades](/docs/enterprise/upgrades): Ease upgrades by automating the transition from existing to newly deployed Consul servers
- [Consul-Terraform-Sync Enterprise](/docs/nia/enterprise): Leverage the enhanced network infrastructure automation capabilities of the enterprise version of Consul-Terraform-Sync
### Complex Network Topology Support
- [Network Areas](/docs/enterprise/federation): Support complex network topologies between federated Consul datacenters with pairwise federation rather than full mesh federation
- [Network Segments](/docs/enterprise/network-segments): Support complex network topologies within a Consul datacenter by enforcing boundaries in Consul client gossip traffic
### Governance
- [OIDC Auth Method](/docs/security/acl/auth-methods/oidc): Manage user access to Consul through an OIDC identity provider instead of Consul ACL tokens directly
- [Audit Logging](/docs/enterprise/audit-logging): Understand Consul access and usage patterns by reviewing access to the Consul HTTP API
- [Sentinel for KV](/docs/enterprise/sentinel): Policy-as-code framework for defining advanced key-value storage access control policies
## Access Consul Enterprise
The method of accessing Consul Enterprise and its features depends on the whether using
HashiCorp Cloud Platform or self-managed Consul.
### HCP Consul
No action is required to access Consul Enterprise in a
[HashiCorp Cloud Platform](https://cloud.hashicorp.com/products/consul) installation.
You can try out HCP Consul for free. Refer to the
[HCP Consul product page](https://cloud.hashicorp.com/products/consul) for more details.
### Self-Managed Consul
To access Consul Enterprise in a self-managed installation,
[apply a purchased license](/docs/enterprise/license/overview)
to the Consul Enterprise binary that grants access to the desired features.
You can also try out Consul Enterprise before purchasing by
[requesting a 30-day trial license](https://consul.io/trial).
## Consul Enterprise Feature Availability
Consul Enterprise is offered in several forms that provide a different mix of enterprise features.
Choose the form that best suits the needs of your organization.
Available enterprise features per Consul form and license include:
| Feature | [HashiCorp Cloud Platform (HCP) Consul] | [Consul Enterprise] | Legacy Consul Enterprise (module-based) |
| -------------------------------------------------------- | --------------------------------------- | ------------------- | ------------------------------------------------- |
| Consul servers as a managed service | Yes | No (self-managed) | No (self-managed) |
| [Admin Partitions](/docs/enterprise/admin-partitions) | All tiers | Yes | With Governance and Policy module |
| [Namespaces](/docs/enterprise/namespaces) | All tiers | Yes | With Governance and Policy module |
| [Automated Backups](/docs/enterprise/backups) | All tiers | Yes | Yes |
| [Redundancy Zones](/docs/enterprise/redundancy) | Not applicable | Yes | With Global Visibility, Routing, and Scale module |
| [Read Replicas](/docs/enterprise/read-scale) | No | Yes | With Global Visibility, Routing, and Scale module |
| [Automated Upgrades](/docs/enterprise/upgrades) | All tiers | Yes | Yes |
| [Consul-Terraform-Sync Enterprise](/docs/nia/enterprise) | No | Yes | Yes |
| [Network Areas](/docs/enterprise/federation) | No | Yes | With Global Visibility, Routing, and Scale module |
| [Network Segments](/docs/enterprise/network-segments) | No | Yes | With Global Visibility, Routing, and Scale module |
| [OIDC Auth Method](/docs/acl/auth-methods/oidc) | No | Yes | Yes |
| [Audit Logging](/docs/enterprise/audit-logging) | Standard tier and above | Yes | With Governance and Policy module |
| [Sentinel for KV](/docs/enterprise/sentinel) | All tiers | Yes | With Governance and Policy module |
[HashiCorp Cloud Platform (HCP) Consul]: https://cloud.hashicorp.com/products/consul
[Consul Enterprise]: https://www.hashicorp.com/products/consul/

View File

@ -7,11 +7,14 @@ description: Consul Enterprise enables data isolation with Namespaces.
# Consul Enterprise Namespaces
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
With Consul Enterprise v1.7.0, data for different users or teams
With Consul Enterprise 1.7.0+, data for different users or teams
can be isolated from each other with the use of namespaces. Namespaces help reduce operational challenges
by removing restrictions around uniqueness of resource names across distinct teams, and enable operators
to provide self-service through delegation of administrative privileges.

View File

@ -9,9 +9,11 @@ description: |-
# Network Segments
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}
version 0.9.3+.
This feature requires version 0.9.3+ of
self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul requires full connectivity between all agents (servers and clients) in a

View File

@ -9,8 +9,11 @@ description: >-
# Enhanced Read Scalability with Read Replicas
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul Enterprise provides the ability to scale clustered Consul servers

View File

@ -9,8 +9,11 @@ description: >-
# Redundancy Zones
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul Enterprise redundancy zones provide

View File

@ -10,8 +10,11 @@ description: >-
# Sentinel in Consul
<EnterpriseAlert>
This feature requires{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>{' '}.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Sentinel policies extend the ACL system in Consul beyond static "read", "write",

View File

@ -10,8 +10,11 @@ description: >-
# Automated Upgrades
<EnterpriseAlert>
This feature is available in all versions of{' '}
<a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>.
This feature requires
HashiCorp Cloud Platform (HCP) or self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
Consul Enterprise enables the capability of automatically upgrading a cluster of Consul servers to a new

View File

@ -10,11 +10,13 @@ description: >-
# OIDC Auth Method
<EnterpriseAlert />
This feature is available in [Consul
Enterprise](https://www.hashicorp.com/products/consul/) version 1.8.0 and
newer.
<EnterpriseAlert>
This feature requires version 1.8.0+ of
self-managed Consul Enterprise.
Refer to the{' '}
<a href="/docs/enterprise#consul-enterprise-feature-availability">enterprise feature matrix</a>
{' '}for additional information.
</EnterpriseAlert>
The `oidc` auth method can be used to authenticate with Consul using
[OIDC](https://en.wikipedia.org/wiki/OpenID_Connect). This method allows