Consul Admin Partition

Command: consul partition

The partition command enables you to create and manage Consul Enterprise administrative or admin partitions. Admin partitions are boundaries that allow multiple tenants to exist independently of each other on a shared set of Consul servers.

If ACLs are enabled then a token with operator privileges may be required in order to use this command.

You should only run the partition command in the primary datacenter.

Usage

consul partition <SUBCOMMAND> <OPTIONS>

Issue the consul partition -h command to view the subcommands.

Usage: consul partition <subcommand> [options] [args]

  This command has subcommands for interacting with Consul Enterprise
  admin partitions. Here are some simple examples. More detailed
  examples are available in the subcommands or the documentation.

  Create an admin partition

    $ consul partition create -name team1

  Create or Update an admin partition from its full definition:

    $ consul partition write part1

  Read an admin partition:

    $ consul partition read team1

  List all admin partitions:

    $ consul partition list

  Update an admin partition

    $ consul partition update -name team1 -description "first partition"

  Delete an admin partition:

    $ consul partition delete team1

  For more examples, ask for subcommand help or view the documentation.

Subcommands

You can issue the following subcommands with the consul partition command.

create

The create subcommand sends a request to the server to create a new admin partition. This subcommand has the following characteristics:

The admin partition is created according to the values specified in the options. You can specify the following options:

In the following example, a partition named webdev is created:

$ consul partition create -name "webdev" -description "Partition for admin of webdev services" -format json -show-meta

{
   "Name": "webdev",
   "Description": "Partition for admin of webdev services",
   "CreateIndex": 940,
   "ModifyIndex": 940
}

write

The write subcommand sends a request to the server to create a new admin partition or update an existing partition from its full definition. You can specify an admin partition definition file or use values from stdin. This subcommand has the following characteristics:

Use the following syntax to write from file:

consul partition write <OPTIONS> <FILE>

Use the following syntax to write from stdin:

consul partition write <OPTIONS> -

The definition file or stdin values can be provided in JSON or HCL format. Refer to the Admin Partition Definition section for details about the supported parameters.

You can specify the following options:

In the following example, the webdev-bu partition is written using stdin values:

$ consul partition write -format json -show-meta - <<< 'name = "webdev-bu" description = "backup webdev partition"'

{
   "Name": "webdev-bu",
   "Description": "backup webdev partition",
   "CreateIndex": 1462,
   "ModifyIndex": 1462
}

read

The read subcommand sends a request to the server to read the configuration for the specified partition and print it to the console. This subcommand has the following characteristics:

The admin partition is created according to the values specified in the options. You can specify the following options:

In the following example, the configuration for the webdev partition is read:

consul partition read -format json -meta webdev

{
   "Name": "webdev",
   "CreateIndex": 940,
   "ModifyIndex": 1458
}

list

The list subcommand prints existing admin partitions to the console. This subcommand has the following characteristics:

The admin partition is created according to the values specified in the options. You can specify the following options:

The following example lists the admin partitions and their meta data in JSON format:

$ consul partition list -format json -show-meta

[
   {
      "Name": "default",
      "Description": "Builtin Default Partition",
      "CreateIndex": 4,
      "ModifyIndex": 4
   },
   {
      "Name": "webdev",
      "CreateIndex": 940,
      "ModifyIndex": 1458
   },
   {
      "Name": "webdev-bu",
      "Description": "backup webdev partition",
      "CreateIndex": 1462,
      "ModifyIndex": 1462
   }
]

delete

The delete subcommand sends a request to the server to remove the specified partition. This subcommand has the following characteristics:

In the following example, the webdev-bu partition is deleted:

consul partition delete webdev

Admin Partition Definition

Admin partitions are managed exclusively through the HTTP API and the Consul CLI. The HTTP API accepts only JSON formatted definitions while the CLI will parse either JSON or HCL.

The following parameters are supported in admin partition definition files:

Example Definition File

The following example shows an admin partition definition file that could be used with the write command to create a partition:

Name = "dev-partition"
Description = "Partition for dev team"

HTTP API Options

You can include the following options to interact with the HTTP API when using the partition command.