Add callouts to Enterprise features (#7548)

Label all enterprise-related content with Enterprise badge/callout.

Resolves #6887

Co-authored-by: Jeff Escalante <jescalan@users.noreply.github.com>
This commit is contained in:
Blake Covarrubias 2020-04-23 15:13:18 -07:00 committed by Jeff Escalante
parent ad0a235242
commit 6e3b3a3f04
No known key found for this signature in database
GPG Key ID: 32D23C61AB5450DB
57 changed files with 170 additions and 134 deletions

View File

@ -0,0 +1,5 @@
import EnterpriseAlert from '@hashicorp/react-enterprise-alert'
export default function EnterpriseAlertConsul(props) {
return <EnterpriseAlert product="consul" {...props} />
}

View File

@ -2,9 +2,9 @@ import DocsPage from '@hashicorp/react-docs-page'
import order from '../data/api-navigation.js'
import { frontMatter as data } from '../pages/api-docs/**/*.mdx'
import { MDXProvider } from '@mdx-js/react'
import EnterpriseAlert from '../components/enterprise-alert'
import Head from 'next/head'
import Link from 'next/link'
import EnterpriseAlert from '@hashicorp/react-enterprise-alert'
const DEFAULT_COMPONENTS = { EnterpriseAlert }

View File

@ -2,7 +2,7 @@ import DocsPage from '@hashicorp/react-docs-page'
import order from '../data/docs-navigation.js'
import { frontMatter as data } from '../pages/docs/**/*.mdx'
import { MDXProvider } from '@mdx-js/react'
import EnterpriseAlert from '@hashicorp/react-enterprise-alert'
import EnterpriseAlert from '../components/enterprise-alert'
import Head from 'next/head'
import Link from 'next/link'

View File

@ -2,9 +2,9 @@ import DocsPage from '@hashicorp/react-docs-page'
import order from '../data/intro-navigation.js'
import { frontMatter as data } from '../pages/intro/**/*.mdx'
import { MDXProvider } from '@mdx-js/react'
import EnterpriseAlert from '../components/enterprise-alert'
import Head from 'next/head'
import Link from 'next/link'
import EnterpriseAlert from '@hashicorp/react-enterprise-alert'
const DEFAULT_COMPONENTS = { EnterpriseAlert }

View File

@ -52,7 +52,7 @@ The table below shows this endpoint's support for
For more information on configuring specific auth method types, see the [auth
method documentation](/docs/acl/acl-auth-methods).
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the auth method within. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -123,7 +123,7 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the name of the ACL auth method to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the auth method within. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -189,7 +189,7 @@ The table below shows this endpoint's support for
For more information on configuring specific auth method types, see the [auth
method documentation](/docs/acl/acl-auth-methods).
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the auth method to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -264,7 +264,7 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the name of the ACL auth method to
delete. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the
Auth Method to delete. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -303,7 +303,7 @@ The table below shows this endpoint's support for
### Parameters
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list
the auth methods for. This value can be specified as the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default

View File

@ -87,7 +87,7 @@ The table below shows this endpoint's support for
prefixed-${serviceaccount.name}
```
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the binding rule. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -153,7 +153,7 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL binding rule
to read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the binding rule. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -256,7 +256,7 @@ The table below shows this endpoint's support for
prefixed-${serviceaccount.name}
```
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the binding rule to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -322,7 +322,7 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL binding rule to
delete. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the
binding rule to delete. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -364,7 +364,7 @@ The table below shows this endpoint's support for
- `authmethod` `(string: "")` - Filters the binding rule list to those binding
rules that are linked with the specific named auth method.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list
the binding rules for. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default

View File

@ -303,7 +303,7 @@ replication enabled.
- `Meta` `(map<string|string>: nil)` - Specifies arbitrary KV metadata
linked to the token. Can be useful to track origins.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the Auth Method to use for Login. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL

View File

@ -49,7 +49,7 @@ The table below shows this endpoint's support for
When no datacenters are provided the policy is valid in all datacenters including
those which do not yet exist but may in the future.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the policy. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -112,7 +112,7 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL policy to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the policy. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -162,7 +162,7 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the name of the ACL policy to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the policy. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -226,7 +226,7 @@ The table below shows this endpoint's support for
When no datacenters are provided the policy is valid in all datacenters including
those which do not yet exist but may in the future.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the policy to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -291,7 +291,7 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL policy to
delete. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the
policy to delete. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -330,7 +330,7 @@ The table below shows this endpoint's support for
### Parameters
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list
the Policies for. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default

View File

@ -62,7 +62,7 @@ The table below shows this endpoint's support for
policy is valid in all datacenters including those which do not yet exist
but may in the future.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the role. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -153,7 +153,8 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL role to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the role. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -216,7 +217,8 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the Name of the ACL role to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the role. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -297,7 +299,7 @@ The table below shows this endpoint's support for
identities](/docs/acl/acl-system#acl-service-identities) that should be
applied to the role. Added in Consul 1.5.0.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the role to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -379,7 +381,7 @@ The table below shows this endpoint's support for
- `id` `(string: <required>)` - Specifies the UUID of the ACL role to
delete. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the
role to delete. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -423,7 +425,7 @@ The table below shows this endpoint's support for
### Parameters
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list
the roles for. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default

View File

@ -88,7 +88,7 @@ The table below shows this endpoint's support for
respectively). This value must be no smaller than 1 minute and no longer than
24 hours. Added in Consul 1.5.0.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the token. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -167,7 +167,7 @@ The table below shows this endpoint's support for
- `AccessorID` `(string: <required>)` - Specifies the accessor ID of the ACL token to
read. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to lookup
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to lookup
the token. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -337,7 +337,7 @@ The table below shows this endpoint's support for
match the existing value. If not present then the value will be filled in by
Consul.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the token to update. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -425,7 +425,7 @@ The table below shows this endpoint's support for
- `Description` `(string: "")` - Free form human readable description for the cloned token.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the token to be cloned. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -502,7 +502,7 @@ The table below shows this endpoint's support for
- `AccessorID` `(string: <required>)` - Specifies the accessor ID of the ACL token to
delete. This is required and is specified as part of the URL path.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the
token to delete. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default
@ -550,13 +550,13 @@ The table below shows this endpoint's support for
- `authmethod` `(string: "")` - Filters the token list to those tokens that are
linked with the specific named auth method.
- `authmethod-ns` `(string: "")` - **(Enterprise Only)** Specifics the namespace
- `authmethod-ns` `(string: "")` <EnterpriseAlert inline /> - Specifics the namespace
of the `authmethod` being used for token lookup. If not provided, the namespace
provided by the `ns` parameter will be used. If neither of those is provided
then the namespace will be inherited from the request's ACL token. Added in
Consul 1.7.0.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list
the tokens for. This value can be specified as the `ns` URL query
parameter or the `X-Consul-Namespace` header. If not provided by either,
the namespace will be inherited from the request's ACL token or will default

