diff --git a/modules/get-started/pages/cluster-types/byoc/gcp/create-byoc-cluster-gcp.adoc b/modules/get-started/pages/cluster-types/byoc/gcp/create-byoc-cluster-gcp.adoc index e43135e4c..a2898f8a5 100644 --- a/modules/get-started/pages/cluster-types/byoc/gcp/create-byoc-cluster-gcp.adoc +++ b/modules/get-started/pages/cluster-types/byoc/gcp/create-byoc-cluster-gcp.adoc @@ -37,7 +37,7 @@ Enter a cluster name, then select the resource group, provider (GCP), xref:refer * Three availability zones provide two backups in case one availability zone goes down. ==== + -Optionally, click *Advanced settings* to specify up to five key-value custom GCP labels. If a label key starts with `gcp.network-tag.`, then the agent interprets it as a request to apply the `` https://cloud.google.com/vpc/docs/add-remove-network-tags[network tag^] to GCE instances in the cluster. Use labels for organization/metadata; use network tags to target firewall rules and routes. After the cluster is created, labels are applied to applicable GCP resources (for example, instances and disks), and network tags are applied to instances. For more information, see the https://cloud.google.com/compute/docs/labeling-resources[GCP documentation^]. After the cluster is created, you can <>. +Optionally, click *Advanced settings* to specify up to five key-value custom GCP labels. If a label key starts with `gcp.network-tag.`, then the agent interprets it as a request to apply the `` https://cloud.google.com/vpc/docs/add-remove-network-tags[network tag^] to GCE instances in the cluster. Use labels for organization/metadata; use network tags to target firewall rules and routes. After the cluster is created, labels are applied to applicable GCP resources (for example, instances and disks), and network tags are applied to instances. For more information, see the https://cloud.google.com/compute/docs/labeling-resources[GCP documentation^]. You can also <>. . Click *Next*. . On the Network page, select the connection type: either public or private. For BYOC clusters, private is best-practice. ** Your network name is used to identify this network. diff --git a/modules/get-started/partials/custom-tags-aws.adoc b/modules/get-started/partials/custom-tags-aws.adoc index 8ab5b931c..29548589e 100644 --- a/modules/get-started/partials/custom-tags-aws.adoc +++ b/modules/get-started/partials/custom-tags-aws.adoc @@ -5,7 +5,7 @@ Make sure you have: * The cluster ID. You can find this in the Redpanda Cloud UI, in the **Details** section of the cluster overview. * A valid bearer token for the Cloud Control Plane API. For details, see link:/api/doc/cloud-controlplane/authentication[Authenticate to the API]. -include::shared:partial$feature-flag.adoc[] +Then complete the following steps: . To refresh agent permissions so the Redpanda agent can update tags, run: + diff --git a/modules/get-started/partials/custom-tags-azure.adoc b/modules/get-started/partials/custom-tags-azure.adoc index 844855342..3a75bff10 100644 --- a/modules/get-started/partials/custom-tags-azure.adoc +++ b/modules/get-started/partials/custom-tags-azure.adoc @@ -5,7 +5,7 @@ Make sure you have: * The cluster ID. You can find this in the Redpanda Cloud UI, in the **Details** section of the cluster overview. * A valid bearer token for the Cloud Control Plane API. For details, see link:/api/doc/cloud-controlplane/authentication[Authenticate to the API]. -include::shared:partial$feature-flag.adoc[] +Then complete the following steps: . To refresh Redpanda agent permissions in the target subscription, run: + diff --git a/modules/get-started/partials/custom-tags-gcp.adoc b/modules/get-started/partials/custom-tags-gcp.adoc index dbd688824..f2c162b90 100644 --- a/modules/get-started/partials/custom-tags-gcp.adoc +++ b/modules/get-started/partials/custom-tags-gcp.adoc @@ -1,11 +1,34 @@ -Your organization might require custom resource labels and network tags for cost allocation, audit compliance, or governance policies. After cluster creation, you can manage this with the xref:manage:api/cloud-byoc-controlplane-api.adoc[Cloud Control Plane API]. The Control Plane API allows up to 16 custom resource labels and network tags in GCP. +Your organization might require custom resource labels and network tags for cost allocation, audit compliance, or governance policies. After cluster creation, you can manage labels and network tags on your cluster's *Dataplane settings* page in the Redpanda Cloud UI, or with the xref:manage:api/cloud-byoc-controlplane-api.adoc[Control Plane API]. + +[CAUTION] +==== +Do not add labels or network tags directly to the GCP node pools of a BYOC cluster, either in the GCP console or with commands such as `gcloud container node-pools update`. Google Kubernetes Engine (GKE) treats a node pool label or tag update as a node replacement and aggressively replaces all nodes, rather than performing a controlled rolling upgrade. This bypasses the failover process that Redpanda requires for safe node cycling. It can leave persistent volume claims (PVCs) in a pending state and may require recovering the entire cluster. + +The Dataplane settings page and the Control Plane API are the supported methods. With both, Redpanda applies labels directly to the Google Compute Engine (GCE) instances and disks in your cluster, and network tags directly to the instances. Because nothing is applied to the node pools, GKE does not replace any nodes. +==== + +=== Use the Dataplane settings page + +To manage labels and network tags in the Redpanda Cloud UI: + +. In the Redpanda Cloud UI, open your https://cloud.redpanda.com/clusters[cluster^], and click *Dataplane settings*. +. Under *Manage resource labels and network tags for your cluster*, click *Add*, and enter a key and value for each label. Keys and values are case-sensitive. ++ +To apply a network tag to the GCE instances in the cluster, use a key that starts with `gcp.network-tag.`. For example, the key `gcp.network-tag.web-servers` applies the `web-servers` https://cloud.google.com/vpc/docs/add-remove-network-tags[network tag^]. ++ +You can add up to 10 entries on this page. To manage up to 16, use the <>. +. Click *Save*. + +=== Use the Control Plane API + +The Control Plane API allows up to 16 custom resource labels and network tags in GCP. Make sure you have: * The cluster ID. You can find this in the Redpanda Cloud UI, in the **Details** section of the cluster overview. -* A valid bearer token for the Cloud Control Plane API. For details, see link:/api/doc/cloud-controlplane/authentication[Authenticate to the API]. +* A valid bearer token for the Control Plane API. For details, see link:/api/doc/cloud-controlplane/authentication[Authenticate to the API]. -include::shared:partial$feature-flag.adoc[] +Then complete the following steps: . To refresh agent permissions so the Redpanda agent can update labels and network tags, run: + @@ -24,7 +47,7 @@ This step is required because label/tag management requires additional IAM permi * `compute.disks.setLabels` * `compute.instances.setLabels` -. To update labels and network tags, invoke the Cloud API. +. To update labels and network tags, invoke the Control Plane API. + First, set your authentication token: +