diff --git a/hugo/content/en/byoc-logs/guides/query_logs_with_mcp.md b/hugo/content/en/byoc-logs/guides/query_logs_with_mcp.md index 88a99dfcc9f..9dd6691fa43 100644 --- a/hugo/content/en/byoc-logs/guides/query_logs_with_mcp.md +++ b/hugo/content/en/byoc-logs/guides/query_logs_with_mcp.md @@ -54,7 +54,7 @@ To find your BYOC Logs index name: 1. Navigate to the [Datadog Log Explorer][2]. 2. Look for the {{< ui >}}BYOC INDEXES{{< /ui >}} section in the left facet panel. -3. Your BYOC Logs indexes are listed there, in the format `byoc----`. +3. Your BYOC Logs indexes are listed there, in the format `byoc----`. You can also find your index names in the [BYOC Logs console][3] by selecting a cluster and clicking {{< ui >}}View Indexes{{< /ui >}}. @@ -106,7 +106,7 @@ When using AI-powered tools with `search_datadog_logs`, you can ask questions in ## Important notes -- The `indexes` parameter must contain valid BYOC Logs index names (in the format `byoc----`). +- The `indexes` parameter must contain valid BYOC Logs index names (in the format `byoc----`). - When using natural language queries, explicitly mention your BYOC Logs index name in your prompt. - BYOC Logs data is queryable in real-time as soon as it is indexed. - Query syntax follows standard [Datadog log search syntax][4]. diff --git a/hugo/content/en/byoc-logs/install/_index.md b/hugo/content/en/byoc-logs/install/_index.md index 0fe84487965..cb134fec568 100644 --- a/hugo/content/en/byoc-logs/install/_index.md +++ b/hugo/content/en/byoc-logs/install/_index.md @@ -19,6 +19,25 @@ BYOC (Bring Your Own Cloud) Logs requires **Kubernetes** for production deployme If you don't see the BYOC Logs entry in the Logs menu, contact your Datadog account team to activate BYOC Logs on your account. +### Cluster ID + +Set `config.cluster_id` in the BYOC Logs Helm values to a meaningful, stable identifier for the cluster. The cluster ID forms part of each BYOC Logs index name: + +``` +byoc---- +``` + +These index names appear under {{< ui >}}BYOC INDEXES{{< /ui >}} in Log Explorer and can be used in monitor and dashboard queries. + +Configure the cluster ID in the Helm values: + +```yaml +config: + cluster_id: +``` + +Changing the cluster ID after installation changes the BYOC Logs index names and can interrupt ingestion and search. To change it, follow [Rename a BYOC Logs cluster][3]. + ### Kubernetes cluster requirements | Requirement | Details | @@ -44,3 +63,4 @@ BYOC Logs supports the following object storage types: {{< /whatsnext >}} [2]: /byoc-logs/install/docker/ +[3]: /byoc-logs/operate/rename_cluster/ diff --git a/hugo/content/en/byoc-logs/install/aws_eks.md b/hugo/content/en/byoc-logs/install/aws_eks.md index 5228eec331d..b6387db896a 100644 --- a/hugo/content/en/byoc-logs/install/aws_eks.md +++ b/hugo/content/en/byoc-logs/install/aws_eks.md @@ -251,6 +251,8 @@ echo "" # BYOC Logs node configuration config: + # A meaningful, stable name that identifies the cluster in Datadog. + cluster_id: # The root URI where index data is stored. This should be an S3 path. # All indexes created in BYOC Logs are stored under this location. default_index_root_uri: s3:///indexes diff --git a/hugo/content/en/byoc-logs/install/azure_aks.md b/hugo/content/en/byoc-logs/install/azure_aks.md index af52b97b765..f513a5011bb 100644 --- a/hugo/content/en/byoc-logs/install/azure_aks.md +++ b/hugo/content/en/byoc-logs/install/azure_aks.md @@ -301,6 +301,8 @@ azure: # BYOC Logs node configuration config: + # A meaningful, stable name that identifies the cluster in Datadog. + cluster_id: # The root URI where index data is stored. This should be an Azure path. # All indexes created in BYOC Logs are stored under this location. default_index_root_uri: azure:///indexes diff --git a/hugo/content/en/byoc-logs/install/custom_k8s.md b/hugo/content/en/byoc-logs/install/custom_k8s.md index 105e22e23b3..63777c4a036 100644 --- a/hugo/content/en/byoc-logs/install/custom_k8s.md +++ b/hugo/content/en/byoc-logs/install/custom_k8s.md @@ -172,6 +172,8 @@ serviceAccount: # BYOC Logs node configuration config: + # A meaningful, stable name that identifies the cluster in Datadog. + cluster_id: # The root URI where index data is stored. This should be an S3-compatible path pointing to your MinIO bucket. # All indexes created in BYOC Logs are stored under this location. default_index_root_uri: s3:///indexes diff --git a/hugo/content/en/byoc-logs/install/gcp_gke.md b/hugo/content/en/byoc-logs/install/gcp_gke.md index 5479557003c..12e2ecb8c5b 100644 --- a/hugo/content/en/byoc-logs/install/gcp_gke.md +++ b/hugo/content/en/byoc-logs/install/gcp_gke.md @@ -276,6 +276,8 @@ serviceAccount: # BYOC Logs node configuration config: + # A meaningful, stable name that identifies the cluster in Datadog. + cluster_id: # The root URI where index data is stored. This should be an gs path. # All indexes created in BYOC Logs are stored under this location. default_index_root_uri: gs://${BUCKET_NAME}/indexes diff --git a/hugo/content/en/byoc-logs/operate/_index.md b/hugo/content/en/byoc-logs/operate/_index.md index 96a32289a44..3b20883ad82 100644 --- a/hugo/content/en/byoc-logs/operate/_index.md +++ b/hugo/content/en/byoc-logs/operate/_index.md @@ -16,6 +16,7 @@ Manage your BYOC (Bring Your Own Cloud) Logs deployment with guides on sizing, a {{< nextlink href="/byoc-logs/operate/search_logs/" >}}Search Logs{{< /nextlink >}} {{< nextlink href="/byoc-logs/operate/best_practices/" >}}Production Best Practices{{< /nextlink >}} {{< nextlink href="/byoc-logs/operate/disk_buffer_durability/" >}}Configure Disk Buffer Durability{{< /nextlink >}} + {{< nextlink href="/byoc-logs/operate/rename_cluster/" >}}Rename a Cluster{{< /nextlink >}} {{< nextlink href="/byoc-logs/operate/updates/" >}}Releases and Updates{{< /nextlink >}} {{< nextlink href="/byoc-logs/operate/troubleshooting/" >}}Troubleshooting{{< /nextlink >}} {{< /whatsnext >}} diff --git a/hugo/content/en/byoc-logs/operate/rename_cluster.md b/hugo/content/en/byoc-logs/operate/rename_cluster.md new file mode 100644 index 00000000000..31177092ff5 --- /dev/null +++ b/hugo/content/en/byoc-logs/operate/rename_cluster.md @@ -0,0 +1,85 @@ +--- +title: Rename a BYOC Logs Cluster +description: Change the cluster ID of a BYOC Logs deployment directly or with a rolling migration. +further_reading: +- link: "/byoc-logs/install/" + tag: "Documentation" + text: "Install BYOC Logs" +- link: "/byoc-logs/operate/monitoring/" + tag: "Documentation" + text: "Monitor BYOC Logs" +--- + +## Overview + +The `config.cluster_id` Helm value identifies a BYOC Logs cluster in Datadog. Changing this value restarts the cluster nodes. + +Renaming a cluster changes its BYOC Logs index names from `byoc----` to `byoc----`. Update monitors and dashboards that use the old index names. + +## Rename with downtime + +Use this procedure when temporary ingestion and search failures are acceptable. + +1. Change `config.cluster_id` in the Helm values file: + + ```yaml + config: + cluster_id: + ``` + +2. Upgrade the Helm release: + + ```shell + helm upgrade datadog/cloudprem \ + --namespace \ + --values datadog-values.yaml + ``` + +3. Wait for the rollout to finish. During the rollout, nodes with different cluster IDs cannot communicate, which can interrupt ingestion and search. +4. Verify that all pods are ready and that ingestion and search have recovered. + +## Rename gracefully + +Use `config.additional_acceptable_cluster_ids` to allow nodes with the old and new cluster IDs to communicate during the rename. Complete each rollout before starting the next one. + +After each change to the Helm values, upgrade the release with the following command: + +```shell +helm upgrade datadog/cloudprem \ + --namespace \ + --values datadog-values.yaml +``` + +1. Configure nodes with the old cluster ID to accept the new cluster ID: + + ```yaml + config: + cluster_id: + additional_acceptable_cluster_ids: + - + ``` + +2. Upgrade the Helm release and wait for the rollout to finish. +3. Change the cluster ID while retaining compatibility with the old cluster ID: + + ```yaml + config: + cluster_id: + additional_acceptable_cluster_ids: + - + ``` + +4. Upgrade the Helm release and wait for the rollout to finish. +5. Remove `additional_acceptable_cluster_ids`: + + ```yaml + config: + cluster_id: + ``` + +6. Upgrade the Helm release and wait for the rollout to finish. +7. Verify that all pods are ready and that ingestion and search remain available. + +## Further reading + +{{< partial name="whats-next/whats-next.html" >}} diff --git a/hugo/content/en/byoc-logs/operate/search_logs.md b/hugo/content/en/byoc-logs/operate/search_logs.md index fff326dad3c..d71a95fbf33 100644 --- a/hugo/content/en/byoc-logs/operate/search_logs.md +++ b/hugo/content/en/byoc-logs/operate/search_logs.md @@ -25,7 +25,7 @@ You can select a specific index to narrow your search, or select all indexes in BYOC (Bring Your Own Cloud) Logs index names follow this format: ``` -byoc---- +byoc---- ``` ## Search limitations diff --git a/hugo/content/en/byoc-logs/quickstart.md b/hugo/content/en/byoc-logs/quickstart.md index a7eb53e1dd0..1b3a51d3c0a 100644 --- a/hugo/content/en/byoc-logs/quickstart.md +++ b/hugo/content/en/byoc-logs/quickstart.md @@ -47,8 +47,6 @@ docker run -d \ In Datadog, go to the [BYOC Logs console][4] and check that your cluster is connected. You should see the `connected` status. -In the BYOC Logs console, you can edit the cluster metadata and rename your cluster to `demo`. - {{< img src="/cloudprem/quickstart/clouprem_console.png" alt="Screenshot of the BYOC Logs console showing the cluster connected status" style="width:100%;" >}} ## Step 3: Send a log