View File

@ -58,7 +58,7 @@ The table below shows this endpoint's support for
number for the requesting client cert. This is used to check against
revocation lists.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace of
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
the target service. If not provided in the JSON body, the value of
the `ns` URL query parameter or in the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL

View File

@ -45,7 +45,7 @@ The table below shows this endpoint's support for
members (which is the default). This is only eligible for agents running in
**server mode**. This is specified as part of the URL as a query parameter.
- `segment` `(string: "")` - (Enterprise-only) Specifies the segment to list members for.
- `segment` `(string: "")` <EnterpriseAlert inline /> - Specifies the segment to list members for.
If left blank, this will query for the default segment when connecting to a server and
the agent's own segment when connecting to a client (clients can only be part of one
network segment). When querying a server, setting this to the special string `_all`

View File

@ -88,7 +88,7 @@ The table below shows this endpoint's support for
already registered. Note, if the parameter is enabled for a node that doesn't
exist, it will still be created.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace in which the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace in which the
service and checks will be registered. This value may be provided by either the
`ns` URL query parameter or in the `X-Consul-Namespace` header. Additionally,
the namespace may be provided within the `Service` or `Check` fields but if
@ -201,7 +201,7 @@ The behavior of the endpoint depends on what keys are provided.
- `ServiceID` `(string: "")` - Specifies the ID of the service to remove. The
service and all associated checks will be removed.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace in which the
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace in which the
service and checks will be deregistered. If not provided in the JSON body, the value of
the `ns` URL query parameter or the `X-Consul-Namespace` header will be used.
If not provided at all, the namespace will be inherited from the request's ACL
@ -402,7 +402,7 @@ The table below shows this endpoint's support for
will filter the results to nodes with the specified key/value pairs. This is
specified as part of the URL as a query parameter.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list services.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -471,7 +471,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to use for the
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to use for the
query. This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -675,7 +675,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list services.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -802,7 +802,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list services.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list services.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. The `*`

View File

@ -54,7 +54,7 @@ The table below shows this endpoint's support for
non-zero, the entry is only set if the current index matches the `ModifyIndex`
of that entry.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace the config
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace the config
entry will apply to. This value may be provided by either the `ns` URL query
parameter or in the `X-Consul-Namespace` header. If not provided at all,
the namespace will be inherited from the request's ACL token or will default
@ -116,7 +116,7 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the name of the entry to read. This
is specified as part of the URL.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited from
the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -175,7 +175,7 @@ The table below shows this endpoint's support for
- `kind` `(string: <required>)` - Specifies the kind of the entry to list. This
is specified as part of the URL.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited from
the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -246,7 +246,7 @@ The table below shows this endpoint's support for
- `name` `(string: <required>)` - Specifies the name of the entry to delete. This
is specified as part of the URL.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to delete from.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to delete from.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.

View File

