Skip to content

Commit e1e1606

Browse files
RS: Support package contents (#203)
* DOC-3478 Support package contents * A few edits * Update content/operate/rs/installing-upgrading/creating-support-package.md Co-authored-by: David Dougherty <[email protected]> * DOC-3478 Feedback update to separate key & cert modulus files from other file types --------- Co-authored-by: David Dougherty <[email protected]>
1 parent e855778 commit e1e1606

File tree

1 file changed

+88
-5
lines changed

1 file changed

+88
-5
lines changed

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

Lines changed: 88 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,98 @@ toc: 'true'
1212
weight: $weight
1313
---
1414
If you encounter any issues that you are not able to resolve yourself
15-
and need to [contact Redis support](https://redis.com/company/support/) for assistance, you can create a
16-
support package that gathers all essential information to help debug
15+
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
1716
your issues.
1817

1918
{{< note >}}
2019
The process of creating the support package can take several minutes and generates load on the system.
2120
{{< /note >}}
2221

23-
## Cluster Manager UI method
22+
## Support package files
23+
24+
The support package is a zip file that contains all cluster configuration and logs.
25+
26+
When downloaded from the Cluster Manager UI, the support package's name is `debuginfo.tar.gz`.
27+
28+
### Database support package files
29+
30+
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.
31+
32+
The following table describes the included files:
33+
34+
| File | Description |
35+
|------|-------------|
36+
| ccs-redis.json | Primary node's local cluster configuration store (CCS). |
37+
| /database_<bdb_uid>/ | Directory that includes files for a specific database.<bdb_uid> is the database ID. |
38+
| database_<bdb_uid>_ccs_info.txt | Database information from the cluster configuration store (CCS). Includes settings for databases, endpoints, shards, replicas, and CRDB. |
39+
| database_<bdb_uid>.clientlist | List of clients connected to the database when the support package was created. |
40+
| database_<bdb_uid>.info | Redis information and statistics for the database. See [`INFO`]({{<relref "/commands/info">}}) for details about the collected fields. |
41+
| 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. |
42+
| 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. |
43+
| /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. |
44+
45+
### Node support package files
46+
47+
Cluster and node support packages collect node details in `node_<node_uid>` directories, where `<node_uid>` is the node ID.
48+
49+
The following table describes the included files:
50+
51+
| File | Description |
52+
|------|-------------|
53+
| ccs-redis.json | The node's local cluster configuration store (CCS). |
54+
| /conf/ | Directory that contains configuration files. |
55+
| /logs/ | Directory that includes logs. |
56+
| node_<node_uid>.ccs | Includes cluster configuration, node configuration, and DMC proxy configuration. |
57+
| node_<node_uid>_envoy_config.json | Envoy configuration. |
58+
| 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. |
59+
| 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 |
60+
| 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. |
61+
62+
Each node's `/conf/` directory contains the following files:
63+
64+
- bootstrap_status.json
65+
- ccs-paths.conf
66+
- config.json
67+
- envoy.yaml
68+
- gossip_envoy.yaml
69+
- heartbeatd-config.json
70+
- last_bootstrap.json
71+
- local_addr.conf
72+
- node.id
73+
- node_local_config.json
74+
- redislabs_env_config.sh
75+
- socket.conf
76+
- supervisord_alert_mgr.conf
77+
- supervisord_cm_server.conf
78+
- supervisord_crdb_coordinator.conf
79+
- supervisord_crdb_worker.conf
80+
- supervisord_mdns_server.conf
81+
- supervisord_pdns_server.conf
82+
83+
Each node's `/conf/` directory also contains the following key and cert modulus files:
84+
85+
- api_cert.modulus
86+
- api_key.modulus
87+
- ccs_internode_encryption_cert.modulus
88+
- ccs_internode_encryption_key.modulus
89+
- cm_cert.modulus
90+
- cm_key.modulus
91+
- data_internode_encryption_cert.modulus
92+
- data_internode_encryption_key.modulus
93+
- gossip_ca_signed_cert.modulus
94+
- gossip_ca_signed_key.modulus
95+
- mesh_ca_signed_cert.modulus
96+
- mesh_ca_signed_key.modulus
97+
- metrics_exporter_cert.modulus
98+
- metrics_exporter_key.modulus
99+
- proxy_cert.modulus
100+
- proxy_key.modulus
101+
- syncer_cert.modulus
102+
- syncer_key.modulus
103+
104+
## Create support package
105+
106+
### Cluster Manager UI method
24107

25108
To create a support package from the Cluster Manager UI:
26109

@@ -34,7 +117,7 @@ To create a support package from the Cluster Manager UI:
34117

35118
1. The package is created and downloaded by your browser.
36119

37-
## Command-line method
120+
### Command-line method
38121

39122
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:
40123

@@ -66,7 +149,7 @@ If package creation fails with `internal error` or if you cannot access the UI,
66149

67150
Upload the tar file to [Redis support](https://redis.com/company/support/). The path to the archive is shown in the command output.
68151

69-
## REST API method
152+
### REST API method
70153

71154
You can also use `debuginfo` [REST API]({{< relref "/operate/rs/references/rest-api" >}}) requests to create and download support packages.
72155

0 commit comments

Comments
 (0)