RS: Support package contents

content/operate/rs/installing-upgrading/creating-support-package.md

@@ -12,15 +12,95 @@ toc: 'true'
 weight: $weight
 ---
 If you encounter any issues that you are not able to resolve yourself
-and need to [contact Redis support](https://redis.com/company/support/) for assistance, you can create a
-support package that gathers all essential information to help debug
+and need to [contact Redis support](https://redis.io/support/) for assistance, you can [create a support package](#create-support-package) that gathers all essential information to help debug
 your issues.
 
 {{< note >}}
 The process of creating the support package can take several minutes and generates load on the system.
 {{< /note >}}
 
-## Cluster Manager UI method
+## 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_<bdb_uid>` directories, where `<bdb_uid>` is the database ID, and Redis shard details in `<node_uid>` directories.
+
+The following table describes the included files:
+
+| File | Description |
+|------|-------------|
+| ccs-redis.json | Primary node's local cluster configuration store (CCS). |
+| /database_<bdb_uid>/ | Directory that includes files for a specific database.<bdb_uid> is the database ID. |
+| database_<bdb_uid>_ccs_info.txt | Database information from cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. |
+| database_<bdb_uid>.clientlist | List of clients connected to the database when the support package was created. |
+| database_<bdb_uid>.info | Redis information and statistics for the database. See [`INFO`]({{<relref "/commands/info">}}) for details about the collected fields. |
+| database_<bdb_uid>.rladmin | Database information. See [`rladmin info db`]({{<relref "/operate/rs/references/cli-utilities/rladmin/info#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_<bdb_uid>.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_<node_uid>/redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information]({{<relref "/commands/info">}}), slowlog information, and latency information. |
+
+### Node support package files
+
+Cluster and node support packages collect node details in `node_<node_uid>` directories, where `<node_uid>` 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_<node_uid>.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. |
+| node_<node_uid>_envoy_config.json | Envoy configuration. |
+| node_<node_uid>.rladmin | Information about the cluster's nodes, databases, endpoints, and shards. See [`rladmin status`]({{<relref "/operate/rs/references/cli-utilities/rladmin/status">}}) for example output. |
+| node_<node_uid>_sys_info.txt | Node's system information including:<br />• Socket files list<br />• Log files list<br />• Processes running on the node<br />• Disk usage<br />• Persistent files list<br />• Memory usage<br />• Network interfaces<br />• Installed packages<br />• Active iptables<br />• OS and platform<br />• Network connection<br />• Status of Redis processes |
+| redis_<shard_uid>.txt | For each shard of the specified database only. Includes shard configuration and [information]({{<relref "/commands/info">}}), slowlog information, and latency information. |
+
+Each node's `/conf/` directory contains the following files:
+
+- api_cert.modulus
+- api_key.modulus
+- bootstrap_status.json
+- ccs_internode_encryption_cert.modulus
+- ccs_internode_encryption_key.modulus
+- ccs-paths.conf
+- cm_cert.modulus
+- cm_key.modulus
+- config.json
+- data_internode_encryption_cert.modulus
+- data_internode_encryption_key.modulus
+- envoy.yaml
+- gossip_ca_signed_cert.modulus
+- gossip_ca_signed_key.modulus
+- gossip_envoy.yaml
+- heartbeatd-config.json
+- last_bootstrap.json
+- local_addr.conf
+- mesh_ca_signed_cert.modulus
+- mesh_ca_signed_key.modulus
+- metrics_exporter_cert.modulus
+- metrics_exporter_key.modulus
+- node.id
+- node_local_config.json
+- proxy_cert.modulus
+- proxy_key.modulus
+- 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
+- syncer_cert.modulus
+- syncer_key.modulus
+
+## Create support package
+
+### Cluster Manager UI method
 
 To create a support package from the Cluster Manager UI:
 
@@ -34,7 +114,7 @@ To create a support package from the Cluster Manager UI:
 
 1. The package is created and downloaded by your browser.
 
-## Command-line method
+### Command-line method
 
 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: 
 
@@ -66,7 +146,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
+### REST API method
 
 You can also use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages.