Skip to content

Commit 5380da1

Browse files
committed
DOC-5458 Removed duplicated option descriptions for generate_self_signed_certs.sh
1 parent 67f7f49 commit 5380da1

File tree

1 file changed

+2
-25
lines changed

1 file changed

+2
-25
lines changed

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

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can run the `generate_self_signed_certs.sh` script with the following option
2929
| Option | Description |
3030
|----------|-------------|
3131
| `-h`<br />`--help` | Displays usage instructions. (Optional) |
32-
| `-d <days>`<br />`--days <days>` | Number of days the self-signed certificate is valid for. (Optional, default: 365) |
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) |
3333
| `-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"` |
3434
| `-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 |
3535

@@ -42,30 +42,7 @@ Sign in to the machine hosting the cluster's master node and then run the follow
4242
-f "<DomainName1 DomainName2>" -d <Days> -t <Type>
4343
```
4444

45-
where:
46-
47-
- _\<DomainName1>_ is the fully qualified domain name (FQDN) of the cluster. (This is the name given to the cluster when first created.)
48-
- _\<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.
49-
- _\<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).
50-
51-
_\<Days>_ is optional and defaults to `365`.
52-
53-
- _\<Type>_ is a string identifying the name of the certificate to generate.
54-
55-
The following values are supported:
56-
57-
| Value | Description |
58-
|-------|-------------|
59-
| `api` | The REST API |
60-
| `cm` | The Cluster Manager UI |
61-
| `metrics` | The metrics exporter |
62-
| `proxy` | The database endpoint |
63-
| `syncer` | The synchronization process |
64-
| `all` | Generates all certificates in a single operation |
65-
66-
_Type_ is optional and defaults to `all`.
67-
68-
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.
6946

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

0 commit comments

Comments
 (0)