Skip to content

Commit d3a77bc

Browse files
authored
RS: Added generate_self_signed_certs.sh options table to create certificates (#1961)
* DOC-5458 RS: Added generate_self_signed_certs.sh options table to create certificates * DOC-5458 Removed duplicated option descriptions for generate_self_signed_certs.sh
1 parent a4c5bd7 commit d3a77bc

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

content/operate/rs/security/certificates/create-certificates.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ By default, the `generate_self_signed_certs.sh` script is located in `/opt/redis
2222

2323
Here, you learn how to use this script to generate new certificates and how to install them.
2424

25+
### Generate self-signed certs script options
26+
27+
You can run the `generate_self_signed_certs.sh` script with the following options:
28+
29+
| Option | Description |
30+
|----------|-------------|
31+
| `-h`<br />`--help` | Displays usage instructions. (Optional) |
32+
| `-d <days>`<br />`--days <days>` | Number of days the self-signed certificate is valid for. Setting this field longer than a year (365 days) is not recommended. (Optional, default: 365) |
33+
| `-f <names>`<br /><nobr>`--fqdnNames <names>`</nobr> | Space-separated list of [fully qualified domain names (FQDNs)](https://en.wikipedia.org/wiki/Fully_qualified_domain_name). Used for [storage area networks (SANs)](https://en.wikipedia.org/wiki/Storage_area_network). (Required)<br />Example: `-f "redis.example.com redis-1.example.com"` |
34+
| `-t <type>`<br />`--type <type>` | Type of certificate to generate. (Optional, default: all) <br />Values:<br />**cm**: Cluster Manager UI certificate<br />**api**: REST API certificate<br /> **proxy**: database endpoint proxy certificate<br />**syncer**: syncer component certificate<br />**metrics**: metrics exporter certificate<br />**all**: generates all certificate types |
35+
2536
### Step 1: Generate new certificates
2637

2738
Sign in to the machine hosting the cluster's master node and then run the following command:
@@ -31,30 +42,7 @@ Sign in to the machine hosting the cluster's master node and then run the follow
3142
-f "<DomainName1 DomainName2>" -d <Days> -t <Type>
3243
```
3344

34-
where:
35-
36-
- _\<DomainName1>_ is the fully qualified domain name (FQDN) of the cluster. (This is the name given to the cluster when first created.)
37-
- _\<DomainName2>_ is an optional FQDN for the cluster. Multiple domain names are allowed, separated by whitespace. Quotation marks (`""`) should enclose the full set of names.
38-
- _\<Days>_ is an integer specifying the number of days the certificate should be valid. We recommend against setting this longer than a year (365 days).
39-
40-
_\<Days>_ is optional and defaults to `365`.
41-
42-
- _\<Type>_ is a string identifying the name of the certificate to generate.
43-
44-
The following values are supported:
45-
46-
| Value | Description |
47-
|-------|-------------|
48-
| `api` | The REST API |
49-
| `cm` | The Cluster Manager UI |
50-
| `metrics` | The metrics exporter |
51-
| `proxy` | The database endpoint |
52-
| `syncer` | The synchronization process |
53-
| `all` | Generates all certificates in a single operation |
54-
55-
_Type_ is optional and defaults to `all`.
56-
57-
When you run the script, it either reports success (`"Self signed cert generated successfully"`) or an error message. Use the error message to troubleshoot any issues.
45+
When you run the script, it either reports success (`"Self signed cert generated successfully"`) or an error message. Use the error message to troubleshoot any issues.
5846

5947
The following example generates all self signed certificates for `mycluster.example.com`; these certificates expire one year after the command is run:
6048

0 commit comments

Comments
 (0)