@ -96,7 +96,7 @@ The table below shows this endpoint's support for
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter.
- `segment` `(string: "")` - (Enterprise-only) Specifies the segment to list members for.
- `segment` `(string: "")` <EnterpriseAlert inline /> - Specifies the segment to list members for.
If left blank, this will query for the default segment when connecting to a server and
the agent's own segment when connecting to a client (clients can only be part of one
network segment). When querying a server, setting this to the special string `_all`
@ -153,7 +153,7 @@ The table below shows this endpoint's support for
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter.
- `segment` `(string: "")` - (Enterprise-only) Specifies the segment to list members for.
- `segment` `(string: "")` <EnterpriseAlert inline /> - Specifies the segment to list members for.
If left blank, this will query for the default segment when connecting to a server and
the agent's own segment when connecting to a client (clients can only be part of one
network segment). When querying a server, setting this to the special string `_all`

View File

@ -45,7 +45,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to list checks.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to list checks.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. To view
@ -150,7 +150,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -249,7 +249,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace of the service.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.
@ -444,7 +444,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
This value may be provided by either the `ns` URL query parameter or in the
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
from the request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.

View File

@ -67,7 +67,7 @@ The table below shows this endpoint's support for
parameter to limit the prefix of keys returned, only up to the given separator.
This is specified as part of the URL as a query parameter.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
This is specified as part of the URL as a query parameter.
@ -204,7 +204,7 @@ The table below shows this endpoint's support for
will leave the `LockIndex` unmodified but will clear the associated `Session`
of the key. The key must be held by this session to be unlocked.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.
@ -265,7 +265,7 @@ The table below shows this endpoint's support for
index will not delete the key. If the index is non-zero, the key is only
deleted if the index matches the `ModifyIndex` of that key.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.

View File

