NET-1825: New ACL token creation docs

website/content/docs/security/acl/tokens/create/create-a-mesh-gateway-token.mdx

@@ -0,0 +1,364 @@
+---
+layout: docs
+page_title: Create a token for mesh gateway registration
+description: >-
+  Learn how to create ACL tokens that your mesh gateway can present to Consul servers so that they can register with the Consul catalog.
+---
+
+# Create a mesh gateway token
+
+This topic describes how to create a token to enable a mesh gateway to register.
+
+## Introduction
+
+Gateways must present a token linked to policies that grant the appropriate set of permissions. For a mesh gateway to be discoverable and to route to other services in a mesh, the token must be linked to policies that grant the following permissions:
+
+* `mesh:write` to obtain leaf certificates for terminating TLS connections
+* `peering:read` for Consul cluster peering. If you are not using Consul cluster peering, then you can omit the `peering:read` permission.
+* `service:write` to allow the mesh gateway to register into the catalog
+* `service:read` for all services and `node:read` for all nodes in order to discover and route to services
+* `agent:read` to enable the `consul connect envoy` CLI command to automatically discover gRPC settings from the Consul agent. If this command is not used to start the gateway or if the Consul agent uses the default gRPC settings, then you can omit the `agent:read` permission.
+
+@include 'create-token-requirements.mdx'
+
+## Create a token linked to a policy
+
+To create a token for the mesh gateway, you must define a policy, register the policy with Consul, and link the policy to a token.
+
+### Define a custom policy
+
+You can send custom policy definitions as command line or API arguments or define them in an external HCL or JSON file. The following example policies are externally defined policies. Refer to [ACL Rules](/consul/docs/security/acl/acl-rules) for details about all of the rules you can use in your policies.
+
+#### Consul OSS
+
+The following example policy grants the mesh gateway the appropriate permissions for the mesh gateway to register as a service named `mesh-gateway`.
+
+<CodeTabs>
+
+```hcl
+mesh = "write"
+peering = "read"
+service "mesh-gateway" {
+   policy = "write"
+}
+service_prefix "" {
+   policy = "read"
+}
+node_prefix "" {
+   policy = "read"
+}
+agent_prefix "" {
+   policy = "read"
+}
+```
+
+```json
+{
+  "mesh": "write",
+  "peering": "read",
+  "service": {
+    "mesh-gateway": [{
+      "policy": "write"
+    }]
+  },
+  "service_prefix": {
+    "": [{
+      "policy": "read"
+    }]
+  },
+  "node_prefix": {
+    "": [{
+      "policy": "read"
+    }]
+  },
+  "agent_prefix": {
+    "": [{
+      "policy": "read"
+    }]
+  }
+}
+```
+
+</CodeTabs>
+
+
+#### Consul Enterprise using `default` partition
+
+You can specify an admin partition and namespace when using Consul Enterprise. Mesh gateways must register into the `default` namespace. The following policy allows a mesh gateway to register as a service named `mesh-gateway` in the default partition.
+
+<CodeTabs>
+
+```hcl
+mesh = "write"
+peering = "read"
+partition_prefix "" {
+  peering = "read"
+}
+namespace "default" {
+  service "mesh-gateway" {
+     policy = "write"
+  }
+  agent_prefix "" {
+     policy = "read"
+  }
+}
+namespace_prefix "" {
+  node_prefix "" {
+  	policy = "read"
+  }
+  service_prefix "" {
+     policy = "read"
+  }
+}
+```
+
+```json
+{
+  "mesh": "write",
+  "peering": "read",
+  "partition_prefix": {
+    "": [{
+      "peering": "read"
+    }]
+  },
+  "namespace": {
+    "default": [{
+      "agent_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      },
+      "service": {
+        "mesh-gateway": [{
+          "policy": "write"
+        }]
+      }
+    }]
+  },
+  "namespace_prefix": {
+    "": [{
+      "node_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      },
+      "service_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      }
+    }]
+  }
+}
+```
+
+</CodeTabs>
+
+
+#### Consul Enterprise using non-`default` partition
+
+You can specify an admin partition and namespace when using Consul Enterprise. Mesh gateways must register into the `default` namespace. To register a mesh gateway in a non-default partition, create the ACL policy and token in the partition where the mesh gateway registers. The following ACL policy rules allow a mesh gateway to register as the `mesh-gateway` service in a non-default partition.
+
+<CodeTabs>
+
+```hcl
+mesh = "write"
+peering = "read"
+namespace "default" {
+  service "mesh-gateway" {
+     policy = "write"
+  }
+  agent_prefix "" {
+     policy = "read"
+  }
+}
+namespace_prefix "" {
+  node_prefix "" {
+  	policy = "read"
+  }
+  service_prefix "" {
+     policy = "read"
+  }
+}
+```
+
+```json
+{
+  "mesh": "write",
+  "peering": "read",
+  "namespace": {
+    "default": [{
+      "agent_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      },
+      "service": {
+        "mesh-gateway": [{
+          "policy": "write"
+        }]
+      }
+    }]
+  },
+  "namespace_prefix": {
+    "": [{
+      "node_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      },
+      "service_prefix": {
+        "": [{
+          "policy": "read"
+        }]
+      }
+    }]
+  }
+}
+```
+
+</CodeTabs>
+
+
+### Register the policy with Consul
+
+After defining the policy, you can register the policy with Consul using the command line or API endpoint.
+
+The following commands create the ACL policy and token.
+
+#### CLI
+
+Run the `consul acl policy create` command and specify the policy rules to create a policy. The following example registers a custom policy defined in `mgw-register.hcl`:
+
+##### Consul OSS
+
+```shell-session
+$ consul acl policy create \
+    -name "mgw-register" -rules @mgw-register.hcl \
+    -description "Mesh gateway policy"
+```
+
+##### Consul Enterprise
+
+You can specify an admin partition when creating policies in Consul Enterprise. The policy is only valid in the specified admin partition. You must create the policy in the partition where the mesh gateway registers. The following example creates the policy in the partition `ptn1`.
+
+```shell-session
+consul acl policy create \
+  -name mgw-register -rules @mgw-register.hcl \
+  -description "Mesh gateway policy" \
+  -partition ptn1
+```
+
+Refer to [Consul ACL Policy Create](/consul/commands/acl/policy/create) for details about the `consul acl policy create` command.
+
+#### API
+
+Send a PUT request to the `/acl/policy` endpoint and specify the policy rules in the request body to create a policy. The following example registers the custom policy defined in `mgw-register.hcl`. You must embed policy rules in the `Rules` field of the request body.
+
+##### Consul OSS
+
+
+```shell-session
+$ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
+  –-header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
+  --data '{
+  "Name": "mgw-register",
+  "Description": "Mesh gateway policy",
+  "Rules": "mesh = \"write\"\npeering = \"read\"\nservice \"mesh-gateway\" {\n   policy = \"write\"\n}\nservice_prefix \"\" {\n   policy = \"read\"\n}\nnode_prefix \"\" {\n   policy = \"read\"\n}\nagent_prefix \"\" {\n   policy = \"read\"\n}\n"
+}'
+```
+
+##### Consul Enterprise (Default Partition)
+
+
+```shell-session
+$ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
+  –-header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
+  --data '{
+  "Name": "mgw-register",
+  "Description": "Mesh gateway policy",
+  "Partition": "default",
+  "Rules": "mesh = \"write\"\npeering = \"read\"\npartition_prefix \"\" {\n  peering = \"read\"\n}\nnamespace \"default\" {\n  service \"mesh-gateway\" {\n     policy = \"write\"\n  }\n  agent_prefix \"\" {\n     policy = \"read\"\n  }\n}\nnamespace_prefix \"\" {\n  node_prefix \"\" {\n  \tpolicy = \"read\"\n  }\n  service_prefix \"\" {\n     policy = \"read\"\n  }\n}\n"
+}'
+```
+
+##### Consul Enterprise (Non-default Partition)
+
+```shell-session
+$ curl --request PUT http://127.0.0.1:8500/v1/acl/policy \
+  –-header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
+  --data '{
+  "Name": "mgw-register",
+  "Description": "Mesh gateway policy",
+  "Partition": "ptn1",
+  "Rules": "mesh = \"write\"\npeering = \"read\"\nnamespace \"default\" {\n  service \"mesh-gateway\" {\n     policy = \"write\"\n  }\n  agent_prefix \"\" {\n     policy = \"read\"\n  }\n}\nnamespace_prefix \"\" {\n  node_prefix \"\" {\n  \tpolicy = \"read\"\n  }\n  service_prefix \"\" {\n     policy = \"read\"\n  }\n}\n"
+}'
+```
+
+Refer to [ACL Policy HTTP API](/consul/api-docs/acl/policies) for additional information about using the API endpoint.
+
+### Link the policy to a token
+
+After registering the policy into Consul, you can create and link tokens using the Consul command line or API endpoint. You can also enable Consul to dynamically create tokens from trusted external systems using an auth method.
+
+#### CLI
+
+Run the `consul acl token create` command and specify the policy name or ID to create a token linked to the policy. Refer to [Consul ACL Token Create](/consul/commands/acl/token/create) for details about the `consul acl token create` command.
+
+##### Consul OSS
+
+The following command creates the ACL token linked to the policy `mgw-register`.
+
+```shell-session
+$ consul acl token create \
+    -description "Mesh gateway token" \
+    -policy-name "mgw-register"
+```
+
+##### Consul Enterprise
+
+You can specify an admin partition when creating tokens in Consul Enterprise. The token is only valid in the specified admin partition. The token must be created in the partition where the mesh gateway registers. The following example creates the token in the partition `ptn1`.
+
+```shell-session
+$ consul acl token create -partition ptn1 \
+    -description "Mesh gateway token" \
+    -policy-name "mgw-register"
+```
+
+#### API
+
+Send a PUT request to the `/acl/token` endpoint and specify the policy name or ID in the request to create an ACL token linked to the policy. Refer to [ACL Token HTTP API](/consul/api-docs/acl/tokens) for additional information about using the API endpoint.
+
+##### Consul OSS
+
+
+```shell-session
+$ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
+  –-header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
+  --data '{
+  "Policies": [
+    {
+      "Name": "mgw-register"
+    }
+  ]
+}'
+```
+
+##### Consul Enterprise
+
+You can specify an admin partition when creating tokens in Consul Enterprise. The token is only valid in the specified admin partition. The token must be created in the partition where the mesh gateway registers. The following example creates the token in the partition `ptn1`.
+
+```shell-session
+$ curl --request PUT http://127.0.0.1:8500/v1/acl/token \
+  –-header "X-Consul-Token: $CONSUL_HTTP_TOKEN" \
+  --data '{
+  "Policies": [
+    {
+      "Name": "mgw-register"
+    }
+  ],
+  "Partition": "ptn1"
+}'
+```
+
+@include 'create-token-auth-methods.mdx'