HashiConf 2024 Now streaming live from Boston! Attend for free
Consul
Consul Home

You are viewing documentation for version v1.19.x. View latest version.

Consul Namespace Update

Command: consul namespace update

Corresponding HTTP API Endpoint: [PUT] /v1/namespace/:name

Enterprise

This feature requires Consul Enterprise(opens in new tab).

This namespace update command updates a namespaces using the CLI parameters provided. This was added in Consul Enterprise 1.7.2.

The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.

ACL Required
operator:write

Usage

Usage: consul namespace update -name <namespace name> [options]

Request a namespace to be update. Construction of the namespace definition is handled by this command from the CLI arguments. Some parts of the Namespace such as ACL configurations and meta can be merged with the existing namespace definition.

Command Options

  • -default-policy-id=<value> - ID of a policy from the default namespace to inject for all tokens in this namespace. May be specified multiple times. The ACL token used with this command must have acl:write access to the linked policy.

  • -default-policy-name=<value> - Name of a policy from the default namespace to inject for all tokens in this namespace. May be specified multiple times. The ACL token used with this command must have acl:write access to the linked policy.

  • -default-role-id=<value> - ID of a role from the default namespace to inject for all tokens in this namespace. May be specified multiple times. The ACL token used with this command must have acl:write access to the linked role.

  • -default-role-name=<value> - Name of a role from the default namespace to inject for all tokens in this namespace. May be specified multiple times. The ACL token used with this command must have acl:write access to the linked role.

  • -description=<string> - A description of the namespace.

  • -format=<string> - How to output the results. The choices are: pretty or json

  • -merge-acls - Merge the new ACL policies and roles with the existing values.

  • -merge-meta - Merge new meta values with existing meta.

  • -meta=<value> - Metadata to set on the namespace, formatted as key=value. This flag may be specified multiple times to set multiple meta fields

  • -name=<string> - The namespace's name. This flag is required.

  • -show-meta - Indicates that namespace metadata such as the raft indices should be shown for the namespace

API Options

  • -partition=<string> - Enterprise Specifies the partition to query. If not provided, the partition is inferred from the request's ACL token, or defaults to the default partition.

  • -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

  • -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

  • -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

  • -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

  • -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

  • -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

  • -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

  • -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

  • -datacenter=<name> - Name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent at the HTTP address.

  • -stale - Permit any Consul server (non-leader) to respond to this request. This allows for lower latency and higher throughput, but can result in stale data. This option has no effect on non-read operations. The default value is false.

Examples

Update a namespace with a new description:

$ consul namespace update -name "team-1" -description "example description"
Name: team-1
Description:
   example description

Showing Raft Metadata:

$ consul namespace update -name team-1 -show-meta -default-policy-id 1206bf1c-6239-46e8-b9f8-b426667cf428
Name: team-1
ACLs:
   Default Policies:
      1206bf1c-6239-46e8-b9f8-b426667cf428 / team1-universal-policy
Create Index: 339
Modify Index: 344

JSON Format:

$ consul namespace update -name team2 -description "Example Namespace" -meta "external-source=kubernetes" -format=json
{
   "Name": "team2",
   "Description": "Example Namespace",
   "Meta": {
      "external-source": "kubernetes"
   },
   "CreateIndex": 352,
   "ModifyIndex": 352
}