Skip to content

Commit 7e01d3f

Browse files
AUTO: Sync Helm Charts docs to ScalarDB docs site repo (#1577)
Co-authored-by: josh-wong <joshua.wong@scalar-labs.com>
1 parent a59a159 commit 7e01d3f

File tree

4 files changed

+11
-104
lines changed

4 files changed

+11
-104
lines changed

versioned_docs/version-3.13/helm-charts/configure-custom-values-envoy.mdx

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ displayed_sidebar: docsEnglish
99

1010
import Tabs from '@theme/Tabs';
1111
import TabItem from '@theme/TabItem';
12+
import CertificateManagement from '/src/components/en-us/_certificate-management.mdx';
1213

1314
This document explains how to create your custom values file for the Scalar Envoy chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/envoy/README.md) of the Scalar Envoy chart.
1415

@@ -166,50 +167,7 @@ You can enable TLS in:
166167
- Downstream connections between the client and Scalar Envoy.
167168
- Upstream connections between Scalar Envoy and Scalar products.
168169

169-
In addition, you have several options from the following two perspectives:
170-
171-
1. Management of private key and certificate files
172-
1. Manage your private key and certificate files automatically by using [cert-manager](https://cert-manager.io/docs/).
173-
- You can reduce maintenance or operation costs. For example, cert-manager automatically renews certificates before they expire and Scalar Helm Chart automatically mounts private key and certificate files on the Scalar product pods.
174-
- You cannot use a CA that cert-manager does not support. You can see the supported issuer in the [cert-manager documentation](https://cert-manager.io/docs/configuration/issuers/).
175-
1. Manage your private key and certificate files manually.
176-
- You can issue and manage your private key and certificate files by using your preferred method on your own.
177-
- You can use any certificate even if cert-manager does not support it.
178-
- You must update secret resources when certificates expire.
179-
1. Kinds of certificates
180-
1. Use a trusted CA (signed certificate by third party).
181-
- You can use trusted certificates from a third-party certificate issuer.
182-
- You can encrypt packets.
183-
- You must pay costs to issue trusted certificates.
184-
1. Use self-signed certificates.
185-
- You can reduce costs to issue certificates.
186-
- Reliability of certificates is lower than a trusted CA, but you can encrypt packets.
187-
188-
In other words, you have the following four options:
189-
190-
1. Use a self-signed CA with automatic management.
191-
1. Use a trusted CA with automatic management.
192-
1. Use a self-signed CA with manual management.
193-
1. Use a trusted CA with manual management.
194-
195-
You should consider which method you use based on your security requirements. For guidance and related documentation for each method, refer to the following decision tree:
196-
197-
```mermaid
198-
flowchart TD
199-
A[Do you want to use <br /><a href='https://cert-manager.io/docs/'>cert-manager</a> to manage your <br />private key and certificate <br />files automatically?]
200-
A -->|Yes, I want to manage my <br />certificates automatically.| B
201-
A -->|No, I want to manage my <br />certificates manually by myself.| C
202-
B[Do you want to use a <br />self-signed CA or a trusted CA?]
203-
C[Do you want to use a <br />self-signed CA or a trusted CA?]
204-
B -->|I want to use a <br />self-signed CA.| D
205-
B -->|I want to use a <br />trusted CA.| E
206-
C -->|I want to use a <br />self-signed CA.| F
207-
C -->|I want to use a <br />trusted CA.| G
208-
D[See the <a href='#use-a-self-signed-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a self-signed <br />CA with cert-manager to <br />manage your private key and <br />certificate files</a> section.]
209-
E[See the <a href='#use-a-trusted-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a trusted <br />CA with cert-manager to <br />manage private key and <br />certificate files</a> section.]
210-
F[See the <a href='#use-your-private-key-and-certificate-files'>Use your private <br />key and certificate files</a> <br />section, and use the self-signed <br />certificate you generated.]
211-
G[See the <a href='#use-your-private-key-and-certificate-files'>Use your private key <br />and certificate files</a> section, <br />and use the trusted certificate <br />generated by the third party.]
212-
```
170+
<CertificateManagement />
213171

214172
#### Enable TLS in downstream connections
215173

versioned_docs/version-3.13/helm-charts/configure-custom-values-scalardb-cluster.mdx

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ displayed_sidebar: docsEnglish
77

88
# Configure a custom values file for ScalarDB Cluster
99

10+
import CertificateManagement from '/src/components/en-us/_certificate-management.mdx';
11+
1012
This document explains how to create your custom values file for the ScalarDB Cluster chart. For details on the parameters, see the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-cluster/README.md) of the ScalarDB Cluster chart.
1113

1214
## Required configurations
@@ -151,26 +153,7 @@ You can enable TLS in:
151153
- The communications between the ScalarDB Cluster node and clients.
152154
- The communications between all ScalarDB Cluster nodes (the cluster's internal communications).
153155

154-
In addition, you have several options for certificate management. For more details, see [TLS configurations for Envoy](./configure-custom-values-envoy.mdx#tls-configurations-optional-based-on-your-environment).
155-
156-
You should consider which method you use based on your security requirements. For guidance and related documentation for each method, refer to the following decision tree:
157-
158-
```mermaid
159-
flowchart TD
160-
A[Do you want to use <br /><a href='https://cert-manager.io/docs/'>cert-manager</a> to manage your <br />private key and certificate <br />files automatically?]
161-
A -->|Yes, I want to manage my <br />certificates automatically.| B
162-
A -->|No, I want to manage my <br />certificates manually by myself.| C
163-
B[Do you want to use a <br />self-signed CA or a trusted CA?]
164-
C[Do you want to use a <br />self-signed CA or a trusted CA?]
165-
B -->|I want to use a <br />self-signed CA.| D
166-
B -->|I want to use a <br />trusted CA.| E
167-
C -->|I want to use a <br />self-signed CA.| F
168-
C -->|I want to use a <br />trusted CA.| G
169-
D[See the <a href='#use-a-self-signed-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a self-signed <br />CA with cert-manager to <br />manage your private key and <br />certificate files</a> section.]
170-
E[See the <a href='#use-a-trusted-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a trusted <br />CA with cert-manager to <br />manage private key and <br />certificate files</a> section.]
171-
F[See the <a href='#use-your-private-key-and-certificate-files'>Use your private <br />key and certificate files</a> <br />section, and use the self-signed <br />certificate you generated.]
172-
G[See the <a href='#use-your-private-key-and-certificate-files'>Use your private key <br />and certificate files</a> section, <br />and use the trusted certificate <br />generated by the third party.]
173-
```
156+
<CertificateManagement />
174157

175158
#### Enable TLS
176159

versioned_docs/version-3.13/helm-charts/configure-custom-values-scalardl-auditor.mdx

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish
66

77
# Configure a custom values file for ScalarDL Auditor
88

9+
import CertificateManagement from '/src/components/en-us/_certificate-management.mdx';
10+
911
This document explains how to create your custom values file for the ScalarDL Auditor chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl-audit/README.md) of the ScalarDL Auditor chart.
1012

1113
## Required configurations
@@ -166,26 +168,7 @@ You can enable TLS in:
166168
- The communications between the ScalarDL Auditor and clients.
167169
- The communications between the ScalarDL Ledger and ScalarDL Auditor.
168170

169-
In addition, you have several options for certificate management. For more details, see [TLS configurations for Envoy](./configure-custom-values-envoy.mdx#tls-configurations-optional-based-on-your-environment).
170-
171-
You should consider which method you use based on your security requirements. For guidance and related documentation for each method, refer to the following decision tree:
172-
173-
```mermaid
174-
flowchart TD
175-
A[Do you want to use <br /><a href='https://cert-manager.io/docs/'>cert-manager</a> to manage your <br />private key and certificate <br />files automatically?]
176-
A -->|Yes, I want to manage my <br />certificates automatically.| B
177-
A -->|No, I want to manage my <br />certificates manually by myself.| C
178-
B[Do you want to use a <br />self-signed CA or a trusted CA?]
179-
C[Do you want to use a <br />self-signed CA or a trusted CA?]
180-
B -->|I want to use a <br />self-signed CA.| D
181-
B -->|I want to use a <br />trusted CA.| E
182-
C -->|I want to use a <br />self-signed CA.| F
183-
C -->|I want to use a <br />trusted CA.| G
184-
D[See the <a href='#use-a-self-signed-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a self-signed <br />CA with cert-manager to <br />manage your private key and <br />certificate files</a> section.]
185-
E[See the <a href='#use-a-trusted-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a trusted <br />CA with cert-manager to <br />manage private key and <br />certificate files</a> section.]
186-
F[See the <a href='#use-your-private-key-and-certificate-files'>Use your private <br />key and certificate files</a> <br />section, and use the self-signed <br />certificate you generated.]
187-
G[See the <a href='#use-your-private-key-and-certificate-files'>Use your private key <br />and certificate files</a> section, <br />and use the trusted certificate <br />generated by the third party.]
188-
```
171+
<CertificateManagement />
189172

190173
#### Enable TLS
191174

versioned_docs/version-3.13/helm-charts/configure-custom-values-scalardl-ledger.mdx

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish
66

77
# Configure a custom values file for ScalarDL Ledger
88

9+
import CertificateManagement from '/src/components/en-us/_certificate-management.mdx';
10+
911
This document explains how to create your custom values file for the ScalarDL Ledger chart. If you want to know the details of the parameters, please refer to the [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl/README.md) of the ScalarDL Ledger chart.
1012

1113
## Required configurations
@@ -166,26 +168,7 @@ You can enable TLS in:
166168
- The communications between the ScalarDL Ledger and clients.
167169
- The communications between the ScalarDL Ledger and ScalarDL Auditor.
168170

169-
Also, you have several options from the certificate management. See [TLS configurations on the Envoy document side](./configure-custom-values-envoy.mdx#tls-configurations-optional-based-on-your-environment) for more details.
170-
171-
Please consider which you use based on your security requirements. According to your decision, you can see the related document as follows:
172-
173-
```mermaid
174-
flowchart TD
175-
A[Do you want to use <br /><a href='https://cert-manager.io/docs/'>cert-manager</a> to manage your <br />private key and certificate <br />files automatically?]
176-
A -->|Yes, I want to manage my <br />certificates automatically.| B
177-
A -->|No, I want to manage my <br />certificates manually by myself.| C
178-
B[Do you want to use a <br />self-signed CA or a trusted CA?]
179-
C[Do you want to use a <br />self-signed CA or a trusted CA?]
180-
B -->|I want to use a <br />self-signed CA.| D
181-
B -->|I want to use a <br />trusted CA.| E
182-
C -->|I want to use a <br />self-signed CA.| F
183-
C -->|I want to use a <br />trusted CA.| G
184-
D[See the <a href='#use-a-self-signed-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a self-signed <br />CA with cert-manager to <br />manage your private key and <br />certificate files</a> section.]
185-
E[See the <a href='#use-a-trusted-ca-with-cert-manager-to-manage-your-private-key-and-certificate-files'>Use a trusted <br />CA with cert-manager to <br />manage private key and <br />certificate files</a> section.]
186-
F[See the <a href='#use-your-private-key-and-certificate-files'>Use your private <br />key and certificate files</a> <br />section, and use the self-signed <br />certificate you generated.]
187-
G[See the <a href='#use-your-private-key-and-certificate-files'>Use your private key <br />and certificate files</a> section, <br />and use the trusted certificate <br />generated by the third party.]
188-
```
171+
<CertificateManagement />
189172

190173
#### Enable TLS
191174

0 commit comments

Comments
 (0)