Skip to content

Commit 6b06268

Browse files
committed
DOC-5210 Feedback update to clarify rladmin cluster certificate reference - divided command options into 2 sections
1 parent 2ca9844 commit 6b06268

File tree

1 file changed

+34
-15
lines changed
  • content/operate/rs/references/cli-utilities/rladmin/cluster

1 file changed

+34
-15
lines changed

content/operate/rs/references/cli-utilities/rladmin/cluster/certificate.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: Sets the cluster certificate.
8+
description: Sets cluster certificates.
99
headerRange: '[1-2]'
1010
linkTitle: certificate
1111
tags:
@@ -14,17 +14,14 @@ toc: 'true'
1414
weight: $weight
1515
---
1616

17+
## `cluster certificate set <certificate_name>`
18+
1719
Sets a cluster certificate to a specified PEM file.
1820

1921
```sh
20-
rladmin cluster certificate
21-
set { <certificate_name> | internal }
22-
[ certificate_file <filepath> ]
22+
rladmin cluster certificate set <certificate_name>
23+
certificate_file <filepath>
2324
[ key_file <filepath> ]
24-
[ cpine_certificate_file <filepath> ]
25-
[ cpine_key_file <filepath> ]
26-
[ dpine_certificate_file <filepath> ]
27-
[ dpine_key_file <filepath> ]
2825
```
2926

3027
To set a certificate for a specific service, use the corresponding certificate name. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for the list of cluster certificates and their descriptions.
@@ -33,20 +30,15 @@ To set a certificate for a specific service, use the corresponding certificate n
3330

3431
| Parameter | Type/Value | Description |
3532
|-----------|------------|-------------|
36-
| certificate_name | 'cm'<br /> 'api'<br /> 'proxy'<br /> 'syncer'<br /> 'metrics_exporter' | Name of the certificate to update |
37-
| internal | | Set up internal certificates for data plane internode encryption (DPINE) and control plane internode encryption (CPINE) |
33+
| certificate_name | 'cm'<br /> 'api'<br /> 'proxy'<br /> 'syncer'<br /> 'metrics_exporter' | Name of the certificate to update. See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) for descriptions. |
3834
| certificate_file | filepath | Path to the certificate file |
3935
| key_file | filepath | Path to the key file (optional) |
40-
| dpine_certificate_file | filepath | Path to the data plane internode encryption (DPINE) certificate file (internal certificate) |
41-
| dpine_key_file | filepath | Path to the data plane internode encryption (DPINE) key file (internal certificate) |
42-
| cpine_certificate_file | filepath | Path to the control plane internode encryption (CPINE) certificate file (internal certificate) |
43-
| cpine_key_file | filepath | Path to the control plane internode encryption (CPINE) key file (internal certificate) |
4436

4537
### Returns
4638

4739
Reports that the certificate was set to the specified file. Returns an error message if the certificate fails to update.
4840

49-
### Examples
41+
### Example
5042

5143
Update the proxy certificate:
5244

@@ -56,6 +48,33 @@ $ rladmin cluster certificate set proxy \
5648
Set proxy certificate to contents of file /tmp/proxy.pem
5749
```
5850

51+
## `cluster certificate set internal`
52+
53+
Sets [customer-provided internode encryption certificates]({{<relref "/operate/rs/security/encryption/internode-encryption#customer-provided-certificates">}}).
54+
55+
```sh
56+
rladmin cluster certificate set internal
57+
dpine_certificate_file <filepath>
58+
dpine_key_file <filepath>
59+
cpine_certificate_file <filepath>
60+
cpine_key_file <filepath>
61+
```
62+
63+
### Parameters
64+
65+
| Parameter | Type/Value | Description |
66+
|-----------|------------|-------------|
67+
| dpine_certificate_file | filepath | Path to the data plane internode encryption (DPINE) certificate file |
68+
| dpine_key_file | filepath | Path to the data plane internode encryption (DPINE) key file |
69+
| cpine_certificate_file | filepath | Path to the control plane internode encryption (CPINE) certificate file |
70+
| cpine_key_file | filepath | Path to the control plane internode encryption (CPINE) key file |
71+
72+
### Returns
73+
74+
Reports that the internal certificates were set to the specified files. Returns an error message if the certificates fail to update.
75+
76+
### Example
77+
5978
Set up [customer-provided internode encryption certificates]({{<relref "/operate/rs/security/encryption/internode-encryption#customer-provided-certificates">}}):
6079

6180
```sh

0 commit comments

Comments
 (0)