@ -7,8 +7,7 @@ description: The /namespace endpoints allow for managing Consul Enterprise Names
# Namespace - HTTP API
~> **Enterprise Only!** These API endpoints and functionality only exists in
Consul Enterprise. This is not present in the open source version of Consul.
<EnterpriseAlert />
The functionality described here is available only in
[Consul Enterprise](https://www.hashicorp.com/products/consul/) version 1.7.0 and later.

View File

@ -9,12 +9,11 @@ description: |-
# Network Areas - Operator HTTP API
<EnterpriseAlert />
The `/operator/area` endpoints provide tools to manage network areas via
Consul's HTTP API.
~> **Enterprise Only!** This API endpoint and functionality only exists in
Consul Enterprise. This is not present in the open source version of Consul.
The network area functionality described here is available only in
[Consul Enterprise](https://www.hashicorp.com/products/consul/) version 0.8.0 and
later. Network areas are operator-defined relationships between servers in two

View File

@ -9,8 +9,7 @@ description: |-
# License - Operator HTTP API
~> **Enterprise Only!** This API endpoint and functionality only exists in
Consul Enterprise. This is not present in the open source version of Consul.
<EnterpriseAlert />
The licensing functionality described here is available only in
[Consul Enterprise](https://www.hashicorp.com/products/consul/) version 1.1.0 and later.

View File

@ -9,12 +9,11 @@ description: |-
# Network Areas - Operator HTTP API
<EnterpriseAlert />
The `/operator/segment` endpoint provides tools to manage network segments via
Consul's HTTP API.
~> **Enterprise-only!** This API endpoint and functionality only exists in
Consul Enterprise. This is not present in the open source version of Consul.
The network area functionality described here is available only in
[Consul Enterprise](https://www.hashicorp.com/products/consul/) version 0.9.3 and
later. Network segments are operator-defined sections of agents on the LAN, typically

View File

@ -87,7 +87,7 @@ populate the query before it is executed. All of the string fields inside the
doesn't match, or an invalid index is given, then `${match(N)}` will return an
empty string.
- `${agent.segment}` has the network segment (Enterprise-only) of the agent that
- `${agent.segment}` <EnterpriseAlert inline /> - the network segment of the agent that
initiated the query. This can be used with the `NodeMeta` field to limit the results
of a query to service instances within its own network segment:

View File

@ -30,7 +30,7 @@ The table below shows this endpoint's support for
### Parameters
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.
@ -130,7 +130,7 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.
@ -176,7 +176,7 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.
@ -235,7 +235,7 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter
@ -291,7 +291,7 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the URL as a query parameter.
The namespace may be specified as '\*' and then results will be returned for all namespaces.
@ -350,7 +350,7 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended.
- `ns` `(string: "")` - **(Enterprise Only)** Specifies the namespace to query.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
If not provided, the namespace will be inferred from the request's ACL token,
or will default to the `default` namespace. This is specified as part of the
URL as a query parameter. Added in Consul 1.7.0.

View File

@ -78,7 +78,7 @@ The table below shows this endpoint's support for
- `Session` `(string: "")` - Specifies a session. See the table below for more
information.
- `Namespace` `(string: "")` - **(Enterprise Only)** Specifies the namespace to
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to
create the KV data If not provided, the namespace will be inherited from the
request's ACL token or will default to the `default` namespace. Added in Consul 1.7.0.

View File

@ -801,7 +801,7 @@ In the example above, the rules allow reading the key "baz", and only allow recu
A token with `write` access on a prefix also has `list` access. A token with `list` access on a prefix also has `read` access on all its suffixes.
#### Sentinel Integration
#### Sentinel Integration <EnterpriseAlert inline />
Consul Enterprise supports additional optional fields for key write policies for
[Sentinel](https://docs.hashicorp.com/sentinel/consul/) integration. An example key rule with a

View File

@ -263,7 +263,7 @@ In the example above, the rules allow reading the key "baz", and only allow recu
A token with `write` access on a prefix also has `list` access. A token with `list` access on a prefix also has `read` access on all its suffixes.
#### Sentinel Integration
#### Sentinel Integration <EnterpriseAlert inline />
Consul Enterprise supports additional optional fields for key write policies for
[Sentinel](https://docs.hashicorp.com/sentinel/consul/) integration. An example key rule with a
@ -537,7 +537,7 @@ Session rules are segmented by the node name they apply to. In the example above
access to sessions on node name with the empty prefix, allow creating sessions on the node named "app",
and deny all access to any sessions on the "admin" node.
#### Namespace Rules <span class="label-enterprise label-enterprise-lg">Enterprise</span>
#### Namespace Rules <EnterpriseAlert inline />
[Consul Enterprise](https://www.hashicorp.com/consul) 1.7.0 adds support for namespacing many
Consul resources. ACL rules themselves can then be defined to only to apply to specific namespaces.

View File

@ -66,7 +66,7 @@ An ACL policy is a named set of rules and is composed of the following elements:
- **Description** - A human readable description of the policy. (Optional)
- **Rules** - Set of rules granting or denying permissions. See the [Rule Specification](/docs/acl/acl-rules#rule-specification) documentation for more details.
- **Datacenters** - A list of datacenters the policy is valid within.
- **Namespace** - **Enterprise Only** - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
- **Namespace** - <EnterpriseAlert inline /> - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
-> **Consul Enterprise Namespacing** - Rules defined in a policy in any namespace other than `default` will be [restricted](/docs/acl/acl-rules#namespace-rules-enterprise) to being able to grant a subset of the overall privileges and only affecting that single namespace.
@ -76,7 +76,7 @@ An ACL policy is a named set of rules and is composed of the following elements:
and will be assigned the reserved ID of `00000000-0000-0000-0000-000000000001`. This policy can be renamed but modification
of anything else including the rule set and datacenter scoping will be prevented by Consul.
- **Namespace Management** - **Enterprise Only** - Every namespace created will have a policy injected with the name `namespace-management`. This policy gets injected with a randomized UUID and may be managed like any other user-defined policy
- **Namespace Management** - <EnterpriseAlert inline /> - Every namespace created will have a policy injected with the name `namespace-management`. This policy gets injected with a randomized UUID and may be managed like any other user-defined policy
within the Namespace. (Added in Consul Enterprise 1.7.0)
### ACL Service Identities
@ -135,7 +135,7 @@ of the following elements:
- **Description** - A human readable description of the role. (Optional)
- **Policy Set** - The list of policies that are applicable for the role.
- **Service Identity Set** - The list of service identities that are applicable for the role.
- **Namespace** - **Enterprise Only** - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
- **Namespace** <EnterpriseAlert inline /> - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
-> **Consul Enterprise Namespacing** - Roles may only link to policies defined in the same namespace as the role itself.
@ -153,7 +153,7 @@ elements:
- **Locality** - Indicates whether the token should be local to the datacenter it was created within or created in
the primary datacenter and globally replicated.
- **Expiration Time** - The time at which this token is revoked. (Optional; Added in Consul 1.5.0)
- **Namespace** - **Enterprise Only** - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
- **Namespace** <EnterpriseAlert inline /> - The namespace this policy resides within. (Added in Consul Enterprise 1.7.0)
-> **Consul Enterprise Namespacing** - Tokens may only link to policies and roles defined in the same namespace as
the token itself.

View File

@ -37,17 +37,17 @@ parameters are required to properly configure an auth method of type
([JWT](https://jwt.io/ 'JSON Web Token')) used by the Consul leader to
validate application JWTs during login.
- `MapNamespaces` `(bool: <false>)` - **(Enterprise Only)** Indicates whether
- `MapNamespaces` `(bool: <false>)` <EnterpriseAlert inline /> - Indicates whether
the auth method should attempt to map the Kubernetes namespace to a Consul
namespace instead of creating tokens in the auth methods own namespace. Note
that mapping namespaces requires the auth method to reside within the
`default` namespace.
- `ConsulNamespacePrefix` `(string: <optional>)` - **(Enterprise Only)** When
- `ConsulNamespacePrefix` `(string: <optional>)` <EnterpriseAlert inline /> - When
`MapNamespaces` is enabled, this value will be prefixed to the Kubernetes
namespace to determine the Consul namespace to create the new token within.
- `ConsulNamespaceOverrides` `(map: <string:string>)` - **(Enterprise Only)**
- `ConsulNamespaceOverrides` `(map: <string:string>)` <EnterpriseAlert inline /> -
This field is a mapping of Kubernetes namespace names to Consul namespace
names. If a Kubernetes namespace is present within this map, the value will
be used without adding the `ConsulNamespacePrefix`. If the value in the map

View File

@ -125,9 +125,9 @@ $ consul config delete -kind service-defaults -name web
This command will not output anything when the deletion is successful.
#### Configuration Entry Management with Namespaces
#### Configuration Entry Management with Namespaces <EnterpriseAlert inline />
**Enterprise Only** - Configuration entry operations support passing a namespace in
Configuration entry operations support passing a namespace in
order to isolate the entry to affect only operations within that namespace. This was
added in Consul 1.7.0.

View File

@ -44,7 +44,7 @@ config {
- `Name` - Must be set to `global`
- `Namespace` `(string: "default")` - **Enterprise Only** Specifies the namespace the config entry will apply to.
- `Namespace` `(string: "default")` <EnterpriseAlert inline /> - Specifies the namespace the config entry will apply to.
- `Config` `(map[string]arbitrary)` - An arbitrary map of configuration values used by Connect proxies.
The available configurations depend on the Connect proxy you use. Any values

View File

@ -29,7 +29,7 @@ Protocol = "http"
- `Name` `(string: <required>)` - Set to the name of the service being configured.
- `Namespace` `(string: "default")` - **Enterprise Only** Specifies the namespace the config entry will apply to.
- `Namespace` `(string: "default")` <EnterpriseAlert inline /> - Specifies the namespace the config entry will apply to.
- `Protocol` `(string: "tcp")` - Sets the protocol of the service. This is used
by Connect proxies for things like observability features and to unlock usage

View File

@ -279,7 +279,7 @@ using the [`advertise-wan`](/docs/agent/options#_advertise-wan) and
[`translate_wan_addrs`](/docs/agent/options#translate_wan_addrs) configuration
options.
## Namespaced Services <span class="label-enterprise label-enterprise-lg">Enterprise</span>
## Namespaced Services <EnterpriseAlert inline />
Consul Enterprise 1.7.0 added support for namespaces including resolving namespaced
services via DNS. To maintain backwards compatibility existing queries can be used

View File

@ -438,7 +438,7 @@ The options below are all specified on the command-line.
leave as a permanent intent and does not attempt to join the cluster again when
starting. This flag allows the previous state to be used to rejoin the cluster.
- `-segment` ((#\_segment)) - (Enterprise-only) This flag is used to set
- `-segment` ((#\_segment)) <EnterpriseAlert inline /> - This flag is used to set
the name of the network segment the agent belongs to. An agent can only join and
communicate with other agents within its network segment. See the [Network Segments
Guide](https://learn.hashicorp.com/consul/day-2-operations/network-segments) for
@ -467,7 +467,7 @@ The options below are all specified on the command-line.
This overrides the default server RPC port 8300. This is available in Consul 1.2.2
and later.
- `-non-voting-server` ((#\_non_voting_server)) - (Enterprise-only) This
- `-non-voting-server` ((#\_non_voting_server)) <EnterpriseAlert inline /> - This
flag is used to make the server not participate in the Raft quorum, and have it
only receive the data replication stream. This can be used to add read scalability
to a cluster in cases where a high volume of reads to servers are needed.
@ -671,7 +671,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
authorize secondary datacenters with the primary datacenter for replication
operations. This token is required for servers outside the [`primary_datacenter`](#primary_datacenter) when ACLs are enabled. This token may be provided later using the [agent token API](/api/agent#update-acl-tokens) on each server. This token must have at least "read" permissions on ACL data but if ACL token replication is enabled then it must have "write" permissions. This also enables Connect replication, for which the token will require both operator "write" and intention "read" permissions for replicating CA and Intention data.
- `managed_service_provider` ((#acl_tokens_managed_service_provider)) - **(Enterprise Only)** An
- `managed_service_provider` ((#acl_tokens_managed_service_provider)) <EnterpriseAlert inline /> - An
array of ACL tokens used by Consul managed service providers for cluster operations.
```json
@ -840,17 +840,17 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
protocol version 3 or higher. Must be a duration value such as `30s`. Defaults
to `10s`.
- `redundancy_zone_tag` - (Enterprise-only)
- `redundancy_zone_tag` <EnterpriseAlert inline /> -
This controls the [`-node-meta`](#_node_meta) key to use when Autopilot is separating
servers into zones for redundancy. Only one server in each zone can be a voting
member at one time. If left blank (the default), this feature will be disabled.
- `disable_upgrade_migration` - (Enterprise-only)
- `disable_upgrade_migration` <EnterpriseAlert inline /> -
If set to `true`, this setting will disable Autopilot's upgrade migration strategy
in Consul Enterprise of waiting until enough newer-versioned servers have been
added to the cluster before promoting any of them to voters. Defaults to `false`.
- `upgrade_version_tag` - (Enterprise-only)
- `upgrade_version_tag` <EnterpriseAlert inline /> -
The node_meta tag to use for version info when performing upgrade migrations.
If this is not set, the Consul version will be used.
@ -1186,7 +1186,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
is enabled, the agent will attempt to re-fetch the result from the servers if
the cached value is older than this duration. See: [agent caching](/api/features/caching).
- `prefer_namespace` ((#dns_prefer_namespace)) - **(Enterprise Only)**
- `prefer_namespace` ((#dns_prefer_namespace)) <EnterpriseAlert inline /> -
When set to true, in a DNS query for a service, the label between the domain
and the `service` label will be treated as a namespace name instead of a datacenter.
When set to false, the default, the behavior will be the same as non-Enterprise
@ -1553,9 +1553,9 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
- `retry_interval_wan` Equivalent to the [`-retry-interval-wan` command-line flag](#_retry_interval_wan).
- `segment` (Enterprise-only) Equivalent to the [`-segment` command-line flag](#_segment).
- `segment` <EnterpriseAlert inline /> - Equivalent to the [`-segment` command-line flag](#_segment).
- `segments` (Enterprise-only) This is a list of nested objects
- `segments` <EnterpriseAlert inline /> - This is a list of nested objects
that allows setting the bind/advertise information for network segments. This can
only be set on servers. See the [Network Segments Guide](https://learn.hashicorp.com/consul/day-2-operations/network-segments)
for more details.

View File

@ -10,7 +10,7 @@ description: >-
# Sentinel Overview
<EnterpriseAlert product="consul" />
<EnterpriseAlert />
Consul 1.0 adds integration with [Sentinel](https://hashicorp.com/sentinel) for policy enforcement.
Sentinel policies help extend the ACL system in Consul beyond the static "read", "write", and "deny"

View File

@ -11,7 +11,7 @@ description: >
Command: `consul license`
<EnterpriseAlert product="consul" />
<EnterpriseAlert />
The `license` command provides datacenter-level management of the Consul Enterprise license. This was added in Consul 1.1.0.

View File

@ -33,7 +33,7 @@ Usage: `consul members [options]`
- `-detailed` - If provided, output shows more detailed information
about each node.
- `-segment` - (Enterprise-only) The segment to show members in. If not provided, members
- `-segment` <EnterpriseAlert inline /> - The segment to show members in. If not provided, members
in all segments visible to the agent will be listed.
- `-status` - If provided, output is filtered to only nodes matching

View File

@ -6,10 +6,10 @@ sidebar_title: create
# Consul Namespace Create
<EnterpriseAlert product="consul" />
Command: `consul namespace create`
<EnterpriseAlert />
This `namespace create` command creates a namespaces using the CLI parameters provided.
This was added in Consul Enterprise 1.7.2.

View File

@ -6,10 +6,10 @@ sidebar_title: delete
# Consul Namespace Delete
<EnterpriseAlert product="consul" />
Command: `consul namespace delete`
<EnterpriseAlert />
This `namespace delete` command deletes a namespace. This was added in Consul Enterprise 1.7.0. If
ACLs are enabled then this command will require a token with `operator:write` privileges.

View File

@ -8,10 +8,10 @@ description: |
# Consul Namespace
<EnterpriseAlert product="consul" />
Command: `consul namespace`
<EnterpriseAlert />
The `namespace` command provides management of Consul Enterprise namespaces. This was added in Consul Enterprise 1.7.0.
If ACLs are enabled then a token with operator privileges may be required in order to use this command. Write

View File

@ -6,10 +6,10 @@ sidebar_title: list
# Consul Namespace List
<EnterpriseAlert product="consul" />
Command: `consul namespace list`
<EnterpriseAlert />
This `namespace list` command lists all namespace configurations. This was added in Consul Enterprise 1.7.0. If
ACLs are enabled then this command will require a token with `operator:read` privileges or any `read` privileges
within the target namespaces. The results will be filtered based on the ACL token and therefore it is possible to

View File

@ -6,10 +6,10 @@ sidebar_title: read
# Consul Namespace Read
<EnterpriseAlert product="consul" />
Command: `consul namespace read`
<EnterpriseAlert />
This `namespace read` command reads a namespaces configuration. This was added in Consul Enterprise 1.7.0. If
ACLs are enabled then this command will require a token with `operator:read` privileges or any `read` privileges
within the target namespace.

View File

@ -6,10 +6,10 @@ sidebar_title: update
# Consul Namespace Update
<EnterpriseAlert product="consul" />
Command: `consul namespace update`
<EnterpriseAlert />
This `namespace update` command updates a namespaces using the CLI parameters provided.
This was added in Consul Enterprise 1.7.2.

View File

@ -6,10 +6,10 @@ sidebar_title: write
# Consul Namespace Write
<EnterpriseAlert product="consul" />
Command: `consul namespace write`
<EnterpriseAlert />
This `namespace write` command creates or updates a namespace's configuration from its full definition. This was added in Consul Enterprise 1.7.0.
## Usage

View File

@ -9,10 +9,10 @@ description: >
# Consul Operator Area
<EnterpriseAlert product="consul" />
Command: `consul operator area`
<EnterpriseAlert />
Consul Enterprise supports network areas, which are operator-defined relationships
between servers in two different Consul datacenters. The operator area command is used to
interact with Consul's network area subsystem.

View File

@ -81,13 +81,13 @@ Usage: `consul operator autopilot set-config [options]`
the 'healthy' state before being added to the cluster. Only takes effect if all servers are
running Raft protocol version 3 or higher. Must be a duration value such as `10s`.
- `-disable-upgrade-migration` - (Enterprise-only) Controls whether Consul will avoid promoting
- `-disable-upgrade-migration` <EnterpriseAlert inline /> - Controls whether Consul will avoid promoting
new servers until it can perform a migration. Must be one of `[true|false]`.
- `-redundancy-zone-tag`- (Enterprise-only) Controls the [`-node-meta`](/docs/agent/options#_node_meta)
- `-redundancy-zone-tag` <EnterpriseAlert inline /> - Controls the [`-node-meta`](/docs/agent/options#_node_meta)
key name used for separating servers into different redundancy zones.
- `-upgrade-version-tag` - (Enterprise-only) Controls the [`-node-meta`](/docs/agent/options#_node_meta)
- `-upgrade-version-tag` <EnterpriseAlert inline /> - Controls the [`-node-meta`](/docs/agent/options#_node_meta)
tag to use for version info when performing upgrade migrations. If left blank, the Consul version will be used.
The output looks like this:

View File

@ -43,6 +43,6 @@ Subcommands:
For more information, examples, and usage about a subcommand, click on the name
of the subcommand in the sidebar or one of the links below:
- [area](/docs/commands/operator/area)
- [area](/docs/commands/operator/area) <EnterpriseAlert inline />
- [autopilot](/docs/commands/operator/autopilot)
- [raft](/docs/commands/operator/raft)

View File

@ -8,6 +8,8 @@ sidebar_title: agent
Command: `consul snapshot agent`
<EnterpriseAlert />
~> The [`agent`](/docs/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](/docs/commands/snapshot)
@ -15,8 +17,7 @@ are available in the open source version 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
optional remote storage service. This subcommand is only available in Consul
Enterprise 0.7.1 and later.
optional remote storage service.
The agent can be run as a long-running daemon process or in a one-shot mode
from a batch job, based on the [`-interval`](#interval) argument. Snapshotting

View File

@ -38,7 +38,7 @@ Subcommands:
For more information, examples, and usage about a subcommand, click on the name
of the subcommand in the sidebar or one of the links below:
- [agent](/docs/commands/snapshot/agent) (Consul Enterprise only)
- [agent](/docs/commands/snapshot/agent) <EnterpriseAlert inline />
- [inspect](/docs/commands/snapshot/inspect)
- [restore](/docs/commands/snapshot/restore)
- [save](/docs/commands/snapshot/save)
@ -70,7 +70,7 @@ Term 2
Version 1
```
To run a daemon process that periodically saves snapshots (Consul Enterprise only):
To run a daemon process that periodically saves snapshots <EnterpriseAlert inline />
```
$ consul snapshot agent

View File

@ -10,7 +10,11 @@ description: >-
# Automated Backups
[Consul Enterprise](https://www.hashicorp.com/consul) enables you to run
<EnterpriseAlert>
This feature is available in all versions of <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>.
</EnterpriseAlert>
Consul Enterprise enables you to run
the snapshot agent within your environment as a service (Systemd as an example)
or scheduled through other means. Once running, the snapshot agent service operates as a highly
available process that integrates with the snapshot API to automatically manage

View File

@ -10,6 +10,10 @@ description: >-
# Consul Enterprise Advanced Federation
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Global Visibility, Routing, and Scale module.
</EnterpriseAlert>
Consul's core federation capability uses the same gossip mechanism that is used
for a single datacenter. This requires that every server from every datacenter
be in a fully connected mesh with an open gossip port (8302/tcp and 8302/udp)

View File

@ -7,7 +7,11 @@ description: Consul Enterprise enables data isolation with Namespaces.
# Consul Enterprise Namespaces
With [Consul Enterprise](https://www.hashicorp.com/consul) v1.7.0, data for different users or teams
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Governance and Policy module.
</EnterpriseAlert>
With Consul Enterprise v1.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,6 +9,10 @@ description: |-
# Network Segments
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Global Visibility, Routing, and Scale module.
</EnterpriseAlert>
Consul Network Segments enables operators to create separate LAN gossip segments
in one Consul cluster. Agents in a segment are only able to join and communicate
with other agents in it's network segment. This functionality is useful for

View File

@ -11,7 +11,11 @@ description: >-
# Enhanced Read Scalability with Non-Voting Servers
[Consul Enterprise](https://www.hashicorp.com/consul) provides the ability to scale clustered Consul servers
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Global Visibility, Routing, and Scale module.
</EnterpriseAlert>
Consul Enterprise provides the ability to scale clustered Consul servers
to include voting and non-voting servers. Non-voting servers still receive data from the cluster replication,
however, they do not take part in quorum election operations. Expanding your Consul cluster in this way can scale
reads without impacting write latency.

View File

@ -9,8 +9,12 @@ description: >-
# Redundancy Zones
[Consul Enterprise](https://www.hashicorp.com/consul) redundancy zones provide
both scaling and resiliancy benefits by enabling the deployment of non-voting
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Global Visibility, Routing, and Scale module.
</EnterpriseAlert>
Consul Enterprise redundancy zones provide
both scaling and resiliency benefits by enabling the deployment of non-voting
servers alongside voting servers on a per availability zone basis.
When using redundancy zones, if an operator chooses to deploy Consul across 3 availability zones, they

View File

@ -10,6 +10,10 @@ description: >-
# Sentinel in Consul
<EnterpriseAlert>
This feature requires <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a> with the Governance and Policy module.
</EnterpriseAlert>
Sentinel policies extend the ACL system in Consul beyond static "read", "write",
and "deny" policies to support full conditional logic and integration with
external systems. [Learn more about Sentinel here.](https://docs.hashicorp.com/sentinel/concepts/).

View File

@ -10,7 +10,11 @@ description: >-
# Automated Upgrades
[Consul Enterprise](https://www.hashicorp.com/consul) enables the capability of automatically upgrading a cluster of Consul servers to a new
<EnterpriseAlert>
This feature is available in all versions of <a href="https://www.hashicorp.com/products/consul/">Consul Enterprise</a>.
</EnterpriseAlert>
Consul Enterprise enables the capability of automatically upgrading a cluster of Consul servers to a new
version as updated server nodes join the cluster. This automated upgrade will spawn a process which monitors the amount of voting members
currently in a cluster. When an equal amount of new server nodes are joined running the desired version, the lower versioned servers
will be demoted to non voting members. Demotion of legacy server nodes will not occur until the voting members on the new version match.

View File

@ -72,7 +72,7 @@ and consider if they're appropriate for your deployment.
- `secretKey` ((#v-global-gossipencryption-secretkey)) (`string: ""`) - The key within the Kubernetes secret
that holds the gossip encryption key.
- `enableConsulNamespaces` ((#v-global-enableconsulnamespaces)) (`boolean: false`) - [Enterprise Only]
- `enableConsulNamespaces` ((#v-global-enableconsulnamespaces)) (`boolean: false`) <EnterpriseAlert inline /> -
`enableConsulNamespaces` indicates that you are running Consul Enterprise v1.7+ with a valid Consul
Enterprise license and would like to make use of configuration beyond registering everything into
the `default` Consul namespace. Requires consul-k8s v0.12+. Additional configuration
@ -149,7 +149,7 @@ and consider if they're appropriate for your deployment.
number of servers to wait for before performing the initial leader election and bootstrap of the cluster. This must be less than or equal to `server.replicas`. This value is only used
when bootstrapping new clusters, it has no effect during ongoing cluster maintenance.
- `enterpriseLicense` ((#v-server-enterpriselicense)) [Enterprise Only] - This value refers to a
- `enterpriseLicense` ((#v-server-enterpriselicense)) <EnterpriseAlert inline /> - This value refers to a
Kubernetes secret that you have created that contains your enterprise license. It is required if you are using an enterprise binary. Defining it here applies it to your cluster once a leader
has been elected. If you are not using an enterprise image or if you plan to
introduce the license key via another route, then set these fields to null.
@ -412,7 +412,7 @@ and consider if they're appropriate for your deployment.
type: RollingUpdate
```
- `snapshotAgent` ((#v-client-snapshotagent)) [Enterprise Only] - Values for setting up and running [snapshot agents](/docs/commands/snapshot/agent)
- `snapshotAgent` ((#v-client-snapshotagent)) <EnterpriseAlert inline /> - Values for setting up and running [snapshot agents](/docs/commands/snapshot/agent)
within the Consul clusters. They are required to be co-located with Consul clients,
so will inherit the clients' nodeSelector, tolerations and affinity.
@ -476,7 +476,7 @@ and consider if they're appropriate for your deployment.
- `k8sSourceNamespace` ((#v-synccatalog-k8ssourcenamespace)) (`string: ""`) - **[DEPRECATED] Use
`k8sAllowNamespaces` and `k8sDenyNamespaces` instead.** `k8sSourceNamespace` is the Kubernetes namespace to watch for service changes and sync to Consul. If this is not set then it will default to all namespaces.
- `consulNamespaces` ((#v-synccatalog-consulnamespaces)) - [Enterprise Only] These settings manage
- `consulNamespaces` ((#v-synccatalog-consulnamespaces)) <EnterpriseAlert inline /> - These settings manage
the catalog sync's interaction with Consul namespaces (requires consul-ent v1.7+ and consul-k8s v0.12+). Also, `global.enableConsulNamespaces` must be true.
- `consulDestinationNamespace` ((#v-synccatalog-consulnamespaces-consuldestinationnamespace)) (`string: "default"`) - Name of the Consul namespace to register all k8s
@ -601,7 +601,7 @@ and consider if they're appropriate for your deployment.
Note: `namespaceSelector` takes precedence over this since it is applied first. `kube-system` and `kube-public` are never injected. Requires consul-k8s v0.12+.
- `consulNamespaces` ((#v-connectinject-consulnamespaces)) - [Enterprise Only] These settings manage
- `consulNamespaces` ((#v-connectinject-consulnamespaces)) <EnterpriseAlert inline /> - These settings manage
the connect injector's interaction with Consul namespaces (requires consul-ent v1.7+ and consul-k8s v0.12+). Also, `global.enableConsulNamespaces` must be true.
- `consulDestinationNamespace` ((#v-connectinject-consulnamespaces-consuldestinationnamespace))