From 2f19f1d2627c8bcf5b4670655b22bca348b4aeb5 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Tue, 14 Oct 2025 08:55:58 +0000 Subject: [PATCH] AUTO: Sync Helm Charts docs to ScalarDB docs site repo --- .../configure-custom-values-envoy.mdx | 46 +------------------ ...nfigure-custom-values-scalardb-cluster.mdx | 23 ++-------- ...nfigure-custom-values-scalardl-auditor.mdx | 23 ++-------- ...onfigure-custom-values-scalardl-ledger.mdx | 23 ++-------- 4 files changed, 11 insertions(+), 104 deletions(-) diff --git a/versioned_docs/version-3.14/helm-charts/configure-custom-values-envoy.mdx b/versioned_docs/version-3.14/helm-charts/configure-custom-values-envoy.mdx index 57f7b0cd..e3dd2511 100644 --- a/versioned_docs/version-3.14/helm-charts/configure-custom-values-envoy.mdx +++ b/versioned_docs/version-3.14/helm-charts/configure-custom-values-envoy.mdx @@ -9,6 +9,7 @@ displayed_sidebar: docsEnglish import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import CertificateManagement from '/src/components/en-us/_certificate-management.mdx'; 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. @@ -166,50 +167,7 @@ You can enable TLS in: - Downstream connections between the client and Scalar Envoy. - Upstream connections between Scalar Envoy and Scalar products. -In addition, you have several options from the following two perspectives: - -1. Management of private key and certificate files - 1. Manage your private key and certificate files automatically by using [cert-manager](https://cert-manager.io/docs/). - - 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. - - 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/). - 1. Manage your private key and certificate files manually. - - You can issue and manage your private key and certificate files by using your preferred method on your own. - - You can use any certificate even if cert-manager does not support it. - - You must update secret resources when certificates expire. -1. Kinds of certificates - 1. Use a trusted CA (signed certificate by third party). - - You can use trusted certificates from a third-party certificate issuer. - - You can encrypt packets. - - You must pay costs to issue trusted certificates. - 1. Use self-signed certificates. - - You can reduce costs to issue certificates. - - Reliability of certificates is lower than a trusted CA, but you can encrypt packets. - -In other words, you have the following four options: - -1. Use a self-signed CA with automatic management. -1. Use a trusted CA with automatic management. -1. Use a self-signed CA with manual management. -1. Use a trusted CA with manual management. - -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: - -```mermaid -flowchart TD - A[Do you want to use
cert-manager to manage your
private key and certificate
files automatically?] - A -->|Yes, I want to manage my
certificates automatically.| B - A -->|No, I want to manage my
certificates manually by myself.| C - B[Do you want to use a
self-signed CA or a trusted CA?] - C[Do you want to use a
self-signed CA or a trusted CA?] - B -->|I want to use a
self-signed CA.| D - B -->|I want to use a
trusted CA.| E - C -->|I want to use a
self-signed CA.| F - C -->|I want to use a
trusted CA.| G - D[See the Use a self-signed
CA with cert-manager to
manage your private key and
certificate files section.] - E[See the Use a trusted
CA with cert-manager to
manage private key and
certificate files section.] - F[See the Use your private
key and certificate files
section, and use the self-signed
certificate you generated.] - G[See the Use your private key
and certificate files section,
and use the trusted certificate
generated by the third party.] -``` + #### Enable TLS in downstream connections diff --git a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardb-cluster.mdx b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardb-cluster.mdx index f4d29e79..a5715baf 100644 --- a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardb-cluster.mdx +++ b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardb-cluster.mdx @@ -7,6 +7,8 @@ displayed_sidebar: docsEnglish # Configure a custom values file for ScalarDB Cluster +import CertificateManagement from '/src/components/en-us/_certificate-management.mdx'; + 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. ## Required configurations @@ -151,26 +153,7 @@ You can enable TLS in: - The communications between the ScalarDB Cluster node and clients. - The communications between all ScalarDB Cluster nodes (the cluster's internal communications). -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). - -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: - -```mermaid -flowchart TD - A[Do you want to use
cert-manager to manage your
private key and certificate
files automatically?] - A -->|Yes, I want to manage my
certificates automatically.| B - A -->|No, I want to manage my
certificates manually by myself.| C - B[Do you want to use a
self-signed CA or a trusted CA?] - C[Do you want to use a
self-signed CA or a trusted CA?] - B -->|I want to use a
self-signed CA.| D - B -->|I want to use a
trusted CA.| E - C -->|I want to use a
self-signed CA.| F - C -->|I want to use a
trusted CA.| G - D[See the Use a self-signed
CA with cert-manager to
manage your private key and
certificate files section.] - E[See the Use a trusted
CA with cert-manager to
manage private key and
certificate files section.] - F[See the Use your private
key and certificate files
section, and use the self-signed
certificate you generated.] - G[See the Use your private key
and certificate files section,
and use the trusted certificate
generated by the third party.] -``` + #### Enable TLS diff --git a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-auditor.mdx b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-auditor.mdx index 223ec550..a045023d 100644 --- a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-auditor.mdx +++ b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-auditor.mdx @@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish # Configure a custom values file for ScalarDL Auditor +import CertificateManagement from '/src/components/en-us/_certificate-management.mdx'; + 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. ## Required configurations @@ -166,26 +168,7 @@ You can enable TLS in: - The communications between the ScalarDL Auditor and clients. - The communications between the ScalarDL Ledger and ScalarDL Auditor. -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). - -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: - -```mermaid -flowchart TD - A[Do you want to use
cert-manager to manage your
private key and certificate
files automatically?] - A -->|Yes, I want to manage my
certificates automatically.| B - A -->|No, I want to manage my
certificates manually by myself.| C - B[Do you want to use a
self-signed CA or a trusted CA?] - C[Do you want to use a
self-signed CA or a trusted CA?] - B -->|I want to use a
self-signed CA.| D - B -->|I want to use a
trusted CA.| E - C -->|I want to use a
self-signed CA.| F - C -->|I want to use a
trusted CA.| G - D[See the Use a self-signed
CA with cert-manager to
manage your private key and
certificate files section.] - E[See the Use a trusted
CA with cert-manager to
manage private key and
certificate files section.] - F[See the Use your private
key and certificate files
section, and use the self-signed
certificate you generated.] - G[See the Use your private key
and certificate files section,
and use the trusted certificate
generated by the third party.] -``` + #### Enable TLS diff --git a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-ledger.mdx b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-ledger.mdx index 0e1671da..4328f3b1 100644 --- a/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-ledger.mdx +++ b/versioned_docs/version-3.14/helm-charts/configure-custom-values-scalardl-ledger.mdx @@ -6,6 +6,8 @@ displayed_sidebar: docsEnglish # Configure a custom values file for ScalarDL Ledger +import CertificateManagement from '/src/components/en-us/_certificate-management.mdx'; + 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. ## Required configurations @@ -166,26 +168,7 @@ You can enable TLS in: - The communications between the ScalarDL Ledger and clients. - The communications between the ScalarDL Ledger and ScalarDL Auditor. -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. - -Please consider which you use based on your security requirements. According to your decision, you can see the related document as follows: - -```mermaid -flowchart TD - A[Do you want to use
cert-manager to manage your
private key and certificate
files automatically?] - A -->|Yes, I want to manage my
certificates automatically.| B - A -->|No, I want to manage my
certificates manually by myself.| C - B[Do you want to use a
self-signed CA or a trusted CA?] - C[Do you want to use a
self-signed CA or a trusted CA?] - B -->|I want to use a
self-signed CA.| D - B -->|I want to use a
trusted CA.| E - C -->|I want to use a
self-signed CA.| F - C -->|I want to use a
trusted CA.| G - D[See the Use a self-signed
CA with cert-manager to
manage your private key and
certificate files section.] - E[See the Use a trusted
CA with cert-manager to
manage private key and
certificate files section.] - F[See the Use your private
key and certificate files
section, and use the self-signed
certificate you generated.] - G[See the Use your private key
and certificate files section,
and use the trusted certificate
generated by the third party.] -``` + #### Enable TLS