From ac646f31e88bb8d660b41f03faa926fc4ef69d95 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Tue, 28 Oct 2025 14:50:37 -0500 Subject: [PATCH 1/4] DOC-5866 RS: Reordered support package sections --- .../creating-support-package.md | 183 +++++++++--------- 1 file changed, 94 insertions(+), 89 deletions(-) diff --git a/content/operate/rs/installing-upgrading/creating-support-package.md b/content/operate/rs/installing-upgrading/creating-support-package.md index 452e6e6158..3e38c96c95 100644 --- a/content/operate/rs/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/installing-upgrading/creating-support-package.md @@ -19,97 +19,18 @@ your issues. The process of creating the support package can take several minutes and generates load on the system. {{< /note >}} -## Support package files - -The support package is a zip file that contains all cluster configuration and logs. - -When downloaded from the Cluster Manager UI, the support package's name is `debuginfo.tar.gz`. - -### Database support package files - -Cluster and database support packages collect database details in `database_` directories, where `` is the database ID, and Redis shard details in `` directories. - -The following table describes the included files: - -| File | Description | -|------|-------------| -| ccs-redis.json | Primary node's local cluster configuration store (CCS). | -| /database_/ | Directory that includes files for a specific database. is the database ID. | -| database__ccs_info.txt | Database information from the cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. | -| database_.clientlist | List of clients connected to the database when the support package was created. | -| database_.info | Redis information and statistics for the database. See [`INFO`]({{}}) for details about the collected fields. | -| database_.rladmin | Database information. See [`rladmin info db`]({{}}) for an example of collected fields. Also includes creation time, last changed time, Redis version, memory limit, persistence type, eviction policy, hashing policy, and whether SSL, backups, and email alerts are enabled. | -| database_.slowlog | Contains slowlog output, which includes commands that took longer than 10 milliseconds. Only included if `slowlog_in_sanitized_support` is `true` in cluster settings. | -| /node_/redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | - -### Node support package files - -Cluster and node support packages collect node details in `node_` directories, where `` is the node ID. - -The following table describes the included files: - -| File | Description | -|------|-------------| -| ccs-redis.json | The node's local cluster configuration store (CCS). | -| /conf/ | Directory that contains configuration files. | -| /logs/ | Directory that includes logs. | -| node_.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. | -| node__envoy_config.json | Envoy configuration. | -| node_.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`]({{}}) for example output. | -| node__sys_info.txt | Node's system information including:
• Socket files list
• Log files list
• Processes running on the node
• Disk usage
• Persistent files list
• Memory usage
• Network interfaces
• Installed packages
• Active iptables
• OS and platform
• Network connection
• Status of Redis processes | -| redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | - -Each node's `/conf/` directory contains the following files: - -- bootstrap_status.json -- ccs-paths.conf -- config.json -- envoy.yaml -- gossip_envoy.yaml -- heartbeatd-config.json -- last_bootstrap.json -- local_addr.conf -- node.id -- node_local_config.json -- redislabs_env_config.sh -- socket.conf -- supervisord_alert_mgr.conf -- supervisord_cm_server.conf -- supervisord_crdb_coordinator.conf -- supervisord_crdb_worker.conf -- supervisord_mdns_server.conf -- supervisord_pdns_server.conf - -Each node's `/conf/` directory also contains the following key and cert modulus files: - -- api_cert.modulus -- api_key.modulus -- ccs_internode_encryption_cert.modulus -- ccs_internode_encryption_key.modulus -- cm_cert.modulus -- cm_key.modulus -- data_internode_encryption_cert.modulus -- data_internode_encryption_key.modulus -- gossip_ca_signed_cert.modulus -- gossip_ca_signed_key.modulus -- mesh_ca_signed_cert.modulus -- mesh_ca_signed_key.modulus -- metrics_exporter_cert.modulus -- metrics_exporter_key.modulus -- proxy_cert.modulus -- proxy_key.modulus -- syncer_cert.modulus -- syncer_key.modulus - ## Create support package -### Cluster Manager UI method +{{< multitabs id="create-support-package" +tab1="Cluster Manager UI" +tab2="rladmin" +tab3="REST API" >}} To create a support package from the Cluster Manager UI: 1. In the navigation menu, select **Support**. - {{Select Support from the navigation menu and create a support package.}} + Select Support from the navigation menu and create a support package. 1. Click **Proceed**. @@ -123,7 +44,7 @@ To create a support package from the Cluster Manager UI: - Select a specific database from the **Database name (Database ID)** list to include information about that database only. - {{The list of databases you can include in the support package.}} + The list of databases you can include in the support package. - **For Nodes**: Creates a support package that includes node information. @@ -131,15 +52,15 @@ To create a support package from the Cluster Manager UI: - Select a specific node from the **Node ID (IP Addresses)** list to include information about that node only. - {{The list of nodes you can include in the support package.}} + The list of nodes you can include in the support package. 1. Click **Generate package**. 1. The package is created and downloaded by your browser. - {{An alert appears that says, 'Support package created, attach it to your request in the Redis Support portal'. The Redis Support portal is a button you can click to contact Redis Support.}} + An alert appears that says, 'Support package created, attach it to your request in the Redis Support portal'. The Redis Support portal is a button you can click to contact Redis Support. -### Command-line method +-tab-sep- If package creation fails with `internal error` or if you cannot access the UI, create a support package for the cluster from the command line on any node in the cluster using the [`rladmin cluster debug_info`]({{< relref "/operate/rs/references/cli-utilities/rladmin/cluster/debug_info" >}}) command: @@ -171,7 +92,7 @@ If package creation fails with `internal error` or if you cannot access the UI, Upload the tar file to [Redis support](https://redis.com/company/support/). The path to the archive is shown in the command output. -### REST API method +-tab-sep- You can also use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages. @@ -204,3 +125,87 @@ To download debug info from a specific database, replace `` in the followin ```sh GET /v1/bdbs//debuginfo ``` + +{{< /multitabs >}} + +## Support package files + +The support package is a zip file that contains all cluster configuration and logs. + +When downloaded from the Cluster Manager UI, the support package's name is `debuginfo.tar.gz`. + +### Database support package files + +Cluster and database support packages collect database details in `database_` directories, where `` is the database ID, and Redis shard details in `` directories. + +The following table describes the included files: + +| File | Description | +|------|-------------| +| ccs-redis.json | Primary node's local cluster configuration store (CCS). | +| /database_/ | Directory that includes files for a specific database. is the database ID. | +| database__ccs_info.txt | Database information from the cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. | +| database_.clientlist | List of clients connected to the database when the support package was created. | +| database_.info | Redis information and statistics for the database. See [`INFO`]({{}}) for details about the collected fields. | +| database_.rladmin | Database information. See [`rladmin info db`]({{}}) for an example of collected fields. Also includes creation time, last changed time, Redis version, memory limit, persistence type, eviction policy, hashing policy, and whether SSL, backups, and email alerts are enabled. | +| database_.slowlog | Contains slowlog output, which includes commands that took longer than 10 milliseconds. Only included if `slowlog_in_sanitized_support` is `true` in cluster settings. | +| /node_/redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | + +### Node support package files + +Cluster and node support packages collect node details in `node_` directories, where `` is the node ID. + +The following table describes the included files: + +| File | Description | +|------|-------------| +| ccs-redis.json | The node's local cluster configuration store (CCS). | +| /conf/ | Directory that contains configuration files. | +| /logs/ | Directory that includes logs. | +| node_.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. | +| node__envoy_config.json | Envoy configuration. | +| node_.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`]({{}}) for example output. | +| node__sys_info.txt | Node's system information including:
• Socket files list
• Log files list
• Processes running on the node
• Disk usage
• Persistent files list
• Memory usage
• Network interfaces
• Installed packages
• Active iptables
• OS and platform
• Network connection
• Status of Redis processes | +| redis_.txt | For each shard of the specified database only. Includes shard configuration and [information]({{}}), slowlog information, and latency information. | + +Each node's `/conf/` directory contains the following files: + +- bootstrap_status.json +- ccs-paths.conf +- config.json +- envoy.yaml +- gossip_envoy.yaml +- heartbeatd-config.json +- last_bootstrap.json +- local_addr.conf +- node.id +- node_local_config.json +- redislabs_env_config.sh +- socket.conf +- supervisord_alert_mgr.conf +- supervisord_cm_server.conf +- supervisord_crdb_coordinator.conf +- supervisord_crdb_worker.conf +- supervisord_mdns_server.conf +- supervisord_pdns_server.conf + +Each node's `/conf/` directory also contains the following key and cert modulus files: + +- api_cert.modulus +- api_key.modulus +- ccs_internode_encryption_cert.modulus +- ccs_internode_encryption_key.modulus +- cm_cert.modulus +- cm_key.modulus +- data_internode_encryption_cert.modulus +- data_internode_encryption_key.modulus +- gossip_ca_signed_cert.modulus +- gossip_ca_signed_key.modulus +- mesh_ca_signed_cert.modulus +- mesh_ca_signed_key.modulus +- metrics_exporter_cert.modulus +- metrics_exporter_key.modulus +- proxy_cert.modulus +- proxy_key.modulus +- syncer_cert.modulus +- syncer_key.modulus From 0dc43c3222355c5b212fe5b030a728c636b188e3 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Tue, 28 Oct 2025 15:08:11 -0500 Subject: [PATCH 2/4] DOC-5866 Fixed img src paths for multitab --- .../rs/installing-upgrading/creating-support-package.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/operate/rs/installing-upgrading/creating-support-package.md b/content/operate/rs/installing-upgrading/creating-support-package.md index 3e38c96c95..251c72cd7d 100644 --- a/content/operate/rs/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/installing-upgrading/creating-support-package.md @@ -30,7 +30,7 @@ To create a support package from the Cluster Manager UI: 1. In the navigation menu, select **Support**. - Select Support from the navigation menu and create a support package. + Select Support from the navigation menu and create a support package. 1. Click **Proceed**. @@ -52,13 +52,13 @@ To create a support package from the Cluster Manager UI: - Select a specific node from the **Node ID (IP Addresses)** list to include information about that node only. - The list of nodes you can include in the support package. + The list of nodes you can include in the support package. 1. Click **Generate package**. 1. The package is created and downloaded by your browser. - An alert appears that says, 'Support package created, attach it to your request in the Redis Support portal'. The Redis Support portal is a button you can click to contact Redis Support. + An alert appears that says, 'Support package created, attach it to your request in the Redis Support portal'. The Redis Support portal is a button you can click to contact Redis Support. -tab-sep- From b12a659be36ec6ffdd0cd17760bab9e7148db263 Mon Sep 17 00:00:00 2001 From: Rachel Elledge Date: Tue, 28 Oct 2025 15:20:19 -0500 Subject: [PATCH 3/4] DOC-5866 Added links to support package knowledge base article --- .../rs/installing-upgrading/creating-support-package.md | 4 ++++ content/operate/rs/troubleshooting.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/content/operate/rs/installing-upgrading/creating-support-package.md b/content/operate/rs/installing-upgrading/creating-support-package.md index 251c72cd7d..130122ecb0 100644 --- a/content/operate/rs/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/installing-upgrading/creating-support-package.md @@ -209,3 +209,7 @@ Each node's `/conf/` directory also contains the following key and cert modulus - proxy_key.modulus - syncer_cert.modulus - syncer_key.modulus + +## Related info + +- [Uploading Support Packages & Cluster Health Analysis](https://support.redislabs.com/hc/en-us/articles/26502436628370-Uploading-Support-Packages-Cluster-Health-Analysis) diff --git a/content/operate/rs/troubleshooting.md b/content/operate/rs/troubleshooting.md index 2a5640863d..7b96e646a9 100644 --- a/content/operate/rs/troubleshooting.md +++ b/content/operate/rs/troubleshooting.md @@ -40,6 +40,8 @@ For troubleshooting specific issues, see: The [Redis Software knowledge base](https://support.redislabs.com/hc/en-us/categories/26174244088594-Redis-Software) provides additional guides and troubleshooting resources. +- [Uploading Support Packages & Cluster Health Analysis](https://support.redislabs.com/hc/en-us/articles/26502436628370-Uploading-Support-Packages-Cluster-Health-Analysis) + - [Tools for Identifying Failures in Clusters](https://support.redislabs.com/hc/en-us/articles/26759137301394-Tools-for-Identifying-Failures-in-Clusters) - [Troubleshooting TLS Failures](https://support.redislabs.com/hc/en-us/articles/26867190871314-Troubleshooting-TLS-Failures) From aea55c69f765803dff8dd2cf414b42ed22b00d91 Mon Sep 17 00:00:00 2001 From: Rachel Elledge <86307637+rrelledge@users.noreply.github.com> Date: Tue, 28 Oct 2025 15:37:58 -0500 Subject: [PATCH 4/4] Update content/operate/rs/installing-upgrading/creating-support-package.md Co-authored-by: Cameron Bates <102550101+cmilesb@users.noreply.github.com> --- .../operate/rs/installing-upgrading/creating-support-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/operate/rs/installing-upgrading/creating-support-package.md b/content/operate/rs/installing-upgrading/creating-support-package.md index 130122ecb0..9d6f63ed34 100644 --- a/content/operate/rs/installing-upgrading/creating-support-package.md +++ b/content/operate/rs/installing-upgrading/creating-support-package.md @@ -94,7 +94,7 @@ Upload the tar file to [Redis support](https://redis.com/company/support/). The -tab-sep- -You can also use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages. +You can use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages. To download debug info from all nodes and databases: