diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-envoy.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-envoy.mdx index 635a29f3..5bb4ae66 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-envoy.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-envoy.mdx @@ -2,29 +2,30 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- +# Scalar Envoy のカスタム値ファイルを構成する + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Scalar Envoy のカスタム値ファイルを構成する - -このドキュメントでは、Scalar Envoy チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、Scalar Envoy チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/envoy/README.md) を参照してください。 +このドキュメントでは、Scalar Envoy チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、Scalar Envoy チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/envoy/README.md) を参照してください。 ## Scalar Envoy チャートのカスタム値を構成する -Scalar Envoy チャートは他のチャート (scalardb、scalardb-cluster、scalardl、scalardl-audit) 経由で使用されるため、Scalar Envoy チャートのカスタム値ファイルを作成する必要はありません。 Scalar Envoy を設定したい場合は、`envoy.*` 設定を他のチャートに追加する必要があります。 +Scalar Envoy チャートは他のチャート (scalardb、scalardb-cluster、scalardl、scalardl-audit) 経由で使用されるため、Scalar Envoy チャートのカスタム値ファイルを作成する必要はありません。Scalar Envoy を設定したい場合は、`envoy.*` 設定を他のチャートに追加する必要があります。 たとえば、ScalarDB Server 用に Scalar Envoy を構成する場合は、次のように ScalarDB のカスタム値ファイルでいくつかの Scalar Envoy 構成を構成できます。 * 例 (scalardb-custom-values.yaml) ```yaml envoy: - configurationsForScalarEnvoy: + configurationsForScalarEnvoy: ... - + scalardb: - configurationsForScalarDB: + configurationsForScalarDB: ... ``` @@ -32,9 +33,9 @@ Scalar Envoy チャートは他のチャート (scalardb、scalardb-cluster、sc ### サービス構成 -Kubernetes のサービス リソース タイプを指定するには、`envoy.service.type` を設定する必要があります。 +Kubernetes のサービスリソースタイプを指定するには、`envoy.service.type` を設定する必要があります。 -Kubernetes クラスターの内部からのみクライアント リクエストを受け入れる場合 (たとえば、クライアント アプリケーションを Scalar 製品と同じ Kubernetes クラスターにデプロイする場合)、`envoy.service.type` を `ClusterIP` に設定できます。 この構成では、クラウド サービス プロバイダーが提供するロード バランサーは作成されません。 +Kubernetes クラスターの内部からのみクライアントリクエストを受け入れる場合 (たとえば、クライアントアプリケーションを Scalar 製品と同じ Kubernetes クラスターにデプロイする場合)、`envoy.service.type` を `ClusterIP` に設定できます。この構成では、クラウドサービスプロバイダーが提供するロードバランサーは作成されません。 ```yaml envoy: @@ -42,7 +43,7 @@ envoy: type: ClusterIP ``` -クラウド サービス プロバイダーが提供するロード バランサーを使用して、Kubernetes クラスターの外部からのクライアント リクエストを受け入れる場合は、`envoy.service.type` を `LoadBalancer` に設定する必要があります。 +クラウドサービスプロバイダーが提供するロードバランサーを使用して、Kubernetes クラスターの外部からのクライアントリクエストを受け入れる場合は、`envoy.service.type` を `LoadBalancer` に設定する必要があります。 ```yaml envoy: @@ -65,9 +66,9 @@ envoy: ### リソース構成 (本番環境で推奨) -Kubernetes のリクエストと制限を使用してポッド リソースを制御したい場合は、`envoy.resources` を使用できます。 +Kubernetes のリクエストと制限を使用してポッドリソースを制御したい場合は、`envoy.resources` を使用できます。 -これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。 そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml envoy: @@ -84,7 +85,7 @@ envoy: Kubernetes のアフィニティと反アフィニティを使用してポッドのデプロイメントを制御したい場合は、`envoy.affinity` を使用できます。 -Kubernetes のアフィニティと同じ構文を使用して構成できます。 そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティと同じ構文を使用して構成できます。そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml envoy: @@ -108,7 +109,7 @@ envoy: ### Prometheus および Grafana 構成 (実稼働環境で推奨) -[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して Scalar Envoy ポッドを監視する場合は、`envoy.grafanaDashboard.enabled`、`envoy.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。 `envoy.prometheusRule.enabled` と `envoy.prometheusRule.enabled`。 +[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して Scalar Envoy ポッドを監視する場合は、`envoy.grafanaDashboard.enabled`、`envoy.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。`envoy.prometheusRule.enabled` と `envoy.prometheusRule.enabled`。 ```yaml envoy: @@ -128,7 +129,7 @@ envoy: Scalar Envoy ポッドに SecurityContext と PodSecurityContext を設定する場合は、`envoy.securityContext` と `envoy.podSecurityContext` を使用できます。 -KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。 したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +Kubernetes の SecurityContext や PodSecurityContext と同じ構文を使用して設定できます。したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml envoy: @@ -145,7 +146,7 @@ envoy: ### 画像構成 (デフォルト値を推奨) -イメージ リポジトリとバージョンを変更したい場合は、`envoy.image.repository` を使用して、プルする Scalar Envoy コンテナ イメージのコンテナ リポジトリ情報を指定できます。 +イメージリポジトリとバージョンを変更したい場合は、`envoy.image.repository` を使用して、プルする Scalar Envoy コンテナイメージのコンテナリポジトリ情報を指定できます。 ```yaml envoy: @@ -165,7 +166,7 @@ AWS または Azure を使用している場合、詳細については次のド - クライアントと Scalar Envoy 間のダウンストリーム接続。 - Scalar Envoy と Scalar 製品間のアップストリーム接続。 -さらに、次の 2 つの観点からいくつかのオプションがあります。 +さらに、次の2つの観点からいくつかのオプションがあります。 1. 秘密鍵と証明書ファイルの管理 1. [cert-manager](https://cert-manager.io/docs/) を使用して秘密鍵と証明書ファイルを自動的に管理します。 @@ -174,7 +175,7 @@ AWS または Azure を使用している場合、詳細については次のド 1. 秘密鍵と証明書ファイルを手動で管理します。 - ご自身のお好みの方法で、秘密鍵と証明書ファイルを発行・管理することができます。 - cert-manager がサポートしていない場合でも、任意の証明書を使用できます。 - - 証明書の有効期限が切れた場合は、シークレット リソースを更新する必要があります。 + - 証明書の有効期限が切れた場合は、シークレットリソースを更新する必要があります。 1. 証明書の種類 1. 信頼できる CA (サードパーティによる署名付き証明書) を使用します。 - サードパーティの証明書発行者からの信頼できる証明書を使用できます。 @@ -184,7 +185,7 @@ AWS または Azure を使用している場合、詳細については次のド - 証明書発行にかかるコストを削減できます。 - 証明書の信頼性は信頼できる CA よりも低くなりますが、パケットを暗号化できます。 -つまり、次の 4 つのオプションがあります。 +つまり、次の4つのオプションがあります。 1. 自動管理で自己署名 CA を使用します。 1. 自動管理で信頼できる CA を使用します。 @@ -241,7 +242,7 @@ kubectl create secret generic envoy-tls-cert --from-file=tls.crt=/ -n ``` -秘密鍵と証明書ファイルの準備方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルの作成方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx) を参照してください。 +秘密鍵と証明書ファイルの準備方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルの作成方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx)を参照してください。 ##### cert-manager で信頼できる CA を使用して秘密鍵と証明書ファイルを管理する @@ -250,8 +251,8 @@ kubectl create secret generic envoy-tls-key --from-file=tls.key=/ @@ -353,11 +354,11 @@ envoy: -秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品のキーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx) を参照してください。 +秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品のキーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx)を参照してください。 ##### TLS通信のカスタム権限を設定する -`envoy.tls.upstream.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、使用している製品に応じて、`scalardbCluster.tls.certChainSecret`、`ledger.tls.certChainSecret`、または `auditor.tls.certChainSecret` を使用して設定した証明書チェーン ファイルに示されているホスト名を指定できます。Envoy はこの値を使用して、ScalarDB Cluster または ScalarDL との TLS 接続の証明書を検証します。 +`envoy.tls.upstream.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、使用している製品に応じて、`scalardbCluster.tls.certChainSecret`、`ledger.tls.certChainSecret`、または `auditor.tls.certChainSecret` を使用して設定した証明書チェーンファイルに示されているホスト名を指定できます。Envoy はこの値を使用して、ScalarDB Cluster または ScalarDL との TLS 接続の証明書を検証します。 ```yaml envoy: @@ -380,7 +381,7 @@ envoy: Kubernetes のテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`envoy.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml envoy: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-file.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-file.mdx index 459392dc..b2ddeb0c 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-file.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-file.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # Scalar Helm Charts のカスタム値ファイルを構成する @@ -10,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -Scalar Helm Chart を使用して Scalar 製品をデプロイする場合は、環境に基づいてカスタム値ファイルを準備する必要があります。 各製品のカスタム値ファイルの作成方法の詳細については、次のドキュメントを参照してください。 +Scalar Helm Chart を使用して Scalar 製品をデプロイする場合は、環境に基づいてカスタム値ファイルを準備する必要があります。各製品のカスタム値ファイルの作成方法の詳細については、次のドキュメントを参照してください。 * [ScalarDB Cluster](configure-custom-values-scalardb-cluster.mdx) * [ScalarDB Analytics with PostgreSQL](configure-custom-values-scalardb-analytics-postgresql.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-admin-for-kubernetes.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-admin-for-kubernetes.mdx index 0327f4e1..a25f7733 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-admin-for-kubernetes.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-admin-for-kubernetes.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # Scalar Admin for Kubernetes のカスタム値ファイルを構成する @@ -10,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Admin for Kubernetes チャートのカスタム値ファイルを作成する方法について説明します。 パラメーターの詳細については、Scalar Admin for Kubernetes チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-admin-for-kubernetes/README.md) を参照してください。 +このドキュメントでは、Scalar Admin for Kubernetes チャートのカスタム値ファイルを作成する方法について説明します。パラメーターの詳細については、Scalar Admin for Kubernetes チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-admin-for-kubernetes/README.md) を参照してください。 ## 必要な構成 @@ -18,7 +19,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; ### フラグ設定 -Scalar Admin for Kubernetes を実行するには、配列として `scalarAdminForKubernetes.commandArgs` にいくつかのフラグを指定する必要があります。 フラグの詳細については、Scalar Admin for Kubernetes の [README](https://github.com/scalar-labs/scalar-admin-for-kubernetes/blob/main/README.md) を参照してください。 +Scalar Admin for Kubernetes を実行するには、配列として `scalarAdminForKubernetes.commandArgs` にいくつかのオプションを指定する必要があります。オプションの詳細については、Scalar Admin for Kubernetes の [README](https://github.com/scalar-labs/scalar-admin-for-kubernetes/blob/main/README.md) を参照してください。 ```yaml scalarAdminForKubernetes: @@ -39,7 +40,7 @@ scalarAdminForKubernetes: ### CronJob 構成 (環境に応じてオプション) -デフォルトでは、Scalar Admin for Kubernetes チャートは、Scalar Admin for Kubernetes CLI ツールを 1 回実行するための [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) リソースを作成します。 [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/) を使用して Scalar Admin for Kubernetes CLI ツールを定期的に実行する場合は、`scalarAdminForKubernetes.jobType` を `cronjob` に設定できます。 また、CronJob リソースのいくつかの構成を設定することもできます。 +デフォルトでは、Scalar Admin for Kubernetes チャートは、Scalar Admin for Kubernetes CLI ツールを1回実行するための [Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) リソースを作成します。[CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/) を使用して Scalar Admin for Kubernetes CLI ツールを定期的に実行する場合は、`scalarAdminForKubernetes.jobType` を `cronjob` に設定できます。また、CronJob リソースのいくつかの構成を設定することもできます。 ```yaml scalarAdminForKubernetes: @@ -50,9 +51,9 @@ scalarAdminForKubernetes: ### リソース構成 (実稼働環境で推奨) -Kubernetes でリクエストと制限を使用してポッド リソースを制御するには、`scalarAdminForKubernetes.resources` を使用できます。 +Kubernetes でリクエストと制限を使用してポッドリソースを制御するには、`scalarAdminForKubernetes.resources` を使用できます。 -Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。 Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml scalarAdminForKubernetes: @@ -69,7 +70,7 @@ scalarAdminForKubernetes: Scalar Admin for Kubernetes ポッドの SecurityContext と PodSecurityContext を設定するには、`scalarAdminForKubernetes.securityContext` と `scalarAdminForKubernetes.podSecurityContext` を使用できます。 -Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。 Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml scalarAdminForKubernetes: @@ -86,7 +87,7 @@ scalarAdminForKubernetes: ### 画像構成 (デフォルト値を推奨) -イメージ リポジトリを変更する場合は、`scalarAdminForKubernetes.image.repository` を使用して、プルする Scalar Admin for Kubernetes イメージのコンテナ リポジトリ情報を指定できます。 +イメージリポジトリを変更する場合は、`scalarAdminForKubernetes.image.repository` を使用して、プルする Scalar Admin for Kubernetes イメージのコンテナリポジトリ情報を指定できます。 ```yaml scalarAdminForKubernetes: @@ -98,7 +99,7 @@ scalarAdminForKubernetes: Kubernetes のテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`scalarAdminForKubernetes.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml scalarAdminForKubernetes: @@ -124,7 +125,7 @@ scalarAdminForKubernetes: - cluster.scalardb.example.com ``` -シークレットリソースを使用して、`/tls/certs/ca.crt` ファイルをポッドにマウントできます。 `scalarAdminForKubernetes.tls.caRootCertSecret` にルート CA 証明書ファイルを含むシークレットリソースの名前を指定してください。 +シークレットリソースを使用して、`/tls/certs/ca.crt` ファイルをポッドにマウントできます。`scalarAdminForKubernetes.tls.caRootCertSecret` にルート CA 証明書ファイルを含むシークレットリソースの名前を指定してください。 ```yaml scalarAdminForKubernetes: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-manager.mdx index 02db429c..94eb109d 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalar-manager.mdx @@ -1,6 +1,7 @@ --- tags: - Enterprise Option +displayed_sidebar: docsJapanese --- # Scalar Manager のカスタム値ファイルを構成する @@ -9,28 +10,28 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Manager チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、Scalar Manager チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-manager/README.md) を参照してください。 +このドキュメントでは、Scalar Manager チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、Scalar Manager チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalar-manager/README.md) を参照してください。 ## 必要な構成 ### サービス構成 -Kubernetes のサービスリソースタイプを指定するには、`service.type` を設定する必要があります。 プロバイダーが提供するロードバランサーを使用する場合は、`service.type`を`LoadBalancer`に設定する必要があります。 +Kubernetes のサービスリソースタイプを指定するには、`service.type` を設定する必要があります。プロバイダーが提供するロードバランサーを使用する場合は、`service.type` を `LoadBalancer` に設定する必要があります。 ```yaml service: type: LoadBalancer ``` -#### Scalar Managerの公開に関するセキュリティ上の懸念 +#### Scalar Manager の公開に関するセキュリティ上の懸念 -`service.type`を`LoadBalancer`に設定すると、Scalar Managerがクラスター外に公開されるため、セキュリティ上の懸念が生じる可能性があります。 +`service.type` を `LoadBalancer` に設定すると、Scalar Manager がクラスター外に公開されるため、セキュリティ上の懸念が生じる可能性があります。 -現在、Scalar Managerには認証やアクセス制御のメカニズムがありません。 -このため、適切なセキュリティ対策なしにScalar Managerを直接パブリックネットワークに公開すると、不正なアクションにつながる可能性があります。 -これは、Scalar Managerが Scalar製品の一時停止ジョブのスケジューリングなどの機能を提供しているためです。 +現在、Scalar Manager には認証やアクセス制御のメカニズムがありません。 +このため、適切なセキュリティ対策なしに Scalar Manager を直接パブリックネットワークに公開すると、不正なアクションにつながる可能性があります。 +これは、Scalar Manager が Scalar 製品の一時停止ジョブのスケジューリングなどの機能を提供しているためです。 -外部アクセスが必要な場合は、プライベートネットワークを使用するか、Kubernetesクラスターへのネットワークアクセスを適切に設定することをお勧めします。 +外部アクセスが必要な場合は、プライベートネットワークを使用するか、Kubernetes クラスターへのネットワークアクセスを適切に設定することをお勧めします。 ### 画像構成 @@ -48,8 +49,8 @@ web: ## オプション設定 このセクションでは、Scalar Manager用のカスタム値ファイルを設定する際のオプション設定について説明します。 -### Scalar Manager設定（環境に応じてオプション） -`api.applicationProperties`カスタム値を上書きして、Scalar Managerのデフォルト設定を変更できます。 +### Scalar Manager 設定 (環境に応じてオプション) +`api.applicationProperties` カスタム値を上書きして、Scalar Managerのデフォルト設定を変更できます。 ```yaml api: @@ -62,40 +63,40 @@ api: Scalar Managerには、例えばScalar製品のデプロイメントやクラスター内のPrometheusおよびLokiサービスを検出するためのデフォルト設定があります。 ほとんどのユースケースでは、特にkube-prometheus-stackのデプロイガイドやloki-stackのデプロイガイドに従っている場合、デフォルト設定を変更する必要はありません。 -#### api.applicationPropertiesで設定できるプロパティ +#### api.applicationProperties で設定できるプロパティ -Scalar Managerの設定は、Javaアプリケーションプロパティの形式で、key=valueのペアです。 -これらのアプリケーションプロパティは、Scalar Manager Helm Chartのapi.applicationPropertiesカスタム値を使用して設定できます。 +Scalar Manager の設定は、Java アプリケーションプロパティの形式で、key=valueのペアです。 +これらのアプリケーションプロパティは、Scalar Manager Helm Chart の api.applicationProperties カスタム値を使用して設定できます。 |名前|説明|デフォルト値| |---|---|---| -|`grafana.kubernetesServiceLabelName`|KubernetesでGrafanaサービスを検出するために使用されるラベル名|`app.kubernetes.io/name`| -|`grafana.kubernetesServiceLabelValue`|`grafana.kubernetesServiceLabelName`に対応するラベル値|`grafana`| -|`grafana.kubernetesServicePortName`|KubernetesでGrafanaサービスポートを検出するために使用されるポート名|`http-web`| -|`prometheus.kubernetesServiceLabelName`|KubernetesでPrometheusサービスを検出するために使用されるラベル名|`app`| -|`prometheus.kubernetesServiceLabelValue`|`prometheus.kubernetesServiceLabelName`に対応するラベル値|`kube-prometheus-stack-prometheus`| -|`prometheus.kubernetesServicePortName`|KubernetesでPrometheusサービスポートを検出するために使用されるポート名|`http-web`| -|`loki.kubernetesServiceLabelName`|KubernetesでPrometheusサービスを検出するために使用されるラベル名|`app`| -|`loki.kubernetesServiceLabelValue`|`loki.kubernetesServiceLabelName`に対応するラベル値|`loki`| -|`loki.kubernetesServicePortName`|KubernetesでLokiサービスポートを検出するために使用されるポート名|`http-metrics`| -|`helm.scalarRepositoryName`|Scalar Helmリポジトリを表すために使用される名前|`scalar-labs`| -|`helm.scalarRepositoryUrl`|Scalar HelmリポジトリのURL|`https://scalar-labs.github.io/helm-charts`| -|`helm.scalarAdminForKubernetesChartName`|Scalar HelmリポジトリにおけるKubernetes用Scalar Adminの Helm Chart名|`scalar-admin-for-kubernetes`| -|`helm.scalarAdminForKubernetesChartVersion`|Kubernetes用Scalar Admin Helm Chartのバージョン|`1.0.0`| -|`configMapNamespace`|Scalar Managerが使用するConfigMapがデプロイされる名前空間|`default`| -|`configMapName`|Scalar Managerが使用するConfigMapの名前|`scalar-manager-metadata`| +|`grafana.kubernetesServiceLabelName`|Kubernetes で Grafana サービスを検出するために使用されるラベル名|`app.kubernetes.io/name`| +|`grafana.kubernetesServiceLabelValue`|`grafana.kubernetesServiceLabelName` に対応するラベル値|`grafana`| +|`grafana.kubernetesServicePortName`|Kubernetes で Grafana サービスポートを検出するために使用されるポート名|`http-web`| +|`prometheus.kubernetesServiceLabelName`|Kubernetes で Prometheus サービスを検出するために使用されるラベル名|`app`| +|`prometheus.kubernetesServiceLabelValue`|`prometheus.kubernetesServiceLabelName` に対応するラベル値|`kube-prometheus-stack-prometheus`| +|`prometheus.kubernetesServicePortName`|Kubernetes で Prometheus サービスポートを検出するために使用されるポート名|`http-web`| +|`loki.kubernetesServiceLabelName`|Kubernetes で Prometheus サービスを検出するために使用されるラベル名|`app`| +|`loki.kubernetesServiceLabelValue`|`loki.kubernetesServiceLabelName` に対応するラベル値|`loki`| +|`loki.kubernetesServicePortName`|Kubernetes で Loki サービスポートを検出するために使用されるポート名|`http-metrics`| +|`helm.scalarRepositoryName`|Scalar Helm リポジトリを表すために使用される名前|`scalar-labs`| +|`helm.scalarRepositoryUrl`|Scalar Helm リポジトリの URL|`https://scalar-labs.github.io/helm-charts`| +|`helm.scalarAdminForKubernetesChartName`|Scalar Helm リポジトリにおける Kubernetes 用 Scalar Admin の Helm Chart 名|`scalar-admin-for-kubernetes`| +|`helm.scalarAdminForKubernetesChartVersion`|Kubernetes 用 Scalar Admin Helm Chart のバージョン|`1.0.0`| +|`configMapNamespace`|Scalar Manager が使用する ConfigMap がデプロイされる名前空間|`default`| +|`configMapName`|Scalar Manager が使用する ConfigMap の名前|`scalar-manager-metadata`| |`paused-state-retention.storage`|一時停止状態を保持するために使用されるストレージタイプ|`configmap`| -|`paused-state-retention.max-number`|Scalar Managerが保持する一時停止状態の最大数|`100`| +|`paused-state-retention.max-number`|Scalar Manager が保持する一時停止状態の最大数|`100`| #### サービスディスカバリー -Scalar Managerはラベルセレクターを使用して、Kubernetes内のGrafana、Prometheus、Lokiサービスを検出し、ポート名を使用してそれらに接続します。`*.kubernetesServiceLabelName`、`*.kubernetesServiceLabelValue`、`*.kubernetesServicePortName`の設定を変更することで、ラベルセレクターとポート名を修正できます。 +Scalar Manager はラベルセレクターを使用して、Kubernetes 内の Grafana、Prometheus、Loki サービスを検出し、ポート名を使用してそれらに接続します。`*.kubernetesServiceLabelName`、`*.kubernetesServiceLabelValue`、`*.kubernetesServicePortName` の設定を変更することで、ラベルセレクターとポート名を修正できます。 -一般的に、これらの設定を変更する必要はありません。ただし、Grafana、Prometheus、またはLokiサービスのHelm Chartをインストールする際にラベルやポート名をカスタマイズした場合は、これらの設定をカスタマイズに合わせて調整する必要があります。 +一般的に、これらの設定を変更する必要はありません。ただし、Grafana、Prometheus、または Loki サービスの Helm Chart をインストールする際にラベルやポート名をカスタマイズした場合は、これらの設定をカスタマイズに合わせて調整する必要があります。 -##### Kubernetes用Scalar Adminの使用 +##### Kubernetes 用 Scalar Admin の使用 -Scalar Managerは、[Kubernetes用Scalar Admin](https://github.com/scalar-labs/scalar-admin-for-kubernetes) Helm Chartをインストールして、Scalar製品の一時停止ジョブのスケジューリングや実行を行います。以下の設定を使用して、Scalar Helmリポジトリをセットアップし、Helm Chartを配置します： +Scalar Manager は、[Kubernetes 用 Scalar Admin](https://github.com/scalar-labs/scalar-admin-for-kubernetes) Helm Chart をインストールして、Scalar製品の一時停止ジョブのスケジューリングや実行を行います。以下の設定を使用して、Scalar Helm リポジトリをセットアップし、Helm Chart を配置します: - `helm.scalarRepositoryName` - `helm.scalarRepositoryUrl` @@ -103,24 +104,30 @@ Scalar Managerは、[Kubernetes用Scalar Admin](https://github.com/scalar-labs/s - `helm.scalarAdminForKubernetesChartVersion` :::note + 特別な理由がない限り、これらの設定を変更することはお勧めしません。 + ::: -##### Scalar Managerが使用するConfigMap +##### Scalar Manager が使用する ConfigMap -Scalar Managerは、デフォルトのアプリケーションプロパティなどのメタデータを保存するためにConfigMapを使用します。ConfigMapは以下の設定で指定された名前空間にデプロイされます： +Scalar Manager は、デフォルトのアプリケーションプロパティなどのメタデータを保存するために ConfigMap を使用します。ConfigMap は以下の設定で指定された名前空間にデプロイされます: - `configMapNamespace` - `configMapName` :::note -競合するConfigMapを使用している場合など、特別な理由がない限り、これらの設定を変更することはお勧めしません。 + +競合する ConfigMap を使用している場合など、特別な理由がない限り、これらの設定を変更することはお勧めしません。 + ::: ##### 一時停止状態の保持 -Scalar Managerは、Scalar製品の一時停止状態をストレージに保持します。現在、Scalar ManagerはストレージとしてConfigMapのみを使用できるため、`paused-state-retention.storage`設定は`configmap`に設定する必要があります。`paused-state-retention.max-number`設定を設定することで、Scalar Managerが保持する一時停止状態の最大数を調整できます。 +Scalar Manager は、Scalar 製品の一時停止状態をストレージに保持します。現在、Scalar Manager はストレージとして ConfigMap のみを使用できるため、`paused-state-retention.storage` 設定は `configmap` に設定する必要があります。`paused-state-retention.max-number` 設定を設定することで、Scalar Manager が保持する一時停止状態の最大数を調整できます。 :::warning -ストレージにConfigMapを使用する場合、ConfigMapのサイズ制限があるため、`paused-state-retention.max-number`に大きな値を設定することはお勧めしません。ConfigMapに保存されるデータは1 MiBを超えることができないため、Scalar Managerが保持できる一時停止状態の最大数は約3,000です。 + +ストレージに ConfigMap を使用する場合、ConfigMap のサイズ制限があるため、`paused-state-retention.max-number` に大きな値を設定することはお勧めしません。ConfigMap に保存されるデータは 1MiB を超えることができないため、Scalar Manager が保持できる一時停止状態の最大数は約3,000です。 + ::: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-analytics-postgresql.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-analytics-postgresql.mdx index d0273aab..0c6b8bf9 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-analytics-postgresql.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-analytics-postgresql.mdx @@ -1,6 +1,7 @@ --- tags: - Community +displayed_sidebar: docsJapanese --- # ScalarDB Analytics with PostgreSQL のカスタム値ファイルを構成する @@ -9,15 +10,15 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、PostgreSQL チャートを使用した ScalarDB Analytics のカスタム値ファイルを作成する方法について説明します。 パラメーターの詳細については、ScalarDB Analytics with PostgreSQL チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-analytics-postgresql/README.md) を参照してください。 +このドキュメントでは、PostgreSQL チャートを使用した ScalarDB Analytics のカスタム値ファイルを作成する方法について説明します。パラメーターの詳細については、ScalarDB Analytics with PostgreSQL チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-analytics-postgresql/README.md) を参照してください。 ## 必要な構成 -このセクションでは、PostgreSQL で ScalarDB Analytics のカスタム値ファイルを設定するときに必要な構成について説明します。 +このセクションでは、ScalarDB Analytics with PostgreSQL のカスタム値ファイルを設定するときに必要な構成について説明します。 ### データベース構成 -PostgreSQL を使用した ScalarDB Analytics 経由でデータベースにアクセスするには、`database.properties` ファイルの構成に使用するのと同じ構文に従って、`scalardbAnalyticsPostgreSQL.databaseProperties` パラメータを設定する必要があります。 設定の詳細については、[ScalarDB Configurations](https://scalardb.scalar-labs.com/docs/latest/configurations/) を参照してください。 +ScalarDB Analytics with PostgreSQL 経由でデータベースにアクセスするには、`database.properties` ファイルの構成に使用するのと同じ構文に従って、`scalardbAnalyticsPostgreSQL.databaseProperties` パラメータを設定する必要があります。設定の詳細については、[ScalarDB Configurations](https://scalardb.scalar-labs.com/docs/latest/configurations/) を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: @@ -30,7 +31,7 @@ scalardbAnalyticsPostgreSQL: ### データベース名前空間の構成 -PostgreSQL を使用した ScalarDB Analytics 経由で読み取りたいテーブルを含むすべてのデータベース名前空間に `schemaImporter.namespaces` を設定する必要があります。 +ScalarDB Analytics with PostgreSQL 経由で読み取りたいテーブルを含むすべてのデータベース名前空間に `schemaImporter.namespaces` を設定する必要があります。 ```yaml schemaImporter: @@ -42,13 +43,13 @@ schemaImporter: ## オプションの構成 -このセクションでは、PostgreSQL で ScalarDB Analytics のカスタム値ファイルを設定する場合のオプションの構成について説明します。 +このセクションでは、ScalarDB Analytics with PostgreSQL のカスタム値ファイルを設定する場合のオプションの構成について説明します。 ### リソース構成 (実稼働環境で推奨) -Kubernetes でリクエストと制限を使用してポッド リソースを制御するには、`scalardbAnalyticsPostgreSQL.resources` を使用できます。 +Kubernetes でリクエストと制限を使用してポッドリソースを制御するには、`scalardbAnalyticsPostgreSQL.resources` を使用できます。 -Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。 Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)を参照してください。 +Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: @@ -63,11 +64,11 @@ scalardbAnalyticsPostgreSQL: ### シークレット構成 (運用環境で推奨) -環境変数を使用して `scalardbAnalyticsPostgreSQL.databaseProperties` で資格情報などのいくつかのプロパティを設定するには、`scalardbAnalyticsPostgreSQL.secretName` を使用していくつかの資格情報を含むシークレット リソースを指定します。 +環境変数を使用して `scalardbAnalyticsPostgreSQL.databaseProperties` で資格情報などのいくつかのプロパティを設定するには、`scalardbAnalyticsPostgreSQL.secretName` を使用していくつかの資格情報を含むシークレットリソースを指定します。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定できるため、ポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定できるため、ポッドの安全性が高まります。 -シークレットリソースの使用方法の詳細については、[シークレットリソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法(./use-secret-for-credentials.mdx) を参照してください。 +シークレットリソースの使用方法の詳細については、[シークレットリソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法(./use-secret-for-credentials.mdx)を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: @@ -78,7 +79,7 @@ scalardbAnalyticsPostgreSQL: Kubernetes でアフィニティとアンチアフィニティを使用してポッドのデプロイメントを制御するには、`scalardbAnalyticsPostgreSQL.affinity` を使用できます。 -Kubernetes のアフィニティとアンチアフィニティと同じ構文を使用して、アフィニティとアンチアフィニティを構成できます。 Kubernetes でのアフィニティの構成の詳細については、[Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティとアンチアフィニティと同じ構文を使用して、アフィニティとアンチアフィニティを構成できます。Kubernetes でのアフィニティの構成の詳細については、[Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: @@ -102,7 +103,7 @@ scalardbAnalyticsPostgreSQL: PostgreSQL ポッドを使用して ScalarDB Analytics の SecurityContext と PodSecurityContext を設定するには、`scalardbAnalyticsPostgreSQL.securityContext`、`scalardbAnalyticsPostgreSQL.podSecurityContext`、および `schemaImporter.securityContext` を使用できます。 -Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。 Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: @@ -129,7 +130,7 @@ schemaImporter: ### 画像構成 (デフォルト値を推奨) -イメージ リポジトリを変更する場合は、`scalardbAnalyticsPostgreSQL.image.repository` と `schemaImporter.image.repository` を使用して、プルする ScalarDB Analytics with PostgreSQL および Schema Importer イメージのコンテナ リポジトリ情報を指定できます。 +イメージリポジトリを変更する場合は、`scalardbAnalyticsPostgreSQL.image.repository` と `schemaImporter.image.repository` を使用して、プルする ScalarDB Analytics with PostgreSQL および Schema Importer イメージのコンテナリポジトリ情報を指定できます。 ```yaml scalardbAnalyticsPostgreSQL: @@ -150,9 +151,9 @@ scalardbAnalyticsPostgreSQL: replicaCount: 3 ``` -### PostgreSQL database name configuration (optional based on your environment) +### PostgreSQL データベース名の構成 (環境に応じてオプション) -You can specify the database name that you create in PostgreSQL. Schema Importer creates some objects, such as a view of ScalarDB Analytics with PostgreSQL, in this database. +PostgreSQL で作成するデータベース名を指定できます。Schema Importer は、ScalarDB Analytics with PostgreSQL のビューなど、いくつかのオブジェクトをこのデータベースに作成します。 ```yaml scalardbAnalyticsPostgreSQL: @@ -172,7 +173,7 @@ scalardbAnalyticsPostgreSQL: :::note -PostgreSQL で ScalarDB Analytics をデプロイする前に、この名前 (デフォルトでは `scalardb-analytics-postgresql-superuser-password`) でシークレット リソースを作成する必要があります。 詳細については、[シークレットリソースを準備する](how-to-deploy-scalardb-analytics-postgresql.mdx#シークレットリソースを準備する) を参照してください。 +ScalarDB Analytics with PostgreSQL をデプロイする前に、この名前 (デフォルトでは `scalardb-analytics-postgresql-superuser-password`) でシークレットリソースを作成する必要があります。詳細については、[シークレットリソースを準備する](how-to-deploy-scalardb-analytics-postgresql.mdx#シークレットリソースを準備する)を参照してください。 ::: @@ -180,7 +181,7 @@ PostgreSQL で ScalarDB Analytics をデプロイする前に、この名前 ( Kubernetes でテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`scalardbAnalyticsPostgreSQL.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml scalardbAnalyticsPostgreSQL: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-cluster.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-cluster.mdx index c8fafa8b..37cc07f1 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-cluster.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb-cluster.mdx @@ -2,17 +2,18 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # ScalarDB Cluster のカスタム値ファイルを構成する -このドキュメントでは、ScalarDB Cluster チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細については、ScalarDB Cluster チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-cluster/README.md) を参照してください。 +このドキュメントでは、ScalarDB Cluster チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細については、ScalarDB Cluster チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb-cluster/README.md) を参照してください。 ## 必要な構成 ### 画像構成 -`scalardbCluster.image.repository`を設定する必要があります。 コンテナー リポジトリからイメージをプルできるように、必ず ScalarDB Cluster コンテナー イメージを指定してください。 +`scalardbCluster.image.repository`を設定する必要があります。コンテナーリポジトリからイメージをプルできるように、必ず ScalarDB Cluster コンテナーイメージを指定してください。 ```yaml scalardbCluster: @@ -22,7 +23,7 @@ scalardbCluster: ### データベース構成 -`scalardbCluster.scalardbClusterNodeProperties` を設定する必要があります。 このパラメータには `scalardb-cluster-node.properties` を設定してください。 ScalarDB Cluster の構成の詳細については、[ScalarDB Cluster Configurations](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/scalardb-cluster-configurations/) を参照してください。 +`scalardbCluster.scalardbClusterNodeProperties` を設定する必要があります。このパラメータには `scalardb-cluster-node.properties` を設定してください。ScalarDB Cluster の構成の詳細については、[ScalarDB Cluster Configurations](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/scalardb-cluster-configurations/) を参照してください。 ```yaml scalardbCluster: @@ -36,7 +37,7 @@ scalardbCluster: scalar.db.storage=cassandra ``` -Scalar Helm Chart を使用して Kubernetes 環境に ScalarDB Cluster をデプロイする場合は、次の 3 つのプロパティを常に設定する必要があることに注意してください。 これらのプロパティは固定値です。 プロパティは個別の環境に依存しないため、以下の値をコピーして `scalardbCluster.scalardbClusterNodeProperties` に貼り付けることで同じ値を設定できます。 +Scalar Helm Chart を使用して Kubernetes 環境に ScalarDB Cluster をデプロイする場合は、次の3つのプロパティを常に設定する必要があることに注意してください。これらのプロパティは固定値です。プロパティは個別の環境に依存しないため、以下の値をコピーして `scalardbCluster.scalardbClusterNodeProperties` に貼り付けることで同じ値を設定できます。 ```yaml scalardbCluster: @@ -50,11 +51,11 @@ scalardbCluster: ### リソース構成 (実稼働環境で推奨) -Kubernetes でリクエストと制限を使用してポッド リソースを制御するには、`scalardbCluster.resources` を使用できます。 +Kubernetes でリクエストと制限を使用してポッドリソースを制御するには、`scalardbCluster.resources` を使用できます。 -商用ライセンスの場合、Scalar 製品の各ポッドのリソースは 2vCPU / 4GB メモリに制限されることに注意してください。 また、AWS Marketplace が提供する従量課金制のコンテナを使用する場合、`resources.limits` の 2vCPU / 4GB メモリ構成を超えるコンテナを実行することはできません。 このリソース制限を超えると、ポッドは自動的に停止します。 +商用ライセンスの場合、Scalar 製品の各ポッドのリソースは 2vCPU / 4GB メモリに制限されることに注意してください。また、AWS Marketplace が提供する従量課金制のコンテナを使用する場合、`resources.limits` の 2vCPU / 4GB メモリ構成を超えるコンテナを実行することはできません。このリソース制限を超えると、ポッドは自動的に停止します。 -Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。 Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +Kubernetes のリクエストと制限と同じ構文を使用して、リクエストと制限を構成できます。Kubernetes のリクエストと制限の詳細については、[Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml scalardbCluster: @@ -71,9 +72,9 @@ scalardbCluster: 環境変数を使用して `scalardbCluster.scalardbClusterNodeProperties` 内の一部のプロパティ (資格情報など) を設定するには、`scalardbCluster.secretName` を使用して、いくつかの資格情報を含む Secret リソースを指定します。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定できるため、ポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定できるため、ポッドの安全性が高まります。 -Secret リソースの使用方法の詳細については、[Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法](use-secret-for-credentials.mdx) を参照してください。 +Secret リソースの使用方法の詳細については、[Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法](use-secret-for-credentials.mdx)を参照してください。 ```yaml scalardbCluster: @@ -84,7 +85,7 @@ scalardbCluster: Kubernetes でアフィニティとアンチアフィニティを使用してポッドのデプロイメントを制御するには、`scalardbCluster.affinity` を使用できます。 -Kubernetes のアフィニティとアンチアフィニティと同じ構文を使用して、アフィニティとアンチアフィニティを構成できます。 Kubernetes でのアフィニティの構成の詳細については、[Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティとアンチアフィニティと同じ構文を使用して、アフィニティとアンチアフィニティを構成できます。Kubernetes でのアフィニティの構成の詳細については、[Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml scalardbCluster: @@ -108,7 +109,7 @@ scalardbCluster: ### Prometheus および Grafana 構成 (実稼働環境で推奨) -[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDB Cluster ポッドを監視するには、`scalardbCluster.grafanaDashboard.enabled`、`scalardbCluster.serviceMonitor.enabled`、`scalardbCluster.prometheusRule.enabled` を `true` に設定します。 これらの構成を `true` に設定すると、チャートは必要なリソースをデプロイし、kube-prometheus-stack が自動的に監視を開始します。 +[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDB Cluster ポッドを監視するには、`scalardbCluster.grafanaDashboard.enabled`、`scalardbCluster.serviceMonitor.enabled`、`scalardbCluster.prometheusRule.enabled` を `true` に設定します。これらの構成を `true` に設定すると、チャートは必要なリソースをデプロイし、kube-prometheus-stack が自動的に監視を開始します。 ```yaml scalardbCluster: @@ -128,7 +129,7 @@ scalardbCluster: ScalarDB Cluster ポッドの SecurityContext と PodSecurityContext を設定するには、`scalardbCluster.securityContext` と `scalardbCluster.podSecurityContext` を使用できます。 -Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。 Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +Kubernetes の SecurityContext および PodSecurityContext と同じ構文を使用して、SecurityContext および PodSecurityContext を構成できます。Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、[Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml scalardbCluster: @@ -150,7 +151,7 @@ TLS は、次の通信で有効にできます: - ScalarDB Cluster ノードとクライアント間の通信。 - すべての ScalarDB Cluster ノード間の通信 (クラスターの内部通信)。 -さらに、証明書管理にはいくつかのオプションがあります。詳細については、[Envoy の TLS 構成](./configure-custom-values-envoy.mdx#tls-構成-環境に応じてオプション) を参照してください。 +さらに、証明書管理にはいくつかのオプションがあります。詳細については、[Envoy の TLS 構成](./configure-custom-values-envoy.mdx#tls-構成-環境に応じてオプション)を参照してください。 セキュリティ要件に基づいて、どの方法を使用するかを検討する必要があります。各方法のガイダンスと関連ドキュメントについては、次の意思決定ツリーを参照してください。 @@ -187,7 +188,8 @@ scalardbCluster: tls: enabled: true ``` -##### 秘密鍵と証明書ファイルを使用する + +##### シークレットキーと証明書ファイルを使用する 次の構成を使用して、秘密鍵と証明書ファイルを設定できます。 @@ -208,7 +210,7 @@ kubectl create secret generic scalardb-cluster-tls-cert --from-file=tls.crt=/ -n ``` -秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx) を参照してください。 +秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx)を参照してください。 ##### cert-manager で信頼できる CA を使用して秘密鍵と証明書ファイルを管理する @@ -216,8 +218,8 @@ kubectl create secret generic scalardb-cluster-tls-key --from-file=tls.key=/:80/graphql` を使用して graphql クエリを実行できます。 +graphql クエリを実行するパスを変更したい場合は、`scalarDbGraphQlConfiguration.path` を使用できます。デフォルトでは、`http://:80/graphql` を使用して graphql クエリを実行できます。 -`scalarDbGraphQlConfiguration.graphiql`を使用して[GraphiQL](https://github.com/graphql/graphiql/tree/main/packages/graphiql) を有効/無効にすることもできます。 +`scalarDbGraphQlConfiguration.graphiql` を使用して [GraphiQL](https://github.com/graphql/graphiql/tree/main/packages/graphiql) を有効/無効にすることもできます。 ```yaml scalarDbGraphQlConfiguration: @@ -183,7 +184,7 @@ scalarDbGraphQlConfiguration: クライアントとイングレスの間で TLS を使用したい場合は、`ingress.tls` を使用できます。 -秘密キーと証明書ファイルを含むシークレット リソースを作成する必要があります。 Ingress の Secret リソースの詳細については、公式ドキュメント [Ingress - TLS](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) を参照してください。 +秘密鍵と証明書ファイルを含むシークレットリソースを作成する必要があります。Ingress の Secret リソースの詳細については、公式ドキュメント [Ingress - TLS](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) を参照してください。 ```yaml ingress: @@ -216,7 +217,7 @@ scalarDbGraphQlConfiguration: Kubernetes のテイントと許容範囲を使用してポッドのデプロイメントを制御したい場合は、`tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml tolerations: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb.mdx index 9b8f87c9..139f7bfe 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardb.mdx @@ -3,6 +3,7 @@ tags: - Enterprise Standard - Enterprise Premium - Deprecated +displayed_sidebar: docsJapanese --- # [非推奨] ScalarDB Server のカスタム値ファイルを構成する @@ -13,33 +14,33 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; :::note -ScalarDB Server は非推奨になりました。 代わりに [ScalarDB Cluster](configure-custom-values-scalardb-cluster.mdx) を使用してください。 +ScalarDB Server は非推奨になりました。代わりに [ScalarDB Cluster](configure-custom-values-scalardb-cluster.mdx) を使用してください。 ::: -このドキュメントでは、ScalarDB Server チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、ScalarDB Server チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb/README.md) を参照してください。 +このドキュメントでは、ScalarDB Server チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、ScalarDB Server チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardb/README.md) を参照してください。 ## 必要な構成 ### Scalar Envoy 構成 -ScalarDB Server のカスタム値ファイルに Scalar Envoy 構成を設定する必要があります。 これは、ScalarDB Server を Kubernetes 環境にデプロイする場合、クライアント リクエストが gRPC リクエストのロード バランサーとして Scalar Envoy 経由で ScalarDB Server に送信されるためです。 +ScalarDB Server のカスタム値ファイルに Scalar Envoy 構成を設定する必要があります。これは、ScalarDB Server を Kubernetes 環境にデプロイする場合、クライアントリクエストが gRPC リクエストのロードバランサーとして Scalar Envoy 経由で ScalarDB Server に送信されるためです。 -Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx) を参照してください。 +Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx)を参照してください。 ```yaml envoy: - configurationsForScalarEnvoy: + configurationsForScalarEnvoy: ... scalardb: - configurationsForScalarDB: + configurationsForScalarDB: ... ``` ### 画像構成 -`scalardb.image.repository`を設定する必要があります。 コンテナー リポジトリからイメージをプルできるように、必ず ScalarDB Server コンテナー イメージを指定してください。 +`scalardb.image.repository`を設定する必要があります。コンテナーリポジトリからイメージをプルできるように、必ず ScalarDB Server コンテナーイメージを指定してください。 ```yaml scalardb: @@ -54,7 +55,7 @@ AWS または Azure を使用している場合、詳細については次のド ### データベース構成 -`scalardb.databaseProperties` を設定する必要があります。 `database.properties` をこのパラメータに設定してください。 ScalarDB Server の設定の詳細については、[Configure ScalarDB Server](https://scalardb.scalar-labs.com/docs/latest/scalardb-server.mdx#configure-scalardb-server) を参照してください。 +`scalardb.databaseProperties` を設定する必要があります。`database.properties` をこのパラメータに設定してください。ScalarDB Server の設定の詳細については、[Configure ScalarDB Server](https://scalardb.scalar-labs.com/docs/latest/scalardb-server.mdx#configure-scalardb-server) を参照してください。 ```yaml scalardb: @@ -77,11 +78,11 @@ scalardb: ### リソース構成 (本番環境で推奨) -Kubernetes のリクエストと制限を使用してポッド リソースを制御したい場合は、`scalardb.resources` を使用できます。 +Kubernetes のリクエストと制限を使用してポッドリソースを制御したい場合は、`scalardb.resources` を使用できます。 -商用ライセンスの観点から、Scalar 製品の 1 つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。 また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。 この制限を超えると、ポッドは自動的に停止されます。 +商用ライセンスの観点から、Scalar 製品の1つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。この制限を超えると、ポッドは自動的に停止されます。 -これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。 そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Pod およびコンテナーのリソース管理](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Pod およびコンテナーのリソース管理](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)を参照してください。 ```yaml scalardb: @@ -98,9 +99,9 @@ scalardb: 環境変数を使用して `scalardb.databaseProperties` 内の一部のプロパティ (資格情報など) を設定したい場合は、`scalardb.secretName` を使用して、いくつかの資格情報を含む Secret リソースを指定できます。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 -Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法](use-secret-for-credentials.mdx) を参照してください。 +Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法](use-secret-for-credentials.mdx)を参照してください。 ```yaml scalardb: @@ -111,7 +112,7 @@ scalardb: Kubernetes のアフィニティと反アフィニティを使用してポッドのデプロイメントを制御したい場合は、`scalardb.affinity` を使用できます。 -Kubernetes のアフィニティと同じ構文を使用して構成できます。 そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティと同じ構文を使用して構成できます。そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml scalardb: @@ -135,7 +136,7 @@ scalardb: ### Prometheus/Grafana 構成 (運用環境で推奨) -[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDB Server ポッドを監視する場合は、`scalardb.grafanaDashboard.enabled`、`scalardb.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。 `enabled`および `scalardb.prometheusRule.enabled`。 +[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDB Server ポッドを監視する場合は、`scalardb.grafanaDashboard.enabled`、`scalardb.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。`enabled`および `scalardb.prometheusRule.enabled`。 ```yaml scalardb: @@ -155,7 +156,7 @@ scalardb: ScalarDB Server ポッドに SecurityContext と PodSecurityContext を設定したい場合は、`scalardb.securityContext` と `scalardb.podSecurityContext` を使用できます。 -KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。 したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml scalardb: @@ -193,7 +194,7 @@ scalardb: Kubernetes のテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`scalardb.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml scalardb: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-auditor.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-auditor.mdx index 71e19669..33d42eee 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-auditor.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-auditor.mdx @@ -1,31 +1,32 @@ --- +displayed_sidebar: docsJapanese --- # ScalarDL Auditor のカスタム値ファイルを構成する -このドキュメントでは、ScalarDL Auditor チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、ScalarDL Auditor チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl-audit/README.md) を参照してください。 +このドキュメントでは、ScalarDL Auditor チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、ScalarDL Auditor チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl-audit/README.md) を参照してください。 ## 必要な構成 ### Scalar Envoy 構成 -ScalarDL Auditor のカスタム値ファイルで Scalar Envoy 構成を設定する必要があります。 これは、ScalarDL Auditor を Kubernetes 環境にデプロイする場合、クライアント リクエストが gRPC リクエストのロード バランサーとして Scalar Envoy 経由で ScalarDL Auditor に送信されるためです。 +ScalarDL Auditor のカスタム値ファイルで Scalar Envoy 構成を設定する必要があります。これは、ScalarDL Auditor を Kubernetes 環境にデプロイする場合、クライアントリクエストが gRPC リクエストのロードバランサーとして Scalar Envoy 経由で ScalarDL Auditor に送信されるためです。 -Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx) を参照してください。 +Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx)を参照してください。 ```yaml envoy: - configurationsForScalarEnvoy: + configurationsForScalarEnvoy: ... auditor: - configurationsForScalarDLAuditor: + configurationsForScalarDLAuditor: ... ``` ### 画像構成 -`auditor.image.repository` を設定する必要があります。 コンテナー リポジトリからイメージをプルできるように、必ず ScalarDL Auditor コンテナー イメージを指定してください。 +`auditor.image.repository` を設定する必要があります。コンテナーリポジトリからイメージをプルできるように、必ず ScalarDL Auditor コンテナーイメージを指定してください。 ```yaml auditor: @@ -33,11 +34,11 @@ auditor: repository: ``` -Scalar 製品のコンテナリポジトリの詳細については、[Scalar 製品のコンテナ イメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx) を参照してください。 +Scalar 製品のコンテナリポジトリの詳細については、[Scalar 製品のコンテナイメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx)を参照してください。 ### Auditor / データベースの構成 -`auditor.auditorProperties` を設定する必要があります。 `auditor.properties` をこのパラメータに設定してください。 ScalarDL Auditor の設定の詳細については、[auditor.properties](https://github.com/scalar-labs/scalar/blob/master/auditor/conf/auditor.properties) を参照してください。 +`auditor.auditorProperties` を設定する必要があります。`auditor.properties` をこのパラメータに設定してください。ScalarDL Auditor の設定の詳細については、[auditor.properties](https://github.com/scalar-labs/scalar/blob/master/auditor/conf/auditor.properties) を参照してください。 ```yaml auditor: @@ -55,19 +56,19 @@ auditor: 秘密鍵ファイルを `scalar.dl.auditor.private_key_path` に設定し、証明書ファイルを `scalar.dl.auditor.cert_path` に設定する必要があります。 -秘密キー ファイルと証明書ファイルも ScalarDL Auditor ポッドにマウントする必要があります。 +秘密鍵ファイルと証明書ファイルも ScalarDL Auditor ポッドにマウントする必要があります。 -秘密キー ファイルと証明書ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドにキーファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする) を参照してください。 +秘密鍵ファイルと証明書ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドに秘密鍵ファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする)を参照してください。 ## オプションの構成 ### リソース構成 (本番環境で推奨) -Kubernetes のリクエストと制限を使用してポッド リソースを制御したい場合は、`auditor.resources` を使用できます。 +Kubernetes のリクエストと制限を使用してポッドリソースを制御したい場合は、`auditor.resources` を使用できます。 -商用ライセンスの観点から、Scalar 製品の 1 つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。 また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。 この制限を超えると、ポッドは自動的に停止されます。 +商用ライセンスの観点から、Scalar 製品の1つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。この制限を超えると、ポッドは自動的に停止されます。 -これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。 そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml auditor: @@ -84,9 +85,9 @@ auditor: 環境変数を使用して `auditor.auditorProperties` 内の一部のプロパティ (資格情報など) を設定したい場合は、`auditor.secretName` を使用して、いくつかの資格情報を含む Secret リソースを指定できます。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 -Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法](use-secret-for-credentials.mdx) を参照してください。 +Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法](use-secret-for-credentials.mdx)を参照してください。 ```yaml auditor: @@ -97,7 +98,7 @@ auditor: Kubernetes のアフィニティと反アフィニティを使用してポッドのデプロイメントを制御したい場合は、`auditor.affinity` を使用できます。 -Kubernetes のアフィニティと同じ構文を使用して構成できます。 そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティと同じ構文を使用して構成できます。そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml auditor: @@ -121,7 +122,7 @@ auditor: ### Prometheus/Grafana 構成 (運用環境で推奨) -[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDL Auditor ポッドを監視する場合は、`auditor.grafanaDashboard.enabled`、`auditor.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。 `enabled` および `auditor.prometheusRule.enabled`。 +[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDL Auditor ポッドを監視する場合は、`auditor.grafanaDashboard.enabled`、`auditor.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。`enabled` および `auditor.prometheusRule.enabled`。 ```yaml auditor: @@ -141,7 +142,7 @@ auditor: ScalarDL Auditor ポッドに SecurityContext と PodSecurityContext を設定したい場合は、`auditor.securityContext` と `auditor.podSecurityContext` を使用できます。 -KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。 したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml auditor: @@ -163,7 +164,7 @@ TLS は、次の通信で有効にできます: - ScalarDL Auditor とクライアント間の通信。 - ScalarDL Ledger と ScalarDL Auditor 間の通信。 -さらに、証明書管理にはいくつかのオプションがあります。詳細については、[Envoy の TLS 構成](./configure-custom-values-envoy.mdx#tls-構成-環境に応じてオプション) を参照してください。 +さらに、証明書管理にはいくつかのオプションがあります。詳細については、[Envoy の TLS 構成](./configure-custom-values-envoy.mdx#tls-構成-環境に応じてオプション)を参照してください。 セキュリティ要件に基づいて、どの方法を使用するかを検討する必要があります。各方法のガイダンスと関連ドキュメントについては、次の意思決定ツリーを参照してください。 @@ -215,7 +216,7 @@ auditor: privateKeySecret: "scalardl-auditor-tls-key" ``` -この場合、次のように、山括弧内の内容を置き換えて、ScalarDL Ledger および ScalarDL Auditor の秘密キーと証明書ファイルを含むシークレットリソースを作成する必要があります。 +この場合、次のように、山括弧内の内容を置き換えて、ScalarDL Ledger および ScalarDL Auditor の秘密鍵と証明書ファイルを含むシークレットリソースを作成する必要があります。 ```console kubectl create secret generic scalardl-auditor-tls-ca --from-file=ca.crt=/ -n @@ -224,7 +225,7 @@ kubectl create secret generic scalardl-auditor-tls-key --from-file=tls.key=/ -n ``` -秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx) を参照してください。 +秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx)を参照してください。 ##### cert-manager で信頼できる CA を使用して秘密鍵と証明書ファイルを管理する @@ -232,8 +233,8 @@ kubectl create secret generic scalardl-auditor-tls-ca-for-ledger --from-file=ca. :::note -* cert-manager を使用する場合は、cert-manager をデプロイし、`Issuers` リソースを準備する必要があります。詳細については、cert-manager のドキュメント、[インストール](https://cert-manager.io/docs/installation/) および [発行者構成](https://cert-manager.io/docs/configuration/) を参照してください。 -* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密キーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements) を参照してください。 +* cert-manager を使用する場合は、cert-manager をデプロイし、`Issuers` リソースを準備する必要があります。詳細については、cert-manager のドキュメント、[インストール](https://cert-manager.io/docs/installation/)および[発行者構成](https://cert-manager.io/docs/configuration/)を参照してください。 +* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements)を参照してください。 ::: @@ -253,12 +254,12 @@ auditor: ##### cert-manager で自己署名 CA を使用して秘密鍵と証明書ファイルを管理する -次の構成を使用して、cert-manager で秘密キーと自己署名証明書ファイルを管理できます。 +次の構成を使用して、cert-manager で秘密鍵と自己署名証明書ファイルを管理できます。 :::note -* cert-manager を使用する場合は、cert-manager をデプロイする必要があります。詳細については、cert-manager のドキュメント [インストール](https://cert-manager.io/docs/installation/) を参照してください。 -* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密キーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements) を参照してください。 +* cert-manager を使用する場合は、cert-manager をデプロイする必要があります。詳細については、cert-manager のドキュメント[インストール](https://cert-manager.io/docs/installation/)を参照してください。 +* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements)を参照してください。 ::: @@ -308,7 +309,7 @@ kubectl create secret generic scalardl-auditor-tls-ca-for-ledger --from-file=ca. ##### TLS通信のカスタム権限を設定する -`auditor.tls.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、`auditor.tls.certChainSecret` を使用して設定した証明書チェーン ファイルで提示されるホスト名を指定できます。このチャートでは、`startupProbe` と `livenessProbe` にこの値を使用しています。 +`auditor.tls.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、`auditor.tls.certChainSecret` を使用して設定した証明書チェーンファイルで提示されるホスト名を指定できます。このチャートでは、`startupProbe` と `livenessProbe` にこの値を使用しています。 ### レプリカ構成 (環境に応じてオプション) @@ -333,7 +334,7 @@ auditor: Kubernetes のテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`auditor.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml auditor: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-ledger.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-ledger.mdx index 79b0b6cc..482b59ae 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-ledger.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-ledger.mdx @@ -1,31 +1,32 @@ --- +displayed_sidebar: docsJapanese --- # ScalarDL Ledger のカスタム値ファイルを構成する -このドキュメントでは、ScalarDL Ledger チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、ScalarDL Ledger chartの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl/README.md) を参照してください。 +このドキュメントでは、ScalarDL Ledger チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、ScalarDL Ledger chartの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/scalardl/README.md) を参照してください。 ## 必要な構成 ### Scalar Envoy 構成 -ScalarDL Ledger のカスタム値ファイルで Scalar Envoy 構成を設定する必要があります。 これは、ScalarDL Ledger を Kubernetes 環境にデプロイする場合、クライアント リクエストが gRPC リクエストのロード バランサーとして Scalar Envoy 経由で ScalarDL Ledger に送信されるためです。 +ScalarDL Ledger のカスタム値ファイルで Scalar Envoy 構成を設定する必要があります。これは、ScalarDL Ledger を Kubernetes 環境にデプロイする場合、クライアントリクエストが gRPC リクエストのロードバランサーとして Scalar Envoy 経由で ScalarDL Ledger に送信されるためです。 -Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx) を参照してください。 +Scalar Envoy 構成の詳細については、ドキュメント [Scalar Envoy のカスタム値ファイルの構成](configure-custom-values-envoy.mdx)を参照してください。 ```yaml envoy: - configurationsForScalarEnvoy: + configurationsForScalarEnvoy: ... ledger: - configurationsForScalarDLLedger: + configurationsForScalarDLLedger: ... ``` ### 画像構成 -`ledger.image.repository` を設定する必要があります。 コンテナ リポジトリからイメージをプルできるように、ScalarDL Ledger コンテナ イメージを必ず指定してください。 +`ledger.image.repository` を設定する必要があります。コンテナリポジトリからイメージをプルできるように、ScalarDL Ledger コンテナイメージを必ず指定してください。 ```yaml ledger: @@ -33,11 +34,11 @@ ledger: repository: ``` -Scalar 製品のコンテナリポジトリの詳細については、[Scalar 製品のコンテナ イメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx) を参照してください。 +Scalar 製品のコンテナリポジトリの詳細については、[Scalar 製品のコンテナイメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx)を参照してください。 ### Ledger/データベースの構成 -`ledger.ledgerProperties` を設定する必要があります。 `ledger.properties` をこのパラメータに設定してください。 ScalarDL Ledger の構成の詳細については、[ledger.properties](https://github.com/scalar-labs/scalar/blob/master/ledger/conf/ledger.properties) を参照してください。 +`ledger.ledgerProperties` を設定する必要があります。`ledger.properties` をこのパラメータに設定してください。ScalarDL Ledger の構成の詳細については、[ledger.properties](https://github.com/scalar-labs/scalar/blob/master/ledger/conf/ledger.properties) を参照してください。 ```yaml ledger: @@ -55,19 +56,19 @@ ledger: `scalar.dl.ledger.proof.enabled` を `true` に設定した場合 (この設定は ScalarDL Auditor を使用する場合に必要です)、秘密鍵ファイルを `scalar.dl.ledger.proof.private_key_path` に設定する必要があります。 -この場合、秘密キー ファイルを ScalarDL Ledger ポッドにマウントする必要があります。 +この場合、秘密鍵ファイルを ScalarDL Ledger ポッドにマウントする必要があります。 -秘密キー ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドにキーファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする) を参照してください。 +秘密鍵ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドに秘密鍵ファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする)を参照してください。 ## オプションの構成 ### リソース構成 (本番環境で推奨) -Kubernetes のリクエストと制限を使用してポッド リソースを制御したい場合は、`ledger.resources` を使用できます。 +Kubernetes のリクエストと制限を使用してポッドリソースを制御したい場合は、`ledger.resources` を使用できます。 -商用ライセンスの観点から、Scalar 製品の 1 つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。 また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。 この制限を超えると、ポッドは自動的に停止されます。 +商用ライセンスの観点から、Scalar 製品の1つのポッドのリソースは 2vCPU / 4GB メモリに制限されていることに注意してください。また、AWS Marketplace から提供される従量課金制のコンテナを取得する場合、`resources.limits` で 2vCPU / 4GB を超えるメモリ構成でそれらのコンテナを実行することはできません。この制限を超えると、ポッドは自動的に停止されます。 -これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。 そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 +これらは、Kubernetes のリクエストと制限と同じ構文を使用して構成できます。そのため、Kubernetes の要求と制限の詳細については、公式ドキュメント [Resource Management for Pods and Containers](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) を参照してください。 ```yaml ledger: @@ -84,9 +85,9 @@ ledger: 環境変数を使用して `ledger.ledgerProperties` 内の一部のプロパティ (資格情報など) を設定したい場合は、`ledger.secretName` を使用して、いくつかの資格情報を含む Secret リソースを指定できます。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 -Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法](use-secret-for-credentials.mdx) を参照してください。 +Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法](use-secret-for-credentials.mdx)を参照してください。 ```yaml ledger: @@ -97,7 +98,7 @@ ledger: Kubernetes のアフィニティと反アフィニティを使用してポッドのデプロイメントを制御したい場合は、`ledger.affinity` を使用できます。 -Kubernetes のアフィニティと同じ構文を使用して構成できます。 そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 +Kubernetes のアフィニティと同じ構文を使用して構成できます。そのため、Kubernetes のアフィニティ設定の詳細については、公式ドキュメント [Assigning Pods to Nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) を参照してください。 ```yaml ledger: @@ -121,7 +122,7 @@ ledger: ### Prometheus/Grafana 構成 (運用環境で推奨) -[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDL Ledger ポッドを監視する場合は、`ledger.grafanaDashboard.enabled`、`ledger.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。 `enabled` および `ledger.prometheusRule.enabled`。 +[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) を使用して ScalarDL Ledger ポッドを監視する場合は、`ledger.grafanaDashboard.enabled`、`ledger.serviceMonitor` を使用して、kube-prometheus-stack の ConfigMap、ServiceMonitor、および PrometheusRule リソースをデプロイできます。`enabled` および `ledger.prometheusRule.enabled`。 ```yaml ledger: @@ -141,7 +142,7 @@ ledger: ScalarDL Ledger ポッドに SecurityContext と PodSecurityContext を設定したい場合は、`ledger.securityContext` と `ledger.podSecurityContext` を使用できます。 -KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。 したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 +KubernetesのSecurityContextやPodSecurityContextと同じ構文を使用して設定できます。したがって、Kubernetes の SecurityContext および PodSecurityContext 構成の詳細については、公式ドキュメント [Configure a Security Context for a Pod or Container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) を参照してください。 ```yaml ledger: @@ -214,7 +215,7 @@ ledger: privateKeySecret: "scalardl-ledger-tls-key" ``` -この場合、次のように山括弧内の内容を置き換えて、ScalarDL Ledger の秘密鍵と証明書ファイルを含む秘密リソースを作成する必要があります。 +この場合、次のように山括弧内の内容を置き換えて、ScalarDL Ledger の秘密鍵と証明書ファイルを含むシークレットリソースを作成する必要があります。 ```console kubectl create secret generic scalardl-ledger-tls-ca --from-file=ca.crt=/ -n @@ -222,16 +223,16 @@ kubectl create secret generic scalardl-ledger-tls-cert --from-file=tls.crt=/ -n ``` -秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx) を参照してください。 +秘密鍵と証明書ファイルを準備する方法の詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx)を参照してください。 ##### cert-manager で信頼できる CA を使用して秘密鍵と証明書ファイルを管理する -次の構成を使用して、cert-manager で秘密キーと証明書を管理できます。 +次の構成を使用して、cert-manager で秘密鍵と証明書を管理できます。 :::note -* cert-manager を使用する場合は、cert-manager をデプロイし、`Issuers` リソースを準備する必要があります。詳細については、cert-manager のドキュメント、[インストール](https://cert-manager.io/docs/installation/) および [発行者構成](https://cert-manager.io/docs/configuration/) を参照してください。 -* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密キーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements) を参照してください。 +* cert-manager を使用する場合は、cert-manager をデプロイし、`Issuers` リソースを準備する必要があります。詳細については、cert-manager のドキュメント、[インストール](https://cert-manager.io/docs/installation/)および[発行者構成](https://cert-manager.io/docs/configuration/)を参照してください。 +* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements)を参照してください。 ::: @@ -251,12 +252,12 @@ ledger: ##### cert-manager で自己署名 CA を使用して秘密鍵と証明書ファイルを管理する -次の構成を使用して、cert-manager で秘密キーと自己署名証明書を管理できます。 +次の構成を使用して、cert-manager で秘密鍵と自己署名証明書を管理できます。 :::note -* cert-manager を使用する場合は、cert-manager をデプロイする必要があります。詳細については、cert-manager のドキュメント [インストール](https://cert-manager.io/docs/installation/) を参照してください。 -* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密キーと証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements) を参照してください。 +* cert-manager を使用する場合は、cert-manager をデプロイする必要があります。詳細については、cert-manager のドキュメント[インストール](https://cert-manager.io/docs/installation/)を参照してください。 +* デフォルトでは、Scalar Helm Chart は Scalar 製品の証明書要件を満たす `Certificate` リソースを作成します。デフォルトの証明書構成が推奨されますが、カスタム証明書構成を使用する場合は、Scalar 製品の証明書要件を満たす必要があります。詳細については、[Scalar 製品の秘密鍵と証明書ファイルを作成する方法](../scalar-kubernetes/HowToCreateKeyAndCertificateFiles.mdx#certificate-requirements)を参照してください。 ::: @@ -276,7 +277,7 @@ ledger: ##### TLS通信のカスタム権限を設定する -`ledger.tls.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、`ledger.tls.certChainSecret` を使用して設定した証明書チェーン ファイルで提示されるホスト名を指定できます。このチャートでは、`startupProbe` と `livenessProbe` にこの値を使用しています。 +`ledger.tls.overrideAuthority` を使用して、TLS 通信のカスタム権限を設定できます。この値によって、実際に接続されているホストが変わることはありません。この値はテスト用ですが、DNS オーバーライドの代替としてテスト以外でも安全に使用できます。たとえば、`ledger.tls.certChainSecret` を使用して設定した証明書チェーンファイルで提示されるホスト名を指定できます。このチャートでは、`startupProbe` と `livenessProbe` にこの値を使用しています。 ```yaml ledger: @@ -308,7 +309,7 @@ ledger: Kubernetes のテイントと許容を使用してポッドのデプロイメントを制御したい場合は、`ledger.tolerations` を使用できます。 -Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。 Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 +Kubernetes の許容と同じ構文を使用して、テイントと許容を構成できます。Kubernetes での許容設定の詳細については、Kubernetes の公式ドキュメント [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) を参照してください。 ```yaml ledger: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-schema-loader.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-schema-loader.mdx index 262bcf93..9752c87e 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-schema-loader.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/configure-custom-values-scalardl-schema-loader.mdx @@ -1,4 +1,5 @@ --- +displayed_sidebar: docsJapanese --- # ScalarDL Schema Loader のカスタム値ファイルを構成する @@ -7,13 +8,13 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、ScalarDL Schema Loader チャートのカスタム値ファイルを作成する方法について説明します。 パラメータの詳細を知りたい場合は、ScalarDL Schema Loader チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/schema-loading/README.md) を参照してください。 +このドキュメントでは、ScalarDL Schema Loader チャートのカスタム値ファイルを作成する方法について説明します。パラメータの詳細を知りたい場合は、ScalarDL Schema Loader チャートの [README](https://github.com/scalar-labs/helm-charts/blob/main/charts/schema-loading/README.md) を参照してください。 ## 必要な構成 ### データベース構成 -`schemaLoading.databaseProperties` を設定する必要があります。 バックエンド データベースにアクセスするには、`database.properties` をこのパラメータに設定してください。 ScalarDB のデータベース構成の詳細については、[Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb) を参照してください。 +`schemaLoading.databaseProperties` を設定する必要があります。バックエンドデータベースにアクセスするには、`database.properties` をこのパラメータに設定してください。ScalarDB のデータベース構成の詳細については、[Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb) を参照してください。 ```yaml schemaLoading: @@ -49,9 +50,9 @@ schemaLoading: 環境変数を使用して `schemaLoading.databaseProperties` 内の一部のプロパティ (資格情報など) を設定したい場合は、`schemaLoading.secretName` を使用して、いくつかの資格情報を含む Secret リソースを指定できます。 -たとえば、環境変数を使用してバックエンド データベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 +たとえば、環境変数を使用してバックエンドデータベースの資格情報 (`scalar.db.username` および `scalar.db.password`) を設定でき、これによりポッドの安全性が高まります。 -Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法](use-secret-for-credentials.mdx) を参照してください。 +Secret リソースの使用方法の詳細については、ドキュメント [Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法](use-secret-for-credentials.mdx)を参照してください。 ```yaml schemaLoading: @@ -60,7 +61,7 @@ schemaLoading: ### 画像構成 (デフォルト値を推奨) -イメージ リポジトリを変更する場合は、`schemaLoading.image.repository` を使用して、プルする ScalarDL Schema Loader コンテナ イメージのコンテナ リポジトリ情報を指定できます。 +イメージリポジトリを変更する場合は、`schemaLoading.image.repository` を使用して、プルする ScalarDL Schema Loader コンテナイメージのコンテナリポジトリ情報を指定できます。 ```yaml schemaLoading: @@ -70,7 +71,7 @@ schemaLoading: ### フラグ設定 (環境に応じてオプション) -複数のフラグを配列として指定できます。 フラグの詳細については、ドキュメント [ScalarDB Schema Loader](https://scalardb.scalar-labs.com/docs/latest/schema-loader) を参照してください。 +複数のフラグを配列として指定できます。フラグの詳細については、ドキュメント [ScalarDB Schema Loader](https://scalardb.scalar-labs.com/docs/latest/schema-loader) を参照してください。 ```yaml schemaLoading: diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-logging.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-logging.mdx index 1d1733ab..2b25b193 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-logging.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-logging.mdx @@ -1,9 +1,10 @@ --- tags: - Community +displayed_sidebar: docsJapanese --- -# Helm Charts の入門 (Loki スタックを使用したロギング) +# Helm Charts をはじめよう (Loki スタックを使用したロギング) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; @@ -11,7 +12,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; このドキュメントでは、Grafana Loki (Promtail を使用) を使用して、Kubernetes 上で Scalar 製品のログ集約を開始する方法について説明します。 -Scalar 製品の [モニタリングの開始](getting-started-monitoring.mdx) をすでに読み、kube-prometheus-stack をインストールしていることを前提としています。 +Scalar 製品の[モニタリングの開始](getting-started-monitoring.mdx)をすでに読み、kube-prometheus-stack をインストールしていることを前提としています。 ## 私たちが作るもの @@ -49,11 +50,11 @@ Scalar 製品の [モニタリングの開始](getting-started-monitoring.mdx) +---------+ ``` -## ステップ 1. カスタム値ファイルを準備する +## ステップ1. カスタム値ファイルを準備する -1. `loki-stack` helm chart のサンプル ファイル [scalar-loki-stack-custom-values.yaml](./conf/scalar-loki-stack-custom-values.yaml) を取得します。 +1. `loki-stack` helm chart のサンプルファイル [scalar-loki-stack-custom-values.yaml](./conf/scalar-loki-stack-custom-values.yaml) を取得します。 -## ステップ 2. `loki-stack` をデプロイする +## ステップ2. `loki-stack` をデプロイする 1. `grafana` helm リポジトリを追加します。 ```console @@ -65,9 +66,9 @@ Scalar 製品の [モニタリングの開始](getting-started-monitoring.mdx) helm install scalar-logging-loki grafana/loki-stack -n monitoring -f scalar-loki-stack-custom-values.yaml ``` -## ステップ 3. Grafana 構成に Loki データ ソースを追加する +## ステップ3. Grafana 構成に Loki データソースを追加する -1. Loki データ ソースの設定を `scalar-prometheus-custom-values.yaml` ファイルに追加します。 +1. Loki データソースの設定を `scalar-prometheus-custom-values.yaml` ファイルに追加します。 ```yaml grafana: additionalDataSources: @@ -85,14 +86,14 @@ Scalar 製品の [モニタリングの開始](getting-started-monitoring.mdx) helm upgrade scalar-monitoring prometheus-community/kube-prometheus-stack -n monitoring -f scalar-prometheus-custom-values.yaml ``` -## ステップ 4. Grafana ダッシュボードにアクセスする +## ステップ4. Grafana ダッシュボードにアクセスする 1. Loki をデータソースとして追加する - Grafana http://localhost:3000 に移動します (minikube を使用する場合) - `Explore` に移動して、追加された Loki を見つけます - 収集されたログは `Explore` ページで確認できます。 -## ステップ 5. `loki-stack` helm chartを削除する +## ステップ5. `loki-stack` helm chartを削除する 1. `loki-stack` をアンインストールします。 ```console diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-monitoring.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-monitoring.mdx index 099154d4..1010b668 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-monitoring.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-monitoring.mdx @@ -1,15 +1,16 @@ --- tags: - Community +displayed_sidebar: docsJapanese --- -# Helm Charts の入門 (Prometheus Operator を使用したモニタリング) +# Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Prometheus Operator (kube-prometheus-stack) を使用して Kubernetes 上で Scalar 製品の監視を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Prometheus Operator (kube-prometheus-stack) を使用して Kubernetes 上で Scalar 製品の監視を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 私たちが作るもの @@ -39,13 +40,13 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; +---------+ ``` -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -まず、Kubernetes クラスターを準備する必要があります。 **minikube** 環境を使用する場合は、[Scalar Helm Charts の入門](getting-started-scalar-helm-charts.mdx) を参照してください。 すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 +まず、Kubernetes クラスターを準備する必要があります。**minikube** 環境を使用する場合は、[Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx)を参照してください。すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 -## ステップ 2. カスタム値ファイルを準備する +## ステップ2. カスタム値ファイルを準備する -1. `kube-prometheus-stack` のサンプル ファイル [scalar-prometheus-custom-values.yaml](./conf/scalar-prometheus-custom-values.yaml) を保存します。 +1. `kube-prometheus-stack` のサンプルファイル [scalar-prometheus-custom-values.yaml](./conf/scalar-prometheus-custom-values.yaml) を保存します。 1. 次のように `scalar-prometheus-custom-values.yaml` にカスタム値を追加します。 * 設定 @@ -81,7 +82,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; * Helm Chart を使用して Prometheus Operator デプロイメントをカスタマイズする場合は、Scalar 製品を監視するために次の構成を設定する必要があります。 * Prometheus Operator が Scalar 製品の `ServiceMonitor` および `PrometheusRule` を検出できるように、`serviceMonitorSelectorNilUsesHelmValues` および `ruleSelectorNilUsesHelmValues` を `false` (デフォルトでは `true`) に設定します。 - * Scalar Manager を使用する場合は、Scalar Manager が CPU およびメモリ リソースを収集できるように次の構成を設定する必要があります。 + * Scalar Manager を使用する場合は、Scalar Manager が CPU およびメモリリソースを収集できるように次の構成を設定する必要があります。 * `kubeStateMetrics.enabled`、`nodeExporter.enabled`、および `kubelet.enabled` を `true` に設定します。 * Scalar Manager を使用する場合は、Scalar Manager が Grafana を組み込みきるように次の構成を設定する必要があります。 @@ -89,7 +90,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; * `grafana.ini.auth.anonymous.org_name` を使用中の組織に設定します。Scalar のサンプルを使う場合では、`Main Org.` に設定します。 * `grafana.ini.auth.anonymous.org_role` を `Editor` に設定します。 -## ステップ 3. `kube-prometheus-stack` をデプロイする +## ステップ3. `kube-prometheus-stack` をデプロイする 1. `prometheus-community` helm リポジトリを追加します。 ```console @@ -106,10 +107,10 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; helm install scalar-monitoring prometheus-community/kube-prometheus-stack -n monitoring -f scalar-prometheus-custom-values.yaml ``` -## ステップ 4. Helm Chart を使用して Scalar 製品をデプロイ (またはアップグレード) +## ステップ4. Helm Chart を使用して Scalar 製品をデプロイ (またはアップグレード) * 注記： - * 最低限の手順を説明します。 ScalarDB および ScalarDL のデプロイメントについて詳しく知りたい場合は、以下のドキュメントを参照してください。 + * 最低限の手順を説明します。ScalarDB および ScalarDL のデプロイメントについて詳しく知りたい場合は、以下のドキュメントを参照してください。 * [Helm Charts 入門 (ScalarDB Server)](getting-started-scalardb.mdx) * [Helm Charts 入門 (ScalarDL Ledger / Ledger のみ)](getting-started-scalardl-ledger.mdx) * [Helm Charts 入門 (ScalarDL Ledger および Auditor / Auditor モード)](getting-started-scalardl-auditor.mdx) @@ -199,11 +200,11 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; helm upgrade scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml ``` -## ステップ 5. ダッシュボードにアクセスする +## ステップ5. ダッシュボードにアクセスする ### minikube を使用する場合 -1. 各サービス リソースを `localhost (127.0.0.1)` として公開するには、別のターミナルを開き、`minikube tunnel` コマンドを実行します。 +1. 各サービスリソースを `localhost (127.0.0.1)` として公開するには、別のターミナルを開き、`minikube tunnel` コマンドを実行します。 ```console minikube tunnel ``` @@ -246,13 +247,13 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; ### minikube 以外の Kubernetes を使用する場合 -minikube 以外の Kubernetes クラスターを使用する場合は、各 Kubernetes クラスターの方式に従って LoadBalancer サービスにアクセスする必要があります。 たとえば、クラウド サービスによって提供されるロード バランサーや `kubectl port-forward` コマンドを使用します。 +minikube 以外の Kubernetes クラスターを使用する場合は、各 Kubernetes クラスターの方式に従って LoadBalancer サービスにアクセスする必要があります。たとえば、クラウドサービスによって提供されるロードバランサーや `kubectl port-forward` コマンドを使用します。 -## ステップ 6. すべてのリソースを削除する +## ステップ6. すべてのリソースを削除する -Kubernetes クラスターでのモニタリング テストが完了したら、すべてのリソースを削除します。 +Kubernetes クラスターでのモニタリングテストが完了したら、すべてのリソースを削除します。 -1. `minikube tunnel` コマンドを終了します。 (minikubeを使用する場合) +1. `minikube tunnel` コマンドを終了します。(minikubeを使用する場合) ```console Ctrl + C ``` @@ -262,7 +263,7 @@ Kubernetes クラスターでのモニタリング テストが完了したら helm uninstall scalar-monitoring -n monitoring ``` -1. minikube を削除します。 (オプション / minikube を使用する場合) +1. minikube を削除します。(オプション / minikube を使用する場合) ```console minikube delete --all ``` diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-helm-charts.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-helm-charts.mdx index 11ca9c36..3d6e5ef6 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-helm-charts.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-helm-charts.mdx @@ -2,11 +2,12 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- -# Scalar Helm Charts の入門 +# Scalar Helm Charts をはじめよう -このドキュメントでは、Kubernetes クラスター上でテスト環境として Scalar Helm Chart を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上でテスト環境として Scalar Helm Chart を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## ツール @@ -17,17 +18,17 @@ tags: 1. Helm 1. cfssl / cfssljson -## ステップ 1. ツールをインストールする +## ステップ1. ツールをインストールする まず、このガイドで使用する次のツールをインストールする必要があります。 -1. [minikubeドキュメント](https://minikube.sigs.k8s.io/docs/start/) に従って minikube をインストールします。 +1. [minikubeドキュメント](https://minikube.sigs.k8s.io/docs/start/)に従って minikube をインストールします。 -1. [Kubernetesドキュメント](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) に従って kubectl をインストールします。 +1. [Kubernetesドキュメント](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)に従って kubectl をインストールします。 -1. [Helmドキュメント](https://helm.sh/docs/intro/install/) に従って helm コマンドをインストールします。 +1. [Helmドキュメント](https://helm.sh/docs/intro/install/)に従って helm コマンドをインストールします。 -1. [CFSSLドキュメント](https://github.com/cloudflare/cfssl) に従って cfssl と cfssljson をインストールします。 +1. [CFSSLドキュメント](https://github.com/cloudflare/cfssl)に従って cfssl と cfssljson をインストールします。 :::note @@ -40,7 +41,7 @@ tags: ::: -## ステップ 2. docker ドライバーで minikube を起動する (オプション / minikube を使用する場合) +## ステップ2. docker ドライバーで minikube を起動する (オプション / minikube を使用する場合) 1. minikube を起動します。 ```console @@ -64,9 +65,9 @@ tags: ``` minikube が適切に起動すると、いくつかのポッドが kube-system 名前空間で**実行中**であることがわかります。 -## ステップ 3。 +## ステップ3。 -Kubernetes クラスターが起動したら、そのクラスター上で各 Scalar Helm Charts を試すことができます。 詳細については、以下のドキュメントを参照してください。 +Kubernetes クラスターが起動したら、そのクラスター上で各 Scalar Helm Charts を試すことができます。詳細については、以下のドキュメントを参照してください。 * [TLS を使用した ScalarDB Cluster](getting-started-scalardb-cluster-tls.mdx) * [cert-manager を使用した TLS 対応 ScalarDB Cluster](getting-started-scalardb-cluster-tls-cert-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-manager.mdx index 8061a249..beba9546 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalar-manager.mdx @@ -1,6 +1,7 @@ --- tags: - Enterprise Option +displayed_sidebar: docsJapanese --- # Scalar Manager をデプロイする @@ -69,7 +70,7 @@ Scalar Manager をデプロイする前に、次の操作を行う必要があ +---------+ +---------+ ``` -## ステップ 1. minikube を起動します +## ステップ1. minikube を起動します **Terminal** を開き、次のコマンドを実行して minikube を起動します。 @@ -77,7 +78,7 @@ Scalar Manager をデプロイする前に、次の操作を行う必要があ minikube start ``` -## ステップ 2. Grafana を埋め込めるように `kube-prometheus-stack` をアップグレードする +## ステップ2. Grafana を埋め込めるように `kube-prometheus-stack` をアップグレードする `kube-prometheus-stack` のカスタム値ファイル (たとえば `scalar-prometheus-custom-values.yaml`) に、次の構成を追加するか、すでに存在する場合は修正します。 @@ -109,7 +110,7 @@ grafana: helm upgrade scalar-monitoring prometheus-community/kube-prometheus-stack -n monitoring -f scalar-prometheus-custom-values.yaml ``` -## ステップ 3. 環境変数を設定する +## ステップ3. 環境変数を設定する 次のコマンドを実行し、山括弧内の内容を説明に従って置き換えて、Scalar Manager の環境変数を設定します。 @@ -120,14 +121,14 @@ SCALAR_MANAGER_CUSTOM_VALUES_FILE= SCALAR_MANAGER_CHART_VERSION= ``` -## ステップ 4. Scalar Manager のカスタム値ファイルを準備する +## ステップ4. Scalar Manager のカスタム値ファイルを準備する 次の手順に従って、Scalar Manager のカスタム値ファイルを準備します。 1. `scalar-manager-custom-values.yaml` という名前の空のファイルを作成します。 1. [Scalar Manager のカスタム値ファイルを構成する](configure-custom-values-scalar-manager.mdx)の手順に従います。 -## ステップ 5. `scalar-manager` をインストールしてデプロイする +## ステップ5. `scalar-manager` をインストールしてデプロイする 次のコマンドを実行して、`scalar-manager` Helm Chart をインストールしてデプロイします。 @@ -135,7 +136,7 @@ SCALAR_MANAGER_CHART_VERSION= helm install ${SCALAR_MANAGER_RELEASE_NAME} scalar-labs/scalar-manager -n ${SCALAR_MANAGER_NAMESPACE} -f ${SCALAR_MANAGER_CUSTOM_VALUES_FILE} --version ${SCALAR_MANAGER_CHART_VERSION} ``` -## ステップ 6. Scalar Manager にアクセスする +## ステップ6. Scalar Manager にアクセスする Scalar Manager にアクセスする方法は、Kubernetes クラスターに使用しているツールによって異なります。 @@ -182,7 +183,7 @@ helm uninstall ${SCALAR_MANAGER_RELEASE_NAME} -n ${SCALAR_MANAGER_NAMESPACE} ### オプションの Scalar Manager 構成 -Scalar Manager に設定できるオプションの構成については、[オプション設定](./configure-custom-values-scalar-manager.mdx#オプション設定) を参照してください。 +Scalar Manager に設定できるオプションの構成については、[オプション設定](./configure-custom-values-scalar-manager.mdx#オプション設定)を参照してください。 ### リソースの検出 @@ -201,7 +202,7 @@ Scalar Manager は、特定のラベルセレクターを使用して、クラ #### 依存関係 -Scalar Manager は、[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) および [loki-stack](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack) Helm Chart に設定されているデフォルトのラベルと値を検索します。Scalar Manager が依存関係を検出するために使用するデフォルトのラベルと値の詳細については、[`api.applicationProperties` で設定できるプロパティ](./configure-custom-values-scalar-manager.mdx#apiapplicationPropertiesで設定できるプロパティ) を参照してください。 +Scalar Manager は、[kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) および [loki-stack](https://github.com/grafana/helm-charts/tree/main/charts/loki-stack) Helm Chart に設定されているデフォルトのラベルと値を検索します。Scalar Manager が依存関係を検出するために使用するデフォルトのラベルと値の詳細については、[`api.applicationProperties` で設定できるプロパティ](./configure-custom-values-scalar-manager.mdx#apiapplicationProperties-で設定できるプロパティ)を参照してください。 また、`kube-prometheus-stack` または `loki-stack` のインストール時に値をカスタマイズした場合は、Scalar Manager のカスタム値 `api.applicationProperties` のラベルセレクターを更新する必要があります。 diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-analytics-postgresql.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-analytics-postgresql.mdx index 5ff293c6..57f8d795 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-analytics-postgresql.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-analytics-postgresql.mdx @@ -1,15 +1,16 @@ --- tags: - Community +displayed_sidebar: docsJapanese --- -# Helm Charts の入門 (ScalarDB Analytics with PostgreSQL) +# Helm Charts をはじめよう (ScalarDB Analytics with PostgreSQL) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このガイドでは、Kubernetes クラスターの Helm Chart をテスト環境として使用して、ScalarDB Analytics with PostgreSQL を開始する方法について説明します。 さらに、このガイドの内容は、テスト用に Mac または Linux 環境がすでにセットアップされていることを前提としています。 **minikube** について言及していますが、説明されている手順はどの Kubernetes クラスターでも機能するはずです。 +このガイドでは、Kubernetes クラスターの Helm Chart をテスト環境として使用して、ScalarDB Analytics with PostgreSQL を開始する方法について説明します。さらに、このガイドの内容は、テスト用に Mac または Linux 環境がすでにセットアップされていることを前提としています。**minikube** について言及していますが、説明されている手順はどの Kubernetes クラスターでも機能するはずです。 ## あなたが作成するもの @@ -34,19 +35,19 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; | +------------------------------------+ | | | | | | +-------------+ | | -| | OLTP クライアント | ---(テスト OLTP ワークロードでサンプル データをロードする)-----------------------------------------------------------------------+ | +| | OLTP クライアント | ---(テスト OLTP ワークロードでサンプルデータをロードする)-----------------------------------------------------------------------+ | | +-------------+ | | | +-------------------------------------------------------------------------------------------------------------------------------------------+ ``` -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -まず、Kubernetes クラスターを準備する必要があります。 **minikube** 環境を使用している場合は、[Scalar Helm Charts の入門](getting-started-scalar-helm-charts.mdx) を参照してください。 すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 +まず、Kubernetes クラスターを準備する必要があります。**minikube** 環境を使用している場合は、[Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx)を参照してください。すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 -## ステップ 2. MySQL および PostgreSQL ポッドを開始する +## ステップ2. MySQL および PostgreSQL ポッドを開始する -ScalarDB Analytics with PostgreSQL を含むScalarDBは、バックエンドデータベースとして数種類のデータベースシステムを利用できます。 このガイドでは、MySQL と PostgreSQL を使用します。 +ScalarDB Analytics with PostgreSQL を含むScalarDBは、バックエンドデータベースとして数種類のデータベースシステムを利用できます。このガイドでは、MySQL と PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに MySQL と PostgreSQL をデプロイできます。 @@ -98,7 +99,7 @@ ScalarDB Analytics with PostgreSQL を含むScalarDBは、バックエンドデ postgresql-scalardb-0 1/1 Running 0 3m12s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する いくつかの構成ファイルをローカルに作成するので、それらのファイル用の作業ディレクトリを作成します。 @@ -106,13 +107,13 @@ ScalarDB Analytics with PostgreSQL を含むScalarDBは、バックエンドデ mkdir -p ~/scalardb-analytics-postgresql-test/ ``` -## ステップ 4. ScalarDB、ScalarDB Analytics with PostgreSQL、およびチャートのバージョンを設定します +## ステップ4. ScalarDB、ScalarDB Analytics with PostgreSQL、およびチャートのバージョンを設定します -以下の 3 つの環境変数を設定します。 別のバージョンの ScalarDB および ScalarDB Analytics with PostgreSQL を使用する場合は、必ず使用するバージョンに設定してください。 +以下の3つの環境変数を設定します。別のバージョンの ScalarDB および ScalarDB Analytics with PostgreSQL を使用する場合は、必ず使用するバージョンに設定してください。 :::note -ScalarDB Analytics with PostgreSQL のマイナー バージョン (例: 3.10.x) を ScalarDB と同じにする必要がありますが、パッチのバージョンを一致させる必要はありません。 たとえば、ScalarDB 3.10.1 と ScalarDB Analytics with PostgreSQL 3.10.3 を併用できます。 +ScalarDB Analytics with PostgreSQL のマイナーバージョン (例: 3.10.x) を ScalarDB と同じにする必要がありますが、パッチのバージョンを一致させる必要はありません。たとえば、ScalarDB 3.10.1と ScalarDB Analytics with PostgreSQL 3.10.3を併用できます。 ::: @@ -128,17 +129,17 @@ SCALARDB_ANALYTICS_WITH_POSTGRESQL_VERSION=3.10.3 CHART_VERSION=$(helm search repo scalar-labs/scalardb-analytics-postgresql -l | grep -e ${SCALARDB_ANALYTICS_WITH_POSTGRESQL_VERSION} | awk '{print $2}' | sort --version-sort -r | head -n 1) ``` -## ステップ 5. OLTP トランザクションを実行して、サンプル データを MySQL および PostgreSQL にロードします +## ステップ5. OLTP トランザクションを実行して、サンプルデータを MySQL および PostgreSQL にロードします ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザクションを実行してサンプルデータを作成します。 -1. Kubernetes クラスターで OLTP クライアント ポッドを開始します。 +1. Kubernetes クラスターで OLTP クライアントポッドを開始します。 ```console kubectl run oltp-client --image eclipse-temurin:8-jdk-jammy --env SCALARDB_VERSION=${SCALARDB_VERSION} -- sleep inf ``` -1. OLTP クライアント ポッドが実行されているかどうかを確認します。 +1. OLTP クライアントポッドが実行されているかどうかを確認します。 ```console kubectl get pod oltp-client @@ -157,21 +158,21 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク oltp-client 1/1 Running 0 17s ``` -1. OLTP クライアント ポッドで bash を実行します。 +1. OLTP クライアントポッドで bash を実行します。 ```console kubectl exec -it oltp-client -- bash ``` - この手順の後、OLTP クライアント ポッドで各コマンドを実行します。 + この手順の後、OLTP クライアントポッドで各コマンドを実行します。 -1. git および curl コマンドを OLTP クライアント ポッドにインストールします。 +1. git および curl コマンドを OLTP クライアントポッドにインストールします。 ```console apt update && apt install -y curl git ``` -1. ScalarDB サンプル リポジトリのクローンを作成します。 +1. ScalarDB サンプルリポジトリのクローンを作成します。 ```console git clone https://github.com/scalar-labs/scalardb-samples.git @@ -200,19 +201,19 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク cat << 'EOF' > database.properties scalar.db.storage=multi-storage scalar.db.multi_storage.storages=storage0,storage1 - + # Storage 0 scalar.db.multi_storage.storages.storage0.storage=jdbc scalar.db.multi_storage.storages.storage0.contact_points=jdbc:mysql://mysql-scalardb.default.svc.cluster.local:3306/ scalar.db.multi_storage.storages.storage0.username=root scalar.db.multi_storage.storages.storage0.password=mysql - + # Storage 1 scalar.db.multi_storage.storages.storage1.storage=jdbc scalar.db.multi_storage.storages.storage1.contact_points=jdbc:postgresql://postgresql-scalardb.default.svc.cluster.local:5432/postgres scalar.db.multi_storage.storages.storage1.username=postgres scalar.db.multi_storage.storages.storage1.password=postgres - + scalar.db.multi_storage.namespace_mapping=customer:storage0,order:storage1 scalar.db.multi_storage.default_storage=storage1 EOF @@ -224,19 +225,19 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク curl -OL https://github.com/scalar-labs/scalardb/releases/download/v${SCALARDB_VERSION}/scalardb-schema-loader-${SCALARDB_VERSION}.jar ``` -1. Schema Loader を実行してサンプル テーブルを作成します。 +1. Schema Loader を実行してサンプルテーブルを作成します。 ```console java -jar scalardb-schema-loader-${SCALARDB_VERSION}.jar --config database.properties --schema-file schema.json --coordinator ``` -1. サンプル ワークロードの初期データをロードします。 +1. サンプルワークロードの初期データをロードします。 ```console ./gradlew run --args="LoadInitialData" ``` -1. OLTP トランザクションのサンプル ワークロードを実行します。 これらのコマンドを実行すると、サンプル データとしていくつかの `order` エントリが作成されます。 +1. OLTP トランザクションのサンプルワークロードを実行します。これらのコマンドを実行すると、サンプルデータとしていくつかの `order` エントリが作成されます。 ```console ./gradlew run --args="PlaceOrder 1 1:3,2:2" @@ -277,7 +278,7 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク exit ``` -## ステップ 6. ScalarDB Analytics with PostgreSQL のデプロイ +## ステップ6. ScalarDB Analytics with PostgreSQL のデプロイ バックエンドデータベースにScalarDB経由でサンプルデータを作成した後、ScalarDB Analytics with PostgreSQL をデプロイします。 @@ -289,19 +290,19 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク databaseProperties: | scalar.db.storage=multi-storage scalar.db.multi_storage.storages=storage0,storage1 - + # Storage 0 scalar.db.multi_storage.storages.storage0.storage=jdbc scalar.db.multi_storage.storages.storage0.contact_points=jdbc:mysql://mysql-scalardb.default.svc.cluster.local:3306/ scalar.db.multi_storage.storages.storage0.username=root scalar.db.multi_storage.storages.storage0.password=mysql - + # Storage 1 scalar.db.multi_storage.storages.storage1.storage=jdbc scalar.db.multi_storage.storages.storage1.contact_points=jdbc:postgresql://postgresql-scalardb.default.svc.cluster.local:5432/postgres scalar.db.multi_storage.storages.storage1.username=postgres scalar.db.multi_storage.storages.storage1.password=postgres - + scalar.db.multi_storage.namespace_mapping=customer:storage0,order:storage1 scalar.db.multi_storage.default_storage=storage1 schemaImporter: @@ -311,7 +312,7 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク EOF ``` -1. PostgreSQL のスーパーユーザー パスワードを設定するためのシークレット リソースを作成します。 +1. PostgreSQL のスーパーユーザーパスワードを設定するためのシークレットリソースを作成します。 ```console kubectl create secret generic scalardb-analytics-postgresql-superuser-password --from-literal=superuser-password=scalardb-analytics @@ -323,17 +324,17 @@ ScalarDB Analytics with PostgreSQL を導入する前に、OLTPトランザク helm install scalardb-analytics-postgresql scalar-labs/scalardb-analytics-postgresql -n default -f ~/scalardb-analytics-postgresql-test/scalardb-analytics-postgresql-custom-values.yaml --version ${CHART_VERSION} ``` -## ステップ 7. OLAP クライアント ポッドを実行する +## ステップ7. OLAP クライアントポッドを実行する -ScalarDB Analytics with PostgreSQL を介して一部のクエリを実行するには、OLAP クライアント ポッドを実行します。 +ScalarDB Analytics with PostgreSQL を介して一部のクエリを実行するには、OLAP クライアントポッドを実行します。 -1. Kubernetes クラスターで OLAP クライアント ポッドを開始します。 +1. Kubernetes クラスターで OLAP クライアントポッドを開始します。 ```console kubectl run olap-client --image postgres:latest -- sleep inf ``` -1. OLAP クライアント ポッドが実行されているかどうかを確認します。 +1. OLAP クライアントポッドが実行されているかどうかを確認します。 ```console kubectl get pod olap-client @@ -352,17 +353,17 @@ ScalarDB Analytics with PostgreSQL を介して一部のクエリを実行する olap-client 1/1 Running 0 10s ``` -## ステップ 8. ScalarDB Analytics with PostgreSQL を介してサンプル クエリを実行する +## ステップ8. ScalarDB Analytics with PostgreSQL を介してサンプルクエリを実行する -OLAP クライアント ポッドを実行した後、ScalarDB Analytics with PostgreSQL を介していくつかのクエリを実行できます。 +OLAP クライアントポッドを実行した後、ScalarDB Analytics with PostgreSQL を介していくつかのクエリを実行できます。 -1. OLAP クライアント ポッドで bash を実行します。 +1. OLAP クライアントポッドで bash を実行します。 ```console kubectl exec -it olap-client -- bash ``` - この手順の後、OLAP クライアント ポッドで各コマンドを実行します。 + この手順の後、OLAP クライアントポッドで各コマンドを実行します。 1. psqlコマンドを実行して ScalarDB Analytics with PostgreSQL にアクセスします。 @@ -372,7 +373,7 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po パスワードは `scalardb-analytics` です。 -1. `customer.customers` テーブルのサンプル データを読み取ります。 +1. `customer.customers` テーブルのサンプルデータを読み取ります。 ```sql SELECT * FROM customer.customers; @@ -389,7 +390,7 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po (3 rows) ``` -1. `order.orders` テーブルのサンプル データを読み取ります。 +1. `order.orders` テーブルのサンプルデータを読み取ります。 ```sql SELECT * FROM "order".orders; @@ -412,7 +413,7 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po (8 rows) ``` -1. `order.statements` テーブルのサンプル データを読み取ります。 +1. `order.statements` テーブルのサンプルデータを読み取ります。 ```sql SELECT * FROM "order".statements; @@ -437,7 +438,7 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po (10 rows) ``` -1. `order.items` テーブルのサンプル データを読み取ります。 +1. `order.items` テーブルのサンプルデータを読み取ります。 ```sql SELECT * FROM "order".items; @@ -457,7 +458,7 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po (5 rows) ``` -1. `JOIN` クエリを実行します。 例えば以下のように各ユーザーのクレジット残高情報を確認できます。 +1. `JOIN` クエリを実行します。例えば以下のように各ユーザーのクレジット残高情報を確認できます。 ```sql SELECT * FROM ( @@ -493,13 +494,13 @@ OLAP クライアント ポッドを実行した後、ScalarDB Analytics with Po \q ``` -1. OLAP クライアント ポッドを終了します。 +1. OLAP クライアントポッドを終了します。 ```console exit ``` -## ステップ 9. すべてのリソースを削除する +## ステップ9. すべてのリソースを削除する Kubernetes クラスターで ScalarDB Analytics with PostgreSQL テストを完了したら、すべてのリソースを削除します。 @@ -509,19 +510,19 @@ Kubernetes クラスターで ScalarDB Analytics with PostgreSQL テストを完 helm uninstall mysql-scalardb postgresql-scalardb scalardb-analytics-postgresql ``` -1. クライアント ポッドを削除します。 +1. クライアントポッドを削除します。 ```console kubectl delete pod oltp-client olap-client --grace-period 0 ``` -1. 秘密リソースを削除します。 +1. シークレットリソースを削除します。 ```console kubectl delete secrets scalardb-analytics-postgresql-superuser-password ``` -1. 作業ディレクトリとサンプル ファイルを削除します。 +1. 作業ディレクトリとサンプルファイルを削除します。 ```console cd ~ diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls-cert-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls-cert-manager.mdx index 808ea744..988ef514 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls-cert-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls-cert-manager.mdx @@ -2,16 +2,17 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- -# Helm チャート入門 (cert-manager を使用した TLS 対応 ScalarDB Cluster) +# Helm Chart をはじめよう (cert-manager を使用した TLS 対応 ScalarDB Cluster) このチュートリアルでは、テスト環境の Kubernetes クラスターで Helm Charts と cert-manager を使用して、TLS 構成の ScalarDB Cluster を開始する方法について説明します。開始する前に、テスト用の Mac または Linux 環境がすでに用意されている必要があります。また、このチュートリアルでは **minikube** の使用について説明していますが、説明されている手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 -* ScalarDB Cluster のライセンスキー (試用ライセンスまたは商用ライセンス) が必要です。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) ください。 -* TLS をサポートする ScalarDB Cluster 3.12 以降を使用する必要があります。 +* ScalarDB Cluster のライセンスキー (試用ライセンスまたは商用ライセンス) が必要です。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)ください。 +* TLS をサポートする ScalarDB Cluster 3.12以降を使用する必要があります。 ## 作成するもの @@ -59,7 +60,7 @@ cert-manager は、TLS 接続用に次の秘密鍵と証明書ファイルを自 +----------------------+ ``` -Scalar Helm Charts は、Envoy および ScalarDB Cluster の各秘密キーと証明書ファイルを次のように自動的にマウントし、各接続で TLS を有効にします。ルート CA 証明書ファイルはクライアントに手動でマウントします。 +Scalar Helm Charts は、Envoy および ScalarDB Cluster の各秘密鍵と証明書ファイルを次のように自動的にマウントし、各接続で TLS を有効にします。ルート CA 証明書ファイルはクライアントに手動でマウントします。 ``` +-------------------------------------+ +------------------------------------------------+ +--------------------------------+ @@ -79,7 +80,7 @@ ScalarDB Cluster 関連コンポーネント間には、次の接続が存在し ## ステップ1. Kubernetesクラスターを起動してツールをインストールする -Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts の使用開始](getting-started-scalar-helm-charts.mdx) を参照してください。 +Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts の使用開始](getting-started-scalar-helm-charts.mdx)を参照してください。 ## ステップ2. PostgreSQLコンテナを起動する @@ -222,7 +223,7 @@ ScalarDB Cluster では、バックエンドデータベースとして何らか self-signed-issuer True 6s ``` -## ステップ 5. Helm Charts を使用して Kubernetes クラスターに ScalarDB Cluster をデプロイする +## ステップ5. Helm Charts を使用して Kubernetes クラスターに ScalarDB Cluster をデプロイする 1. Scalar Helm Charts リポジトリを追加します。 @@ -230,7 +231,7 @@ ScalarDB Cluster では、バックエンドデータベースとして何らか helm repo add scalar-labs https://scalar-labs.github.io/helm-charts ``` -1. ライセンス キーと証明書を環境変数として設定します。ライセンスキーがない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) ください。`` の値の詳細については、[製品ライセンスキーを構成する方法](https://scalardb.scalar-labs.com/docs/latest/scalar-licensing/) を参照してください。 +1. ライセンスキーと証明書を環境変数として設定します。ライセンスキーがない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)ください。`` の値の詳細については、[製品ライセンスキーを構成する方法](https://scalardb.scalar-labs.com/docs/latest/scalar-licensing/)を参照してください。 ```console SCALAR_DB_CLUSTER_LICENSE_KEY='' @@ -350,7 +351,7 @@ ScalarDB Cluster では、バックエンドデータベースとして何らか scalardb-cluster-node-7c6959c79d-4z54q 1/1 Running 0 18s scalardb-cluster-node-7c6959c79d-vcv96 1/1 Running 0 18s ``` - + ScalarDB Cluster ポッドが適切にデプロイされている場合、それらのポッドの `STATUS` 列には `Running` と表示されます。 1. ScalarDB Cluster サービスがデプロイされているかどうかを確認します。 @@ -451,7 +452,7 @@ CA 証明書ファイルはクライアントコンテナーで使用します ```console kubectl exec -it scalardb-cluster-client -n default -- bash ``` - + 次の手順のコマンドは、クライアントコンテナーで実行する必要があります。 1. [リリース](https://github.com/scalar-labs/scalardb/releases)から ScalarDB Cluster SQL CLI をダウンロードします。 @@ -492,7 +493,7 @@ CA 証明書ファイルはクライアントコンテナーで使用します CREATE NAMESPACE ns; ``` -1. 名前空間 `ns` の下に `tbl` という名前のサンプル テーブルを作成します。 +1. 名前空間 `ns` の下に `tbl` という名前のサンプルテーブルを作成します。 ```sql CREATE TABLE ns.tbl (a INT, b INT, c INT, PRIMARY KEY(a, b)); @@ -590,6 +591,6 @@ Kubernetes クラスターで ScalarDB Cluster テストを完了したら、す Scalar 製品の監視またはログ記録を開始する方法については、次のチュートリアルを参照してください。 -* [Helm チャートの使用開始 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm チャートの使用開始 (Loki Stack を使用したログ記録)](getting-started-logging.mdx) -* [Helm チャートの使用開始 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki Stack を使用したログ記録)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls.mdx index 64c29fa9..52e928be 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb-cluster-tls.mdx @@ -2,15 +2,16 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- -# Helm チャートの入門 (TLS を使用した ScalarDB Cluster) +# Helm Charts をはじめよう (TLS を使用した ScalarDB Cluster) -このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、TLS 構成で ScalarDB クラスターを開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、TLS 構成で ScalarDB Cluster を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 -* ScalarDB Cluster のライセンスキー（トライアルライセンスまたは商用ライセンス）を取得する必要があります。 ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) してください。 +* ScalarDB Cluster のライセンスキー (トライアルライセンスまたは商用ライセンス) を取得する必要があります。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)してください。 * TLSをサポートするScalarDB Cluster v3.12以降を使用する必要があります。 ## 作成するもの @@ -37,7 +38,7 @@ tags: +----------------------------------------------------------------------------------------------------------------------------------------------------+ ``` -TLS 接続用に次の秘密キーファイルと証明書ファイルを作成します。 +TLS 接続用に次の秘密鍵ファイルと証明書ファイルを作成します。 ``` +-------------------------------+ @@ -55,7 +56,7 @@ TLS 接続用に次の秘密キーファイルと証明書ファイルを作成 +-------------------------------+ ``` -各接続で TLS を有効にするために、各秘密キーと証明書ファイルを次のように設定します。 +各接続で TLS を有効にするために、各秘密鍵と証明書ファイルを次のように設定します。 ``` +--------------------------------+ +-----------------------------------------+ +-----------------------------------------+ @@ -71,15 +72,15 @@ ScalarDB Cluster 関連コンポーネント間には、次の接続がありま * **`クライアント - ScalarDB Cluster の Envoy`:** 一部のCRUD APIやSQL APIを実行すると、クライアントはEnvoy for ScalarDB Clusterにアクセスします。 * **`ScalarDB Cluster の Envoy - ScalarDB Cluster`:** Envoy は、ScalarDB Cluster の前の L7 (gRPC) ロードバランサーとして機能します。 -* **`ScalarDB Cluster ノード - ScalarDB Cluster ノード`:** ScalarDB Cluster ノードから別の ScalarDB Cluster ノードにアクセスします。 言い換えれば、すべての ScalarDB Cluster ノード間でクラスターの内部通信が行われます。 +* **`ScalarDB Cluster ノード - ScalarDB Cluster ノード`:** ScalarDB Cluster ノードから別の ScalarDB Cluster ノードにアクセスします。言い換えれば、すべての ScalarDB Cluster ノード間でクラスターの内部通信が行われます。 -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。 インストール方法の詳細については、[Scalar Helm Charts の開始](getting-started-scalar-helm-charts.mdx) を参照してください。 +Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx)を参照してください。 -## ステップ 2. PostgreSQL コンテナーを開始する +## ステップ2. PostgreSQL コンテナーを開始する -ScalarDB Cluster は、バックエンドデータベースとして何らかのデータベースシステムを使用する必要があります。 このチュートリアルでは、PostgreSQL を使用します。 +ScalarDB Cluster は、バックエンドデータベースとして何らかのデータベースシステムを使用する必要があります。このチュートリアルでは、PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -89,7 +90,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの helm repo add bitnami https://charts.bitnami.com/bitnami ``` -1. ScalarDB クラスター用の PostgreSQL をデプロイします。 +1. ScalarDB Cluster 用の PostgreSQL をデプロイします。 ```console helm install postgresql-scalardb-cluster bitnami/postgresql \ @@ -111,9 +112,9 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの postgresql-scalardb-cluster-0 1/1 Running 0 34s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する -いくつかの構成ファイルと秘密キーおよび証明書ファイルをローカルに作成します。 したがって、それらの作業ディレクトリを作成します。 +いくつかの構成ファイルと秘密鍵および証明書ファイルをローカルに作成します。したがって、それらの作業ディレクトリを作成します。 1. 作業ディレクトリを作成します。 @@ -121,9 +122,9 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの mkdir -p ${HOME}/scalardb-cluster-test/certs/ ``` -## ステップ 4. 秘密キーおよび証明書ファイルを作成する +## ステップ4. 秘密鍵および証明書ファイルを作成する -秘密キーと証明書ファイルを作成します。 +秘密鍵と証明書ファイルを作成します。 1. 作業ディレクトリを `${HOME}/scalardb-cluster-test/certs/` ディレクトリに変更します。 @@ -153,7 +154,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの EOF ``` -1. CA の鍵/証明書ファイルを作成します。 +1. CA の秘密鍵/証明書ファイルを作成します。 ```console cfssl gencert -initca ca.json | cfssljson -bare ca @@ -235,19 +236,19 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの EOF ``` -1. Envoy の秘密キーおよび証明書ファイルを作成します。 +1. Envoy の秘密鍵および証明書ファイルを作成します。 ```console cfssl gencert -ca ca.pem -ca-key ca-key.pem -config ca-config.json -profile scalar-test-ca envoy.json | cfssljson -bare envoy ``` -1. ScalarDB Cluster の秘密キーおよび証明書ファイルを作成します。 +1. ScalarDB Cluster の秘密鍵および証明書ファイルを作成します。 ```console cfssl gencert -ca ca.pem -ca-key ca-key.pem -config ca-config.json -profile scalar-test-ca scalardb-cluster.json | cfssljson -bare scalardb-cluster ``` -1. 秘密キーおよび証明書ファイルが作成されたことを確認します。 +1. 秘密鍵および証明書ファイルが作成されたことを確認します。 ```console ls -1 @@ -271,7 +272,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの scalardb-cluster.pem ``` -## ステップ 5. Helm チャートを使用して Kubernetes クラスターに ScalarDB Cluster をデプロイする +## ステップ5. Helm Charts を使用して Kubernetes クラスターに ScalarDB Cluster をデプロイする 1. Scalar helm リポジトリを追加します。 @@ -343,14 +344,14 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの EOF ``` -1. ライセンスキーと証明書を環境変数に設定します。 ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) してください。 +1. ライセンスキーと証明書を環境変数に設定します。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)してください。 ```console SCALAR_DB_CLUSTER_LICENSE_KEY= SCALAR_DB_CLUSTER_LICENSE_CHECK_CERT_PEM= ``` -1. 資格情報とライセンスキーを含むシークレット リソース「scalardb-credentials-secret」を作成します。 +1. 資格情報とライセンスキーを含むシークレットリソース「scalardb-credentials-secret」を作成します。 ```console kubectl create secret generic scalardb-credentials-secret \ @@ -361,14 +362,14 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの -n default ``` -1. Envoy の秘密キーファイルと証明書ファイルを含むシークレットリソースを作成します。 +1. Envoy の秘密鍵ファイルと証明書ファイルを含むシークレットリソースを作成します。 ```console kubectl create secret generic envoy-tls-cert --from-file=tls.crt=${HOME}/scalardb-cluster-test/certs/envoy.pem -n default kubectl create secret generic envoy-tls-key --from-file=tls.key=${HOME}/scalardb-cluster-test/certs/envoy-key.pem -n default ``` -1. ScalarDB Cluster の秘密キー、証明書、CA 証明書ファイルを含むシークレットリソースを作成します。 +1. ScalarDB Cluster の秘密鍵、証明書、CA 証明書ファイルを含むシークレットリソースを作成します。 ```console kubectl create secret generic scalardb-cluster-tls-ca --from-file=ca.crt=${HOME}/scalardb-cluster-test/certs/ca.pem -n default @@ -427,7 +428,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの scalardb-cluster-headless ClusterIP None 60053/TCP 40s scalardb-cluster-metrics ClusterIP 10.96.199.135 9080/TCP 40s ``` - ScalarDB クラスター サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。 + ScalarDB Cluster サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。 :::note @@ -435,9 +436,9 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの ::: -## ステップ 6. クライアントコンテナを開始する +## ステップ6. クライアントコンテナを開始する -クライアントコンテナでCAの証明書ファイルを使用します。 そこで、シークレットリソースを作成し、クライアントコンテナにマウントします。 +クライアントコンテナでCAの証明書ファイルを使用します。そこで、シークレットリソースを作成し、クライアントコンテナにマウントします。 1. シークレットリソース `client-ca-cert` を作成します。 @@ -475,7 +476,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの EOF ``` -1. マニフェスト ファイルで ScalarDB Cluster のバージョンを設定します。 +1. マニフェストファイルで ScalarDB Cluster のバージョンを設定します。 ```console sed -i s/SCALAR_DB_CLUSTER_CLIENT_POD_SCALAR_DB_CLUSTER_VERSION/${SCALAR_DB_CLUSTER_VERSION}/ ${HOME}/scalardb-cluster-test/scalardb-cluster-client-pod.yaml @@ -500,17 +501,17 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの scalardb-cluster-client 1/1 Running 0 26s ``` -## ステップ 7. ScalarDB Cluster SQL CLI をダウンロードしてクライアント コンテナにコピーします +## ステップ7. ScalarDB Cluster SQL CLI をダウンロードしてクライアントコンテナにコピーします -1. ScalarDB Cluster SQL CLI を [リリース](https://github.com/scalar-labs/scalardb/releases) からディレクトリ `${HOME}/scalardb-cluster-test/` の下にダウンロードします。 +1. ScalarDB Cluster SQL CLI を [リリース](https://github.com/scalar-labs/scalardb/releases)からディレクトリ `${HOME}/scalardb-cluster-test/` の下にダウンロードします。 -1. ScalarDB Cluster SQL CLI をクライアント コンテナにコピーします。 +1. ScalarDB Cluster SQL CLI をクライアントコンテナにコピーします。 ```console kubectl cp ${HOME}/scalardb-cluster-test/scalardb-cluster-sql-cli-${SCALAR_DB_CLUSTER_VERSION}-all.jar scalardb-cluster-client:/ ``` -## ステップ 8. クライアントコンテナで ScalarDB Cluster SQL CLI を実行する +## ステップ8. クライアントコンテナで ScalarDB Cluster SQL CLI を実行する 1. クライアントコンテナで bash を実行します。 @@ -551,7 +552,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの CREATE NAMESPACE ns; ``` -1. 名前空間 `ns` の下にサンプル テーブル `tbl` を作成します。 +1. 名前空間 `ns` の下にサンプルテーブル `tbl` を作成します。 ```sql CREATE TABLE ns.tbl (a INT, b INT, c INT, PRIMARY KEY(a, b)); @@ -563,7 +564,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの INSERT INTO ns.tbl VALUES (1,2,3), (4,5,6), (7,8,9); ``` -1. 挿入したサンプル レコードを選択します。 +1. 挿入したサンプルレコードを選択します。 ```sql SELECT * FROM ns.tbl; @@ -583,7 +584,7 @@ ScalarDB Cluster は、バックエンドデータベースとして何らかの 3 rows selected (0.059 seconds) ``` -## ステップ 9. すべてのリソースを削除する +## ステップ9. すべてのリソースを削除する Kubernetes クラスターで ScalarDB Cluster のテストが完了したら、すべてのリソースを削除します。 @@ -605,7 +606,7 @@ Kubernetes クラスターで ScalarDB Cluster のテストが完了したら、 kubectl delete secrets scalardb-credentials-secret scalardb-cluster-tls-key scalardb-cluster-tls-cert scalardb-cluster-tls-ca envoy-tls-key envoy-tls-cert client-ca-cert ``` -1. 作業ディレクトリとサンプル ファイル (構成ファイル、秘密キー、および証明書) を削除します。 +1. 作業ディレクトリとサンプルファイル (構成ファイル、秘密鍵、および証明書) を削除します。 ```console cd ${HOME} @@ -619,6 +620,6 @@ Kubernetes クラスターで ScalarDB Cluster のテストが完了したら、 Scalar 製品の監視またはログ記録を開始する方法については、次のドキュメントで説明しています。 -* [Helm Charts の入門 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm Charts の入門 (Loki スタックを使用したロギング)](getting-started-logging.mdx) -* [Helm Charts の入門 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki スタックを使用したロギング)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb.mdx index 3170287a..3c6ba2c4 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardb.mdx @@ -3,9 +3,10 @@ tags: - Enterprise Standard - Enterprise Premium - Deprecated +displayed_sidebar: docsJapanese --- -# [非推奨] Helm Charts の入門 (ScalarDB Server) +# [非推奨] Helm Charts をはじめよう (ScalarDB Server) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; @@ -13,15 +14,15 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; :::note -ScalarDB Server は非推奨になりました。 代わりに [ScalarDB Cluster](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart) を使用してください。 +ScalarDB Server は非推奨になりました。代わりに [ScalarDB Cluster](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart) を使用してください。 ::: -このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDB Server を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDB Server を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 -※コンテナイメージ(`scalardb-server` および `scalardb-envoy`)を取得するには、[AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-rzbuhxgvqf4d2) または[Azure Marketplace](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardb) で ScalarDB を購読する必要があります。 詳細については、以下のドキュメントを参照してください。 +※コンテナイメージ (`scalardb-server` および `scalardb-envoy`) を取得するには、[AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-rzbuhxgvqf4d2) または [Azure Marketplace](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardb) で ScalarDB を購読する必要があります。詳細については、以下のドキュメントを参照してください。 * [How to install Scalar products through AWS Marketplace](../scalar-kubernetes/AwsMarketplaceGuide.mdx) * [How to install Scalar products through Azure Marketplace](../scalar-kubernetes/AzureMarketplaceGuide.mdx) @@ -50,13 +51,13 @@ ScalarDB Server は非推奨になりました。 代わりに [ScalarDB Cluster +--------------------------------------------------------------------------------------------------------------------------------------+ ``` -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -まず、Kubernetes クラスターを準備する必要があります。 **minikube** 環境を使用する場合は、[Scalar Helm Charts の入門](getting-started-scalar-helm-charts.mdx) を参照してください。 すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 +まず、Kubernetes クラスターを準備する必要があります。**minikube** 環境を使用する場合は、[Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx)を参照してください。すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 -## ステップ 2. PostgreSQL コンテナーを開始する +## ステップ2. PostgreSQL コンテナーを開始する -ScalarDB は、バックエンド データベースとして何らかのデータベース システムを使用します。 このドキュメントでは PostgreSQL を使用します。 +ScalarDB は、バックエンドデータベースとして何らかのデータベースシステムを使用します。このドキュメントでは PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -82,14 +83,14 @@ ScalarDB は、バックエンド データベースとして何らかのデー postgresql-scalardb-0 1/1 Running 0 2m42s ``` -## ステップ 3. Helm Charts を使用して Kubernetes クラスターに ScalarDB Server をデプロイする +## ステップ3. Helm Charts を使用して Kubernetes クラスターに ScalarDB Server をデプロイする 1. Scalar helm リポジトリを追加します。 ```console helm repo add scalar-labs https://scalar-labs.github.io/helm-charts ``` -1. AWS/Azure Marketplace から ScalarDB コンテナー イメージをプルするためのシークレット リソースを作成します。 +1. AWS/Azure Marketplace から ScalarDB コンテナーイメージをプルするためのシークレットリソースを作成します。 * AWS Marketplace ```console kubectl create secret docker-registry reg-ecr-mp-secrets \ @@ -106,7 +107,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー ``` 詳細については、以下のドキュメントを参照してください。 - + * [How to install Scalar products through AWS Marketplace](../scalar-kubernetes/AwsMarketplaceGuide.mdx) * [How to install Scalar products through Azure Marketplace](../scalar-kubernetes/AzureMarketplaceGuide.mdx) @@ -121,7 +122,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー version: "1.3.0" imagePullSecrets: - name: "reg-ecr-mp-secrets" - + scalardb: image: repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-server" @@ -138,7 +139,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー ``` * Azure Marketplace - + ```console cat << 'EOF' > scalardb-custom-values.yaml envoy: @@ -147,7 +148,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー version: "1.3.0" imagePullSecrets: - name: "reg-acr-secrets" - + scalardb: image: repository: "/scalarinc/scalardb-server" @@ -207,11 +208,11 @@ ScalarDB は、バックエンド データベースとして何らかのデー scalardb-headless ClusterIP None 60051/TCP 41s scalardb-metrics ClusterIP 10.108.188.10 8080/TCP 41s ``` - ScalarDB Server サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。 (注記： `scalardb-headless` には CLUSTER-IP がありません。) + ScalarDB Server サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。(注記： `scalardb-headless` には CLUSTER-IP がありません。) -## ステップ 4. クライアントコンテナを開始する +## ステップ4. クライアントコンテナを開始する -1. Kubernetes クラスター上でクライアント コンテナーを起動します。 +1. Kubernetes クラスター上でクライアントコンテナーを起動します。 ```console kubectl run scalardb-client --image eclipse-temurin:8-jdk --command sleep inf ``` @@ -226,17 +227,17 @@ ScalarDB は、バックエンド データベースとして何らかのデー scalardb-client 1/1 Running 0 23s ``` -## ステップ 5. クライアント コンテナで ScalarDB サンプル アプリケーションを実行する +## ステップ5. クライアントコンテナで ScalarDB サンプルアプリケーションを実行する -以下に最低限の手順を説明します。 ScalarDB についてさらに詳しく知りたい場合は、[Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb) を参照してください。 +以下に最低限の手順を説明します。ScalarDB についてさらに詳しく知りたい場合は、[Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb) を参照してください。 1. クライアントコンテナで bash を実行します。 ```console kubectl exec -it scalardb-client -- bash ``` - この手順の後、クライアント コンテナで各コマンドを実行します。 + この手順の後、クライアントコンテナで各コマンドを実行します。 -1. git およびcurl コマンドをクライアント コンテナにインストールします。 +1. git およびcurl コマンドをクライアントコンテナにインストールします。 ```console apt update && apt install -y git curl ``` @@ -266,13 +267,13 @@ ScalarDB は、バックエンド データベースとして何らかのデー git branch ``` 【コマンド実行結果】 - + ```console master * v3.7.0 ``` - 別のバージョンを使用する場合は、使用するバージョン（タグ）を指定してください。 + 別のバージョンを使用する場合は、使用するバージョン (タグ) を指定してください。 1. ディレクトリを `docs/getting-started/` に変更します。 ```console @@ -302,7 +303,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー EOF ``` -1. サンプル アプリケーションの DB スキーマを定義する JSON ファイル (emoney-transaction.json) を作成します。 +1. サンプルアプリケーションの DB スキーマを定義する JSON ファイル (emoney-transaction.json) を作成します。 ```console cat << 'EOF' > emoney-transaction.json { @@ -326,7 +327,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー java -jar ./scalardb-schema-loader-3.7.0.jar --config ./scalardb.properties -f emoney-transaction.json --coordinator ``` -1. サンプル アプリケーションを実行します。 +1. サンプルアプリケーションを実行します。 * `1000` を `user1` に請求します。 ```console ./gradlew run --args="-action charge -amount 1000 -to user1" @@ -348,7 +349,7 @@ ScalarDB は、バックエンド データベースとして何らかのデー ./gradlew run --args="-action getBalance -id merchant1" ``` -1. (オプション) 次のコマンドを使用して、サンプル アプリケーションを通じて挿入および変更された (INSERT/UPDATE) データを確認できます。 (このコマンドは、クライアント コンテナではなくローカルホストで実行する必要があります。) +1. (オプション) 次のコマンドを使用して、サンプルアプリケーションを通じて挿入および変更された (INSERT/UPDATE) データを確認できます。(このコマンドは、クライアントコンテナではなくローカルホストで実行する必要があります。) ```console kubectl exec -it postgresql-scalardb-0 -- bash -c 'export PGPASSWORD=postgres && psql -U postgres -d postgres -c "SELECT * FROM emoney.account"' ``` @@ -361,9 +362,9 @@ ScalarDB は、バックエンド データベースとして何らかのデー (2 rows) ``` * 注記： - * 通常はScalarDB経由でデータ(レコード)にアクセスする必要があります。 上記のコマンドはサンプルアプリケーションの動作を説明、確認するために使用します。 + * 通常はScalarDB経由でデータ (レコード) にアクセスする必要があります。上記のコマンドはサンプルアプリケーションの動作を説明、確認するために使用します。 -## ステップ 6. すべてのリソースを削除する +## ステップ6. すべてのリソースを削除する Kubernetes クラスター上で ScalarDB Server テストが完了したら、すべてのリソースを削除します。 @@ -381,6 +382,6 @@ Kubernetes クラスター上で ScalarDB Server テストが完了したら、 Scalar 製品の監視またはログ記録を開始する方法については、次のドキュメントで説明しています。 -* [Helm Charts の入門 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm Charts の入門 (Loki スタックを使用したロギング)](getting-started-logging.mdx) -* [Helm Charts の入門 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki スタックを使用したロギング)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls-cert-manager.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls-cert-manager.mdx index 107eaed5..e79d1fe6 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls-cert-manager.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls-cert-manager.mdx @@ -1,14 +1,15 @@ --- +displayed_sidebar: docsJapanese --- -# Helm チャートを使い始める (cert-manager / Auditor モードを使用した TLS 対応の ScalarDL Ledger および Auditor) +# Helm Charts をはじめよう (cert-manager / Auditor モードを使用した TLS 対応の ScalarDL Ledger および Auditor) このチュートリアルでは、Kubernetes クラスターでテスト環境として Helm Charts と cert-manager を使用して、TLS 構成で ScalarDL Ledger と ScalarDL Auditor を使い始める方法について説明します。開始する前に、テスト用の Mac または Linux 環境を用意しておく必要があります。また、このチュートリアルでは **minikube** の使用について説明していますが、説明されている手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 -* ScalarDL のライセンスキー (試用ライセンスまたは商用ライセンス) が必要です。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) ください。 -* TLS をサポートする ScalarDL 3.9 以降を使用する必要があります。 +* ScalarDL のライセンスキー (試用ライセンスまたは商用ライセンス) が必要です。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)ください。 +* TLS をサポートする ScalarDL 3.9以降を使用する必要があります。 :::note @@ -81,7 +82,7 @@ cert-manager は、TLS 接続用に次の秘密鍵と証明書ファイルを自 +----------------------+ ``` -Scalar Helm Charts は、各接続で TLS を有効にするために、Envoy と ScalarDL の各秘密キーと証明書ファイルを次のように自動的にマウントします。ルート CA 証明書ファイルはクライアントに手動でマウントします。 +Scalar Helm Charts は、各接続で TLS を有効にするために、Envoy と ScalarDL の各秘密鍵と証明書ファイルを次のように自動的にマウントします。ルート CA 証明書ファイルはクライアントに手動でマウントします。 ``` +------------------------------------------------+ +--------------------------------------+ @@ -110,17 +111,17 @@ ScalarDL 関連コンポーネント間には、次の接続が存在します: * **`クライアント - ScalarDL Ledger 用 Envoy`:** ScalarDL API 関数を実行すると、クライアントは ScalarDL Ledger 用 Envoy にアクセスします。 * **`クライアント - ScalarDL Auditor 用 Envoy`:** ScalarDL API 関数を実行すると、クライアントは ScalarDL Auditor 用 Envoy にアクセスします。 -* **`ScalarDL Ledger 用 Envoy - ScalarDL Ledger`:** Envoy は ScalarDL Ledger の前で L7 (gRPC) ロード バランサーとして機能します。 -* **`ScalarDL Auditor 用 Envoy - ScalarDL Auditor`:** Envoy は ScalarDL Auditor の前で L7 (gRPC) ロード バランサーとして機能します。 +* **`ScalarDL Ledger 用 Envoy - ScalarDL Ledger`:** Envoy は ScalarDL Ledger の前で L7 (gRPC) ロードバランサーとして機能します。 +* **`ScalarDL Auditor 用 Envoy - ScalarDL Auditor`:** Envoy は ScalarDL Auditor の前で L7 (gRPC) ロードバランサーとして機能します。 * **`ScalarDL Auditor - Envoy for ScalarDL Ledger (ScalarDL Ledger)`:** ScalarDL がデータの一貫性を保つために回復プロセスを実行する必要がある場合、ScalarDL Auditor は Envoy を介して ScalarDL Ledger に対してリクエストを実行します。 -## ステップ 1. Kubernetes クラスターを起動してツールをインストールする +## ステップ1. Kubernetes クラスターを起動してツールをインストールする -Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts の使用開始](getting-started-scalar-helm-charts.mdx) を参照してください。 +Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts の使用開始](getting-started-scalar-helm-charts.mdx)を参照してください。 -## ステップ 2. PostgreSQL コンテナを起動する +## ステップ2. PostgreSQL コンテナを起動する -ScalarDL Ledger と ScalarDL Auditor は、バックエンド データベースとして何らかのデータベース システムを使用する必要があります。このチュートリアルでは、PostgreSQL を使用します。 +ScalarDL Ledger と ScalarDL Auditor は、バックエンドデータベースとして何らかのデータベースシステムを使用する必要があります。このチュートリアルでは、PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -162,7 +163,7 @@ ScalarDL Ledger と ScalarDL Auditor は、バックエンド データベース postgresql-ledger-0 1/1 Running 0 16s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する ローカルにいくつかの構成ファイルと秘密鍵および証明書ファイルを作成します。必ずそれらのファイル用の作業ディレクトリを作成してください。 @@ -172,7 +173,7 @@ ScalarDL Ledger と ScalarDL Auditor は、バックエンド データベース mkdir -p ${HOME}/scalardl-test/ ``` -## ステップ 4. cert-manager と発行者リソースをデプロイする +## ステップ4. cert-manager と発行者リソースをデプロイする このチュートリアルでは、cert-manager を使用して秘密鍵と証明書を発行および管理します。次のようにして、Kubernetes クラスターに cert-manager をデプロイできます。 @@ -269,9 +270,9 @@ ScalarDL Ledger と ScalarDL Auditor は、バックエンド データベース self-signed-issuer True 6s ``` -## ステップ 5. Helm Charts を使用して ScalarDL Ledger と ScalarDL Auditor のデータベーススキーマを作成する +## ステップ5. Helm Charts を使用して ScalarDL Ledger と ScalarDL Auditor のデータベーススキーマを作成する -Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Schema Loader ポッドをデプロイします。ScalarDL Schema Loader は、PostgreSQL に ScalarDL Ledger と Auditor のデータベーススキーマを作成します。 +Helm Charts を使用して、Kubernetes クラスターに2つの ScalarDL Schema Loader ポッドをデプロイします。ScalarDL Schema Loader は、PostgreSQL に ScalarDL Ledger と Auditor のデータベーススキーマを作成します。 1. Scalar Helm Charts リポジトリを追加します。 @@ -327,26 +328,26 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc -n default ``` -1. ScalarDL スキーマローダーのチャートバージョンを設定します。 +1. ScalarDL Schema Loader のチャートバージョンを設定します。 ```console SCALAR_DL_VERSION=3.9.1 SCALAR_DL_SCHEMA_LOADER_CHART_VERSION=$(helm search repo scalar-labs/schema-loading -l | grep -F "${SCALAR_DL_VERSION}" | awk '{print $2}' | sort --version-sort -r | head -n 1) ``` -1. ScalarDL Ledger 用の ScalarDL スキーマローダーをデプロイします。 +1. ScalarDL Ledger 用の ScalarDL Schema Loader をデプロイします。 ```console helm install schema-loader-ledger scalar-labs/schema-loading -f ${HOME}/scalardl-test/schema-loader-ledger-custom-values.yaml --version ${SCALAR_DL_SCHEMA_LOADER_CHART_VERSION} -n default ``` -1. ScalarDL Auditor 用の ScalarDL スキーマローダーをデプロイします。 +1. ScalarDL Auditor 用の ScalarDL Schema Loader をデプロイします。 ```console helm install schema-loader-auditor scalar-labs/schema-loading -f ${HOME}/scalardl-test/schema-loader-auditor-custom-values.yaml --version ${SCALAR_DL_SCHEMA_LOADER_CHART_VERSION} -n default ``` -1. ScalarDL スキーマローダーポッドが「完了」ステータスでデプロイされているかどうかを確認します。 +1. ScalarDL Schema Loader ポッドが「完了」ステータスでデプロイされているかどうかを確認します。 ```console kubectl get pod -n default @@ -361,12 +362,12 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc schema-loader-auditor-schema-loading-dvc5r 0/1 Completed 0 6s schema-loader-ledger-schema-loading-mtllb 0/1 Completed 0 10s ``` - - ScalarDL スキーマローダーポッドのステータスが **ContainerCreating** または **Running** の場合、それらのポッドの `STATUS` 列に `Completed` と表示されるまで待ちます。 -## ステップ 6. Helm Charts を使用して、Kubernetes クラスターに ScalarDL Ledger と ScalarDL Auditor をデプロイします + ScalarDL Schema Loader ポッドのステータスが **ContainerCreating** または **Running** の場合、それらのポッドの `STATUS` 列に `Completed` と表示されるまで待ちます。 -1. ライセンスキーと証明書を環境変数として設定します。ライセンスキーがない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) ください。`` と `` の値の詳細については、[製品ライセンス キーを構成する方法](https://scalardl.scalar-labs.com/docs/latest/scalar-licensing/) を参照してください。 +## ステップ6. Helm Charts を使用して、Kubernetes クラスターに ScalarDL Ledger と ScalarDL Auditor をデプロイします + +1. ライセンスキーと証明書を環境変数として設定します。ライセンスキーがない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)ください。`` と `` の値の詳細については、[製品ライセンスキーを構成する方法](https://scalardl.scalar-labs.com/docs/latest/scalar-licensing/)を参照してください。 ```console SCALAR_DL_LEDGER_LICENSE_KEY='' @@ -537,9 +538,9 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc -n default ``` - 注意: 認証方法として `hmac` を使用する場合は、Helm Chart 側で `digital-signature` を無効にするためにダミーの秘密 `auditor-key` を作成する必要があります。 + 注意: 認証方法として `hmac` を使用する場合は、Helm Chart 側で `digital-signature` を無効にするためにダミーのシークレット `auditor-key` を作成する必要があります。 -1. ScalarDL Ledger と ScalarDL Auditor のチャート バージョンを設定します。 +1. ScalarDL Ledger と ScalarDL Auditor のチャートバージョンを設定します。 ```console SCALAR_DL_LEDGER_CHART_VERSION=$(helm search repo scalar-labs/scalardl -l | grep -v -e "scalar-labs/scalardl-audit" | grep -F "${SCALAR_DL_VERSION}" | awk '{print $2}' | sort --version-sort -r | head -n 1) @@ -614,14 +615,14 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc ``` ScalarDL Ledger および ScalarDL Auditor サービスが適切にデプロイされている場合は、`CLUSTER-IP` 列にプライベート IP アドレスが表示されます。 - + :::note `scalardl-ledger-headless`、`scalardl-auditor-headless`、`postgresql-ledger-hl`、および `postgresql-auditor-hl` の `CLUSTER-IP` 値は、IP アドレスがないため `None` になります。 ::: -## ステップ 7. クライアントコンテナを起動する +## ステップ7. クライアントコンテナを起動する クライアントコンテナで CA 証明書ファイルを使用します。そのため、シークレットリソースを作成し、クライアントコンテナにマウントする必要があります。 @@ -631,7 +632,7 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc kubectl create secret generic client-ca-cert --from-file=ca.crt=<(kubectl get secret self-signed-ca-cert-secret -o "jsonpath={.data['ca\.crt']}" | base64 -d) -n default ``` -1. クライアント ポッドのマニフェスト ファイル (`scalardl-client-pod.yaml`) を作成します。 +1. クライアントポッドのマニフェストファイル (`scalardl-client-pod.yaml`) を作成します。 ```console cat << 'EOF' > ${HOME}/scalardl-test/scalardl-client-pod.yaml @@ -685,7 +686,7 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc scalardl-client 1/1 Running 0 4s ``` -## ステップ 8. クライアントコンテナで ScalarDL サンプルコントラクトを実行する +## ステップ8. クライアントコンテナで ScalarDL サンプルコントラクトを実行する 以下では、サンプルコントラクトを実行するために必要な最小限の手順について説明します。ScalarDL Ledger と ScalarDL Auditor の詳細については、以下を参照してください。 @@ -697,7 +698,7 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc ```console kubectl exec -it scalardl-client -n default -- bash ``` - + 次の手順のコマンドは、クライアントコンテナーで実行する必要があります。 1. クライアントコンテナーに git、curl、unzip コマンドをインストールします。 @@ -805,8 +806,8 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc ```console ./scalardl-java-client-sdk-${SCALAR_DL_VERSION}/bin/scalardl execute-contract --config ./client.properties --contract-id StateUpdater --contract-argument '{"asset_id": "test_asset", "state": 3}' ``` - - このサンプル契約は、`test_asset` という名前の資産の `state` (値) を `3` に更新します。 + + このサンプルコントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 1. コントラクト `StateReader` を実行します。 @@ -829,10 +830,10 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc ### 参照 - * 資産データが改ざんされていない場合、契約実行を要求する `execute-contract` コマンドを実行すると、結果として `OK` が返されます。 - * アセットデータが改ざんされている場合（たとえば、データベースの `state` 値が改ざんされている場合）、コントラクト実行を要求する `execute-contract` コマンドを実行すると、結果として `OK` 以外の値（たとえば、`INCONSISTENT_STATES`）が返されます。ScalarDL がデータ改ざんを検出する方法の例については、以下を参照してください。 + * 資産データが改ざんされていない場合、コントラクト実行を要求する `execute-contract` コマンドを実行すると、結果として `OK` が返されます。 + * アセットデータが改ざんされている場合 (たとえば、データベースの `state` 値が改ざんされている場合) 、コントラクト実行を要求する `execute-contract` コマンドを実行すると、結果として `OK` 以外の値 (たとえば、`INCONSISTENT_STATES`) が返されます。ScalarDL がデータ改ざんを検出する方法の例については、以下を参照してください。 - [コマンド実行結果（資産データが改ざんされた場合）] + [コマンド実行結果 (資産データが改ざんされた場合) ] ```console { @@ -874,7 +875,7 @@ Helm Charts を使用して、Kubernetes クラスターに 2 つの ScalarDL Sc * 資産データが改ざんされていない場合、検証を要求する `validate-ledger` コマンドを実行すると、結果として `OK` が返されます。 * 資産データが改ざんされている場合 (たとえば、データベースの `state` 値が改ざんされている場合)、検証を要求する `validate-ledger` コマンドを実行すると、結果として `OK` 以外の値 (たとえば、`INVALID_OUTPUT`) が返されます。ScalarDL がデータ改ざんを検出する方法の例については、以下を参照してください。 - [コマンド実行結果（資産データが改ざんされた場合）] + [コマンド実行結果 (資産データが改ざんされた場合) ] ```console { @@ -943,6 +944,6 @@ Kubernetes クラスターで ScalarDL Ledger および ScalarDL Auditor テス Scalar 製品の監視またはログ記録を開始する方法については、次のチュートリアルを参照してください。 -* [Helm チャートの使用開始 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm チャートの使用開始 (Loki Stack を使用したログ記録)](getting-started-logging.mdx) -* [Helm チャートの使用開始 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki Stack を使用したログ記録)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls.mdx index 06474348..1cd44721 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor-tls.mdx @@ -1,18 +1,19 @@ --- +displayed_sidebar: docsJapanese --- -# Helm チャートの入門 (TLS を使用した ScalarDL Ledger および Auditor / Auditor モード) +# Helm Chart をはじめよう (TLS を使用した ScalarDL Ledger および Auditor / Auditor モード) -このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、TLS 構成で ScalarDL Ledger および ScalarDL Auditor を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、TLS 構成で ScalarDL Ledger および ScalarDL Auditor を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 -* ScalarDLのライセンスキー（試用ライセンスまたは商用ライセンス）を取得する必要があります。 ライセンス キーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) してください。 +* ScalarDLのライセンスキー (試用ライセンスまたは商用ライセンス) を取得する必要があります。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)してください。 * TLSに対応したScalarDL v3.9以降を使用する必要があります。 :::note -監査によるビザンチン障害検出を適切に機能させるには、ScalarDL Ledger と ScalarDL Auditor を別の管理ドメインに展開して管理する必要があります。 ただし、このチュートリアルでは、テストを容易にするために、ScalarDL Ledger と ScalarDL Auditor を同じ Kubernetes クラスターにデプロイします。 +監査によるビザンチン障害検出を適切に機能させるには、ScalarDL Ledger と ScalarDL Auditor を別の管理ドメインに展開して管理する必要があります。ただし、このチュートリアルでは、テストを容易にするために、ScalarDL Ledger と ScalarDL Auditor を同じ Kubernetes クラスターにデプロイします。 ::: @@ -52,7 +53,7 @@ +-----------------------------------------------------------------------------------------------------------------------------+ ``` -TLS 接続用に次の秘密キーファイルと証明書ファイルを作成します。 +TLS 接続用に次の秘密鍵ファイルと証明書ファイルを作成します。 ``` +----------------------+ @@ -77,7 +78,7 @@ TLS 接続用に次の秘密キーファイルと証明書ファイルを作成 +----------------------+ ``` -各接続で TLS を有効にするために、各秘密キーと証明書ファイルを次のように設定します。 +各接続で TLS を有効にするために、各秘密鍵と証明書ファイルを次のように設定します。 ``` +--------------------------------+ +--------------------------------+ @@ -106,17 +107,17 @@ ScalarDL 関連コンポーネント間には、次の接続があります。 * **`クライアント - ScalarDL Ledger の Envoy`:** 一部のScalarDL APIを実行すると、クライアントはEnvoy for ScalarDL Ledgerにアクセスします。 * **`クライアント - ScalarDL Auditor の Envoy`:** 一部のScalarDL APIを実行すると、クライアントはEnvoy for ScalarDL Auditorにアクセスします。 -* **`ScalarDL Ledgerの Envoy - ScalarDL Ledger`:** Envoy は、ScalarDL Ledger の前で L7 (gRPC) ロード バランサーとして機能します。 -* **`ScalarDL Auditor の Envoy - ScalarDL Auditor`:** Envoy は、ScalarDL Auditor の前で L7 (gRPC) ロード バランサーとして機能します。 +* **`ScalarDL Ledgerの Envoy - ScalarDL Ledger`:** Envoy は、ScalarDL Ledger の前で L7 (gRPC) ロードバランサーとして機能します。 +* **`ScalarDL Auditor の Envoy - ScalarDL Auditor`:** Envoy は、ScalarDL Auditor の前で L7 (gRPC) ロードバランサーとして機能します。 * **`ScalarDL Auditor - ScalarDL Ledger (ScalarDL Ledger) の Envoy`:** ScalarDL がデータの一貫性を保つために回復プロセスを実行する必要がある場合、ScalarDL Auditor は Envoy を介して ScalarDL Lever に対してリクエストを実行します。 -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。 インストール方法の詳細については、[Scalar Helm Charts の開始](getting-started-scalar-helm-charts.mdx) を参照してください。 +Kubernetes クラスターを準備し、いくつかのツール (`kubectl`、`helm`、`cfssl`、および `cfssljson`) をインストールする必要があります。インストール方法の詳細については、[Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx)を参照してください。 -## ステップ 2. PostgreSQL コンテナーを開始する +## ステップ2. PostgreSQL コンテナーを開始する -ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベースとして何らかのデータベースシステムを使用する必要があります。 このチュートリアルでは、PostgreSQL を使用します。 +ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベースとして何らかのデータベースシステムを使用する必要があります。このチュートリアルでは、PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -158,9 +159,9 @@ ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベ postgresql-ledger-0 1/1 Running 0 16s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する -いくつかの構成ファイルと秘密キーおよび証明書ファイルをローカルに作成します。 したがって、それらの作業ディレクトリを作成します。 +いくつかの構成ファイルと秘密鍵および証明書ファイルをローカルに作成します。したがって、それらの作業ディレクトリを作成します。 1. 作業ディレクトリを作成します。 @@ -168,9 +169,9 @@ ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベ mkdir -p ${HOME}/scalardl-test/certs/ ``` -## ステップ 4. 秘密キーおよび証明書ファイルを作成する +## ステップ4. 秘密鍵および証明書ファイルを作成する -秘密キーと証明書ファイルを作成します。 +秘密鍵と証明書ファイルを作成します。 1. 作業ディレクトリを `${HOME}/scalardl-test/certs/` ディレクトリに変更します。 @@ -200,7 +201,7 @@ ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベ EOF ``` -1. CA の鍵/証明書ファイルを作成します。 +1. CA の秘密鍵/証明書ファイルを作成します。 ```console cfssl gencert -initca ca.json | cfssljson -bare ca @@ -308,25 +309,25 @@ ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベ EOF ``` -1. Envoy の秘密キーおよび証明書ファイルを作成します。 +1. Envoy の秘密鍵および証明書ファイルを作成します。 ```console cfssl gencert -ca ca.pem -ca-key ca-key.pem -config ca-config.json -profile scalar-test-ca envoy.json | cfssljson -bare envoy ``` -1. ScalarDL Ledger の秘密キーおよび証明書ファイルを作成します。 +1. ScalarDL Ledger の秘密鍵および証明書ファイルを作成します。 ```console cfssl gencert -ca ca.pem -ca-key ca-key.pem -config ca-config.json -profile scalar-test-ca ledger.json | cfssljson -bare ledger ``` -1. ScalarDL Auditor の秘密キーおよび証明書ファイルを作成します。 +1. ScalarDL Auditor の秘密鍵および証明書ファイルを作成します。 ```console cfssl gencert -ca ca.pem -ca-key ca-key.pem -config ca-config.json -profile scalar-test-ca auditor.json | cfssljson -bare auditor ``` -1. 秘密キーおよび証明書ファイルが作成されたことを確認します。 +1. 秘密鍵および証明書ファイルが作成されたことを確認します。 ```console ls -1 @@ -354,9 +355,9 @@ ScalarDL Ledger および ScalarDL Auditor は、バックエンドデータベ ledger.pem ``` -## ステップ 5. Helm チャートを使用して ScalarDL Ledger と ScalarDL Auditor の DB スキーマを作成する +## ステップ5. Helm Charts を使用して ScalarDL Ledger と ScalarDL Auditor の DB スキーマを作成する -Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Schema Loader ポッドをデプロイします。 ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB スキーマを作成します。 +Helm Chart を使用して、Kubernetes クラスターに2つの ScalarDL Schema Loader ポッドをデプロイします。ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB スキーマを作成します。 1. 作業ディレクトリを `${HOME}/scalardl-test/` に変更します。 @@ -400,7 +401,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch EOF ``` -1. PostgreSQL for Ledger のユーザー名とパスワードを含むシークレット リソースを作成します。 +1. PostgreSQL for Ledger のユーザー名とパスワードを含むシークレットリソースを作成します。 ```console kubectl create secret generic schema-ledger-credentials-secret \ @@ -409,7 +410,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch -n default ``` -1. PostgreSQL for Auditor のユーザー名とパスワードを含むシークレット リソースを作成します。 +1. PostgreSQL for Auditor のユーザー名とパスワードを含むシークレットリソースを作成します。 ```console kubectl create secret generic schema-auditor-credentials-secret \ @@ -425,13 +426,13 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch SCALAR_DL_SCHEMA_LOADER_CHART_VERSION=$(helm search repo scalar-labs/schema-loading -l | grep -F "${SCALAR_DL_VERSION}" | awk '{print $2}' | sort --version-sort -r | head -n 1) ``` -1. Ledger 用の ScalarDL スキーマ ローダーをデプロイします。 +1. Ledger 用の ScalarDL Schema Loader をデプロイします。 ```console helm install schema-loader-ledger scalar-labs/schema-loading -f ${HOME}/scalardl-test/schema-loader-ledger-custom-values.yaml --version ${SCALAR_DL_SCHEMA_LOADER_CHART_VERSION} -n default ``` -1. Auditor 用の ScalarDL スキーマ ローダーをデプロイします。 +1. Auditor 用の ScalarDL Schema Loader をデプロイします。 ```console helm install schema-loader-auditor scalar-labs/schema-loading -f ${HOME}/scalardl-test/schema-loader-auditor-custom-values.yaml --version ${SCALAR_DL_SCHEMA_LOADER_CHART_VERSION} -n default @@ -454,7 +455,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch ``` ScalarDL Schema Loader ポッドが **ContainerCreating** または **Running** の場合は、プロセスが完了するまで待ちます (ステータスは **Completed** になります)。 -## ステップ 6. Helm Chart を使用して Kubernetes クラスターに ScalarDL Ledger と ScalarDL Auditor をデプロイする +## ステップ6. Helm Chart を使用して Kubernetes クラスターに ScalarDL Ledger と ScalarDL Auditor をデプロイする 1. ScalarDL Ledger のカスタム値ファイル (`scalardl-ledger-custom-values.yaml`) を作成します。 @@ -569,14 +570,14 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch EOF ``` -1. ライセンスキーと証明書を環境変数に設定します。 ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact) してください。 +1. ライセンスキーと証明書を環境変数に設定します。ライセンスキーをお持ちでない場合は、[お問い合わせ](https://www.scalar-labs.com/contact)してください。 ```console SCALAR_DL_LICENSE_KEY= SCALAR_DL_LICENSE_CHECK_CERT_PEM= ``` -1. 資格情報とライセンスキーを含むシークレット リソース `ledger-credentials-secret` を作成します。 +1. 資格情報とライセンスキーを含むシークレットリソース `ledger-credentials-secret` を作成します。 ```console kubectl create secret generic ledger-credentials-secret \ @@ -589,7 +590,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch -n default ``` -1. 資格情報とライセンスキーを含むシークレット リソース `auditor-credentials-secret` を作成します。 +1. 資格情報とライセンスキーを含むシークレットリソース `auditor-credentials-secret` を作成します。 ```console kubectl create secret generic auditor-credentials-secret \ @@ -602,14 +603,14 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch -n default ``` -1. Envoy の秘密キーファイルと証明書ファイルを含むシークレット リソースを作成します。 +1. Envoy の秘密鍵ファイルと証明書ファイルを含むシークレットリソースを作成します。 ```console kubectl create secret generic envoy-tls-cert --from-file=tls.crt=${HOME}/scalardl-test/certs/envoy.pem -n default kubectl create secret generic envoy-tls-key --from-file=tls.key=${HOME}/scalardl-test/certs/envoy-key.pem -n default ``` -1. ScalarDL Ledger の秘密キー、証明書、CA 証明書ファイルを含むシークレット リソースを作成します。 +1. ScalarDL Ledger の秘密鍵、証明書、CA 証明書ファイルを含むシークレットリソースを作成します。 ```console kubectl create secret generic scalardl-ledger-tls-ca --from-file=ca.crt=${HOME}/scalardl-test/certs/ca.pem -n default @@ -617,7 +618,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch kubectl create secret generic scalardl-ledger-tls-key --from-file=tls.key=${HOME}/scalardl-test/certs/ledger-key.pem -n default ``` -1. ScalarDL Auditor の秘密キー、証明書、CA 証明書ファイルを含むシークレット リソースを作成します。 +1. ScalarDL Auditor の秘密鍵、証明書、CA 証明書ファイルを含むシークレットリソースを作成します。 ```console kubectl create secret generic scalardl-auditor-tls-ca --from-file=ca.crt=${HOME}/scalardl-test/certs/ca.pem -n default @@ -626,7 +627,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch kubectl create secret generic scalardl-auditor-tls-ca-for-ledger --from-file=ca.crt=${HOME}/scalardl-test/certs/ca.pem -n default ``` -1. 秘密リソース `auditor-keys` を作成して、`デジタル署名` 認証方法を無効にします。 このドキュメントでは、 `デジタル署名` の代わりに `hmac` 認証方法を使用します。 +1. シークレットリソース `auditor-keys` を作成して、`デジタル署名` 認証方法を無効にします。このドキュメントでは、 `デジタル署名` の代わりに `hmac` 認証方法を使用します。 ```console kubectl create secret generic auditor-keys \ @@ -634,7 +635,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch --from-literal=certificate=dummy-data-to-disable-digital-signature-method \ -n default ``` - 注: 認証方法として `hmac` を使用する場合は、ダミーのシークレット `auditor-key` を作成して、ヘルム チャート側の `デジタル署名` を無効にする必要があります。 + 注: 認証方法として `hmac` を使用する場合は、ダミーのシークレット `auditor-key` を作成して、Helm Chart 側の `デジタル署名` を無効にする必要があります。 1. ScalarDL のチャートのバージョンを設定します。 @@ -713,21 +714,21 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch :::note -`scalardl-ledger-headless`、`scalardl-auditor-headless`、`postgresql-ledger-hl`、`postgresql-auditor-hl` の `CLUSTER-IP` の値は、IP アドレスがないため `None` になります。 。 +`scalardl-ledger-headless`、`scalardl-auditor-headless`、`postgresql-ledger-hl`、`postgresql-auditor-hl` の `CLUSTER-IP` の値は、IP アドレスがないため `None` になります。。 ::: -## ステップ 7. クライアントコンテナを開始する +## ステップ7. クライアントコンテナを開始する -クライアントコンテナでCAの証明書ファイルを使用します。 そこで、シークレット リソースを作成し、クライアント コンテナにマウントします。 +クライアントコンテナでCAの証明書ファイルを使用します。そこで、シークレットリソースを作成し、クライアントコンテナにマウントします。 -1. シークレット リソース `client-ca-cert` を作成します。 +1. シークレットリソース `client-ca-cert` を作成します。 ```console kubectl create secret generic client-ca-cert --from-file=certificate=${HOME}/scalardl-test/certs/ca.pem -n default ``` -1. クライアント ポッドのマニフェスト ファイル (`scalardl-client-pod.yaml`) を作成します。 +1. クライアントポッドのマニフェストファイル (`scalardl-client-pod.yaml`) を作成します。 ```console cat << 'EOF' > ${HOME}/scalardl-test/scalardl-client-pod.yaml @@ -757,13 +758,13 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch EOF ``` -1. マニフェスト ファイルに ScalarDL のバージョンを設定します。 +1. マニフェストファイルに ScalarDL のバージョンを設定します。 ```console sed -i s/SCALAR_DL_CLIENT_POD_SCALAR_DL_VERSION/${SCALAR_DL_VERSION}/ ${HOME}/scalardl-test/scalardl-client-pod.yaml ``` -1. クライアント ポッドをデプロイします。 +1. クライアントポッドをデプロイします。 ```console kubectl apply -f ${HOME}/scalardl-test/scalardl-client-pod.yaml -n default @@ -782,9 +783,9 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch scalardl-client 1/1 Running 0 4s ``` -## ステップ 8. クライアント コンテナで ScalarDL サンプル コントラクトを実行する +## ステップ8. クライアントコンテナで ScalarDL サンプルコントラクトを実行する -以下に最低限の手順を説明します。 ScalarDL LedgerとScalarDL Auditorについて詳しく知りたい場合は、以下のドキュメントを参照してください。 +以下に最低限の手順を説明します。ScalarDL LedgerとScalarDL Auditorについて詳しく知りたい場合は、以下のドキュメントを参照してください。 * [ScalarDL 入門](https://scalardl.scalar-labs.com/docs/latest/getting-started/) * [ScalarDL Auditor 入門](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor/) @@ -902,7 +903,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch ```console ./scalardl-java-client-sdk-${SCALAR_DL_VERSION}/bin/scalardl execute-contract --config ./client.properties --contract-id StateUpdater --contract-argument '{"asset_id": "test_asset", "state": 3}' ``` - このサンプル コントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 + このサンプルコントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 1. コントラクト `StateReader` を実行します。 @@ -928,7 +929,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch * 資産データが改ざんされていない場合、`execute-contract` コマンドを実行してコントラクトの実行を要求すると、結果として `OK` が返されます。 * 資産データが改ざんされている場合 (たとえば、データベース内の `state` 値が改ざんされている場合)、コントラクトの実行を要求する `execute-contract` コマンドを実行すると、実行結果として `OK` 以外の値が返されます (たとえば、 `INCONSISTENT_STATES`)。ScalarDL がデータ改ざんを検出する方法の例として、以下を参照してください。 - [コマンド実行結果（資産データが改ざんされている場合）] + [コマンド実行結果 (資産データが改ざんされている場合) ] ```console { @@ -968,9 +969,9 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch ### 参考情報 * 資産データが改ざんされていない場合、`validate-ledger` コマンドを実行して検証を要求すると、結果として `OK` が返されます。 - * 資産データが改ざんされている場合 (たとえば、データベース内の `state` 値が改ざんされている場合)、`validate-ledger` コマンドを実行して検証を要求すると、実行結果として `OK` 以外の値が返されます (たとえば、`INVALID_OUTPUT`)。 ScalarDL がデータ改ざんを検出する方法の例として、以下を参照してください。 + * 資産データが改ざんされている場合 (たとえば、データベース内の `state` 値が改ざんされている場合)、`validate-ledger` コマンドを実行して検証を要求すると、実行結果として `OK` 以外の値が返されます (たとえば、`INVALID_OUTPUT`)。ScalarDL がデータ改ざんを検出する方法の例として、以下を参照してください。 - [コマンド実行結果（資産データが改ざんされている場合）] + [コマンド実行結果 (資産データが改ざんされている場合) ] ```console { @@ -979,7 +980,7 @@ Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Sch } ``` -## ステップ 9. すべてのリソースを削除する +## ステップ9. すべてのリソースを削除する Kubernetes クラスターで ScalarDL Ledger テストと ScalarDL Auditor テストを完了したら、すべてのリソースを削除します。 @@ -1001,7 +1002,7 @@ Kubernetes クラスターで ScalarDL Ledger テストと ScalarDL Auditor テ kubectl delete secrets envoy-tls-key envoy-tls-cert schema-ledger-credentials-secret schema-auditor-credentials-secret ledger-credentials-secret scalardl-ledger-tls-ca scalardl-ledger-tls-cert scalardl-ledger-tls-key auditor-credentials-secret auditor-keys scalardl-auditor-tls-ca scalardl-auditor-tls-cert scalardl-auditor-tls-key scalardl-auditor-tls-ca-for-ledger client-ca-cert ``` -1. 作業ディレクトリとサンプル ファイル (構成ファイル、秘密キー、および証明書) を削除します。 +1. 作業ディレクトリとサンプルファイル (構成ファイル、秘密鍵、および証明書) を削除します。 ```console cd ${HOME} @@ -1015,6 +1016,6 @@ Kubernetes クラスターで ScalarDL Ledger テストと ScalarDL Auditor テ Scalar 製品の監視またはログ記録を開始する方法については、次のドキュメントで説明しています。 -* [Helm Charts の入門 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm Charts の入門 (Loki スタックを使用したロギング)](getting-started-logging.mdx) -* [Helm Charts の入門 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki スタックを使用したロギング)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor.mdx index ee22d881..bce1670c 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-auditor.mdx @@ -1,13 +1,14 @@ --- +displayed_sidebar: docsJapanese --- -# Helm Charts の入門 (ScalarDL Ledger と Auditor / Auditor モード) +# Helm Charts をはじめよう (ScalarDL Ledger と Auditor / Auditor モード) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDL Ledger および Auditor を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDL Ledger および Auditor を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 @@ -30,7 +31,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; * [How to install Scalar products through Azure Marketplace](../scalar-kubernetes/AzureMarketplaceGuide.mdx) ## 注記 -監査によるビザンチン障害検出を適切に機能させるには、Ledger と Auditor を異なる管理ドメインに展開して管理する必要があります。 ただし、このガイドでは、テストを容易にするために、Ledger と Auditor を同じ Kubernetes クラスターにデプロイします。 +監査によるビザンチン障害検出を適切に機能させるには、Ledger と Auditor を異なる管理ドメインに展開して管理する必要があります。ただし、このガイドでは、テストを容易にするために、Ledger と Auditor を同じ Kubernetes クラスターにデプロイします。 ## 私たちが作るもの @@ -68,13 +69,13 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; +-----------------------------------------------------------------------------------------------------------------------------+ ``` -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -まず、Kubernetes クラスターを準備する必要があります。 **minikube** 環境を使用する場合は、[Scalar Helm Charts の入門] (./getting-started-scalar-helm-charts.mdx)を参照してください。 すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 +まず、Kubernetes クラスターを準備する必要があります。**minikube** 環境を使用する場合は、[Scalar Helm Charts をはじめよう](./getting-started-scalar-helm-charts.mdx)を参照してください。すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 -## ステップ 2. PostgreSQL コンテナーを開始する +## ステップ2. PostgreSQL コンテナーを開始する -ScalarDL Ledger と Auditor は、バックエンド データベースとして何らかのデータベース システムを使用します。 このドキュメントでは PostgreSQL を使用します。 +ScalarDL Ledger と Auditor は、バックエンドデータベースとして何らかのデータベースシステムを使用します。このドキュメントでは PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -108,18 +109,18 @@ ScalarDL Ledger と Auditor は、バックエンド データベースとして postgresql-ledger-0 1/1 Running 0 16s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する -いくつかの構成ファイルとキー/証明書ファイルをローカルに作成します。 したがって、それらの作業ディレクトリを作成します。 +いくつかの構成ファイルとキー/証明書ファイルをローカルに作成します。したがって、それらの作業ディレクトリを作成します。 1. 作業ディレクトリを作成します。 ```console mkdir -p ~/scalardl-test/certs/ ``` -## ステップ 4. 秘密鍵/証明書ファイルを作成する +## ステップ4. 秘密鍵/証明書ファイルを作成する -注記：このガイドでは、テストに自己署名証明書を使用します。 ただし、これらの証明書を運用環境では使用しないことを強くお勧めします。 +注記：このガイドでは、テストに自己署名証明書を使用します。ただし、これらの証明書を運用環境では使用しないことを強くお勧めします。 1. 作業ディレクトリを `~/scalardl-test/certs/` ディレクトリに変更します。 ```console @@ -230,9 +231,9 @@ ScalarDL Ledger と Auditor は、バックエンド データベースとして ledger.pem ``` -## ステップ 5. Helm Charts を使用して ScalarDL Ledger と ScalarDL Auditor の DB スキーマを作成する +## ステップ5. Helm Charts を使用して ScalarDL Ledger と ScalarDL Auditor の DB スキーマを作成する -Helm Chart を使用して、Kubernetes クラスターに 2 つの ScalarDL Schema Loader ポッドをデプロイします。 +Helm Chart を使用して、Kubernetes クラスターに2つの ScalarDL Schema Loader ポッドをデプロイします。 ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB スキーマを作成します。 1. 作業ディレクトリを `~/scalardl-test/` に変更します。 @@ -245,7 +246,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB helm repo add scalar-labs https://scalar-labs.github.io/helm-charts ``` -1. AWS/Azure Marketplace から ScalarDL コンテナー イメージをプルするためのシークレット リソースを作成します。 +1. AWS/Azure Marketplace から ScalarDL コンテナーイメージをプルするためのシークレットリソースを作成します。 * AWS Marketplace ```console kubectl create secret docker-registry reg-ecr-mp-secrets \ @@ -262,7 +263,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB ``` 詳細については、以下のドキュメントを参照してください。 - + * [How to install Scalar products through AWS Marketplace](../scalar-kubernetes/AwsMarketplaceGuide.mdx) * [How to install Scalar products through Azure Marketplace](../scalar-kubernetes/AzureMarketplaceGuide.mdx) @@ -288,7 +289,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB ``` * Azure Marketplace - + ```console cat << 'EOF' > ~/scalardl-test/schema-loader-ledger-custom-values.yaml schemaLoading: @@ -329,7 +330,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB ``` * Azure Marketplace - + ```console cat << 'EOF' > ~/scalardl-test/schema-loader-auditor-custom-values.yaml schemaLoading: @@ -348,14 +349,14 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB EOF ``` -1. PostgreSQL for Ledger のユーザー名とパスワードを含むシークレット リソースを作成します。 +1. PostgreSQL for Ledger のユーザー名とパスワードを含むシークレットリソースを作成します。 ```console kubectl create secret generic ledger-credentials-secret \ --from-literal=SCALAR_DL_LEDGER_POSTGRES_USERNAME=postgres \ --from-literal=SCALAR_DL_LEDGER_POSTGRES_PASSWORD=postgres ``` -1. PostgreSQL for Auditor のユーザー名とパスワードを含むシークレット リソースを作成します。 +1. PostgreSQL for Auditor のユーザー名とパスワードを含むシークレットリソースを作成します。 ```console kubectl create secret generic auditor-credentials-secret \ --from-literal=SCALAR_DL_AUDITOR_POSTGRES_USERNAME=postgres \ @@ -386,7 +387,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB ``` ScalarDL Schema Loader ポッドが **ContainerCreating** または **Running** の場合は、プロセスが完了するまで待ちます (STATUS は **Completed** になります)。 -## ステップ 6. Helm Chart を使用して Kubernetes クラスターに ScalarDL Ledger と Auditor をデプロイする +## ステップ6. Helm Chart を使用して Kubernetes クラスターに ScalarDL Ledger と Auditor をデプロイする 1. ScalarDL Ledger のカスタム値ファイル (scalardl-ledger-custom-values.yaml) を作成します。 * AWS Marketplace @@ -399,7 +400,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB version: "1.3.0" imagePullSecrets: - name: "reg-ecr-mp-secrets" - + ledger: image: repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" @@ -436,7 +437,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB version: "1.3.0" imagePullSecrets: - name: "reg-acr-secrets" - + ledger: image: repository: "/scalarinc/scalar-ledger" @@ -473,7 +474,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB version: "1.3.0" imagePullSecrets: - name: "reg-ecr-mp-secrets" - + auditor: image: repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-auditor" @@ -510,7 +511,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB version: "1.3.0" imagePullSecrets: - name: "reg-acr-secrets" - + auditor: image: repository: "/scalarinc/scalar-auditor" @@ -537,12 +538,12 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB EOF ``` -1. 秘密リソース `ledger-keys` を作成します。 +1. シークレットリソース `ledger-keys` を作成します。 ```console kubectl create secret generic ledger-keys --from-file=certificate=./certs/ledger.pem --from-file=private-key=./certs/ledger-key.pem ``` -1. 秘密リソース `auditor-keys` を作成します。 +1. シークレットリソース `auditor-keys` を作成します。 ```console kubectl create secret generic auditor-keys --from-file=certificate=./certs/auditor.pem --from-file=private-key=./certs/auditor-key.pem ``` @@ -604,18 +605,18 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB scalardl-ledger-headless ClusterIP None 50051/TCP,50053/TCP,50052/TCP 61s scalardl-ledger-metrics ClusterIP 10.99.122.106 8080/TCP 61s ``` - ScalarDL Ledger サービスと Auditor サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。 (注記： `scalardl-ledger-headless` と `scalardl-auditor-headless` には CLUSTER-IP がありません。) + ScalarDL Ledger サービスと Auditor サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。(注記： `scalardl-ledger-headless` と `scalardl-auditor-headless` には CLUSTER-IP がありません。) -## ステップ 7. クライアントコンテナを開始する +## ステップ7. クライアントコンテナを開始する -クライアントコンテナで証明書ファイルを使用します。 そこで、シークレット リソースを作成し、クライアント コンテナにマウントします。 +クライアントコンテナで証明書ファイルを使用します。そこで、シークレットリソースを作成し、クライアントコンテナにマウントします。 -1. 秘密リソース `client-keys` を作成します。 +1. シークレットリソース `client-keys` を作成します。 ``` kubectl create secret generic client-keys --from-file=certificate=./certs/client.pem --from-file=private-key=./certs/client-key.pem ``` -1. Kubernetes クラスター上でクライアント コンテナーを起動します。 +1. Kubernetes クラスター上でクライアントコンテナーを起動します。 ```console cat << 'EOF' | kubectl apply -f - apiVersion: v1 @@ -648,7 +649,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB - name: "client-keys" secret: secretName: "client-keys" - restartPolicy: Never + restartPolicy: Never EOF ``` @@ -662,21 +663,21 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger と Auditor の DB scalardl-client 1/1 Running 0 4s ``` -## ステップ 8. クライアント コンテナで ScalarDL サンプル コントラクトを実行する +## ステップ8. クライアントコンテナで ScalarDL サンプルコントラクトを実行する -以下に最低限の手順を説明します。 ScalarDL Ledger とAuditor について詳しく知りたい場合は、以下のドキュメントを参照してください。 +以下に最低限の手順を説明します。ScalarDL Ledger と Auditor について詳しく知りたい場合は、以下のドキュメントを参照してください。 * [Getting Started with ScalarDL](https://scalardl.scalar-labs.com/ja-jp/docs/latest/getting-started) * [Getting Started with ScalarDL Auditor](https://scalardl.scalar-labs.com/ja-jp/docs/latest/getting-started-auditor) -Auditor を使用する場合、クライアントアプリケーションを起動する前に Ledger と Auditor の証明書を登録する必要があります。 Ledger はその証明書を Auditor に登録する必要があり、Auditor はその証明書を Ledger に登録する必要があります。 +Auditor を使用する場合、クライアントアプリケーションを起動する前に Ledger と Auditor の証明書を登録する必要があります。Ledger はその証明書を Auditor に登録する必要があり、Auditor はその証明書を Ledger に登録する必要があります。 1. クライアントコンテナで bash を実行します。 ```console kubectl exec -it scalardl-client -- bash ``` - この手順の後、クライアント コンテナで各コマンドを実行します。 + この手順の後、クライアントコンテナで各コマンドを実行します。 -1. git、curl、および unzip コマンドをクライアント コンテナにインストールします。 +1. git、curl、および unzip コマンドをクライアントコンテナにインストールします。 ```console apt update && apt install -y git curl unzip ``` @@ -711,7 +712,7 @@ Auditor を使用する場合、クライアントアプリケーションを起 master * v3.6.0 ``` - 別のバージョンを使用する場合は、使用するバージョン（タグ）を指定してください。 同じバージョンの ScalarDL Ledger と ScalarDL Java Client SDK を使用する必要があります。 + 別のバージョンを使用する場合は、使用するバージョン (タグ) を指定してください。同じバージョンの ScalarDL Ledger と ScalarDL Java Client SDK を使用する必要があります。 1. サンプルコントラクトを作成します。 ```console @@ -734,11 +735,11 @@ Auditor を使用する場合、クライアントアプリケーションを起 cat << 'EOF' > ledger.as.client.properties # Ledger scalar.dl.client.server.host=scalardl-ledger-envoy.default.svc.cluster.local - + # Auditor scalar.dl.client.auditor.enabled=true scalar.dl.client.auditor.host=scalardl-auditor-envoy.default.svc.cluster.local - + # Certificate scalar.dl.client.cert_holder_id=ledger scalar.dl.client.cert_path=/keys/ledger/certificate @@ -751,11 +752,11 @@ Auditor を使用する場合、クライアントアプリケーションを起 cat << 'EOF' > auditor.as.client.properties # Ledger scalar.dl.client.server.host=scalardl-ledger-envoy.default.svc.cluster.local - + # Auditor scalar.dl.client.auditor.enabled=true scalar.dl.client.auditor.host=scalardl-auditor-envoy.default.svc.cluster.local - + # Certificate scalar.dl.client.cert_holder_id=auditor scalar.dl.client.cert_path=/keys/auditor/certificate @@ -768,11 +769,11 @@ Auditor を使用する場合、クライアントアプリケーションを起 cat << 'EOF' > client.properties # Ledger scalar.dl.client.server.host=scalardl-ledger-envoy.default.svc.cluster.local - + # Auditor scalar.dl.client.auditor.enabled=true scalar.dl.client.auditor.host=scalardl-auditor-envoy.default.svc.cluster.local - + # Certificate scalar.dl.client.cert_holder_id=client scalar.dl.client.cert_path=/keys/client/certificate @@ -814,7 +815,7 @@ Auditor を使用する場合、クライアントアプリケーションを起 ```console ./scalardl-java-client-sdk-3.6.0/bin/execute-contract --properties ./client.properties --contract-id StateUpdater --contract-argument '{"asset_id": "test_asset", "state": 3}' ``` - このサンプル コントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 + このサンプルコントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 1. コントラクト `StateReader` を実行します。 ```console @@ -832,9 +833,9 @@ Auditor を使用する場合、クライアントアプリケーションを起 } ``` * 参考情報 - * 資産データが改ざんされていない場合、コントラクト実行要求（execute-contract コマンド）は結果として `OK` を返します。 - * 資産データが改ざんされている場合（例：DBの `state` 値が改ざんされている場合）、コントラクト実行要求（execute-contract コマンド）は結果として `OK` 以外の値（例：`INCONSISTENT_STATES`）を返す , 以下のような感じです。 - 【コマンド実行結果（資産データが改ざんされた場合）】 + * 資産データが改ざんされていない場合、コントラクト実行要求 (execute-contract コマンド) は結果として `OK` を返します。 + * 資産データが改ざんされている場合 (例: DB の `state` 値が改ざんされている場合) 、コントラクト実行要求 (execute-contract コマンド) は結果として `OK` 以外の値 (例：`INCONSISTENT_STATES`) を返す , 以下のような感じです。 + 【コマンド実行結果 (資産データが改ざんされた場合) 】 ```console { "status_code" : "INCONSISTENT_STATES", @@ -868,9 +869,9 @@ Auditor を使用する場合、クライアントアプリケーションを起 } ``` * 参考情報 - * 資産データが改ざんされていない場合、検証リクエスト(validate-ledger コマンド)は結果として `OK` を返します。 - * 資産データが改ざんされている場合（例：DBの `state` 値が改ざんされている場合）、検証リクエスト（validate-ledger コマンド）は結果として `OK` 以外の値（例： `INVALID_OUTPUT`）を返します。 以下のような。 - 【コマンド実行結果（資産データが改ざんされた場合）】 + * 資産データが改ざんされていない場合、検証リクエスト (validate-ledger コマンド) は結果として `OK` を返します。 + * 資産データが改ざんされている場合 (例: DB の `state` 値が改ざんされている場合) 、検証リクエスト (validate-ledger コマンド) は結果として `OK` 以外の値 (例： `INVALID_OUTPUT`) を返します。以下のような。 + 【コマンド実行結果 (資産データが改ざんされた場合) 】 ```console { "status_code" : "INCONSISTENT_STATES", @@ -879,7 +880,7 @@ Auditor を使用する場合、クライアントアプリケーションを起 ``` * このようにして、ScalarDL Ledger はデータの改ざんを検出できます。 -## ステップ 9. すべてのリソースを削除する +## ステップ9. すべてのリソースを削除する Kubernetes クラスターで ScalarDL Ledger テストを完了したら、すべてのリソースを削除します。 @@ -893,7 +894,7 @@ Kubernetes クラスターで ScalarDL Ledger テストを完了したら、す kubectl delete pod scalardl-client --force --grace-period 0 ``` -1. 作業ディレクトリとサンプル ファイル (構成ファイル、キー、証明書) を削除します。 +1. 作業ディレクトリとサンプルファイル (構成ファイル、秘密鍵、証明書) を削除します。 ```console cd ~ ``` @@ -905,6 +906,6 @@ Kubernetes クラスターで ScalarDL Ledger テストを完了したら、す Scalar 製品の監視またはログ記録を開始する方法については、次のドキュメントで説明しています。 -* [Helm Charts の入門 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm Charts の入門 (Loki スタックを使用したロギング)](getting-started-logging.mdx) -* [Helm Charts の入門 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki スタックを使用したロギング)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-ledger.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-ledger.mdx index c42dba26..8e006230 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-ledger.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/getting-started-scalardl-ledger.mdx @@ -1,13 +1,14 @@ --- +displayed_sidebar: docsJapanese --- -# Helm Charts の入門 (ScalarDL Ledger / Ledger のみ) +# Helm Charts をはじめよう (ScalarDL Ledger / Ledger のみ) import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDL Ledger を開始する方法について説明します。 ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。 このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 +このドキュメントでは、Kubernetes クラスター上の Helm Chart をテスト環境として使用して、ScalarDL Ledger を開始する方法について説明します。ここでは、テスト用の Mac または Linux 環境がすでにあることを前提としています。このドキュメントでは **Minikube** を使用しますが、これから説明する手順はどの Kubernetes クラスターでも機能するはずです。 ## 要件 @@ -50,13 +51,13 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; +--------------------------------------------------------------------------------------------------------------------------------------+ ``` -## ステップ 1. Kubernetes クラスターを開始する +## ステップ1. Kubernetes クラスターを開始する -まず、Kubernetes クラスターを準備する必要があります。 **minikube** 環境を使用する場合は、[Scalar Helm Charts の入門](./getting-started-scalar-helm-charts.mdx) を参照してください。 すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 +まず、Kubernetes クラスターを準備する必要があります。**minikube** 環境を使用する場合は、[Scalar Helm Charts をはじめよう](./getting-started-scalar-helm-charts.mdx)を参照してください。すでに Kubernetes クラスターを開始している場合は、この手順をスキップできます。 -## ステップ 2. PostgreSQL コンテナーを開始する +## ステップ2. PostgreSQL コンテナーを開始する -ScalarDL Ledger は、バックエンド データベースとして何らかのデータベース システムを使用します。 このドキュメントでは PostgreSQL を使用します。 +ScalarDL Ledger は、バックエンドデータベースとして何らかのデータベースシステムを使用します。このドキュメントでは PostgreSQL を使用します。 次のようにして、Kubernetes クラスターに PostgreSQL をデプロイできます。 @@ -82,18 +83,18 @@ ScalarDL Ledger は、バックエンド データベースとして何らかの postgresql-ledger-0 1/1 Running 0 11s ``` -## ステップ 3. 作業ディレクトリを作成する +## ステップ3. 作業ディレクトリを作成する -いくつかの構成ファイルとキー/証明書ファイルをローカルに作成します。 したがって、それらの作業ディレクトリを作成します。 +いくつかの構成ファイルとキー/証明書ファイルをローカルに作成します。したがって、それらの作業ディレクトリを作成します。 1. 作業ディレクトリを作成します。 ```console mkdir -p ~/scalardl-test/certs/ ``` -## ステップ 4. キー/証明書ファイルを作成する +## ステップ4. キー/証明書ファイルを作成する -注記：このガイドでは、テストに自己署名証明書を使用します。 ただし、これらの証明書を運用環境では使用しないことを強くお勧めします。 +注記：このガイドでは、テストに自己署名証明書を使用します。ただし、これらの証明書を運用環境では使用しないことを強くお勧めします。 1. 作業ディレクトリを `~/scalardl-test/certs/` ディレクトリに変更します。 ```console @@ -172,7 +173,7 @@ ScalarDL Ledger は、バックエンド データベースとして何らかの ledger.pem ``` -## ステップ 5. Helm Charts を使用して ScalarDL Ledger の DB スキーマを作成する +## ステップ5. Helm Charts を使用して ScalarDL Ledger の DB スキーマを作成する Helm Charts を使用して、ScalarDL Schema Loader を Kubernetes クラスターにデプロイします。 ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマを作成します。 @@ -187,7 +188,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ helm repo add scalar-labs https://scalar-labs.github.io/helm-charts ``` -1. AWS/Azure Marketplace から ScalarDL コンテナー イメージをプルするためのシークレット リソースを作成します。 +1. AWS/Azure Marketplace から ScalarDL コンテナーイメージをプルするためのシークレットリソースを作成します。 * AWS Marketplace ```console kubectl create secret docker-registry reg-ecr-mp-secrets \ @@ -204,7 +205,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ ``` 詳細については、以下のドキュメントを参照してください。 - + * [How to install Scalar products through AWS Marketplace](../scalar-kubernetes/AwsMarketplaceGuide.mdx) * [How to install Scalar products through Azure Marketplace](../scalar-kubernetes/AzureMarketplaceGuide.mdx) @@ -249,7 +250,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ EOF ``` -1. PostgreSQL のユーザー名とパスワードを含むシークレット リソースを作成します。 +1. PostgreSQL のユーザー名とパスワードを含むシークレットリソースを作成します。 ```console kubectl create secret generic ledger-credentials-secret \ --from-literal=SCALAR_DL_LEDGER_POSTGRES_USERNAME=postgres \ @@ -273,7 +274,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ ``` ScalarDL Schema Loader ポッドが **ContainerCreating** または **Running** の場合は、プロセスが完了するまで待ちます (STATUS は **Completed** になります)。 -## ステップ 6. Helm Charts を使用して Kubernetes クラスターに ScalarDL Ledger をデプロイする +## ステップ6. Helm Charts を使用して Kubernetes クラスターに ScalarDL Ledger をデプロイする 1. ScalarDL Ledger のカスタム値ファイル (scalardl-ledger-custom-values.yaml) を作成します。 * AWS Marketplace @@ -286,7 +287,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ version: "1.3.0" imagePullSecrets: - name: "reg-ecr-mp-secrets" - + ledger: image: repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" @@ -322,7 +323,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ version: "1.3.0" imagePullSecrets: - name: "reg-acr-secrets" - + ledger: image: repository: "/scalarinc/scalar-ledger" @@ -348,7 +349,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ EOF ``` -1. 秘密リソース `ledger-keys` を作成します。 +1. シークレットリソース `ledger-keys` を作成します。 ```console kubectl create secret generic ledger-keys --from-file=private-key=./certs/ledger-key.pem ``` @@ -391,18 +392,18 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ scalardl-ledger-headless ClusterIP None 50051/TCP,50053/TCP,50052/TCP 83s scalardl-ledger-metrics ClusterIP 10.98.4.217 8080/TCP 83s ``` - ScalarDL Ledger サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。 (注記： `scalardl-ledger-headless` には CLUSTER-IP がありません。) + ScalarDL Ledger サービスが適切にデプロイされている場合は、CLUSTER-IP 列にプライベート IP アドレスが表示されます。(注記： `scalardl-ledger-headless` には CLUSTER-IP がありません。) -## ステップ 7. クライアントコンテナを開始する +## ステップ7. クライアントコンテナを開始する -クライアントコンテナで証明書ファイルを使用します。 そこで、シークレット リソースを作成し、クライアント コンテナにマウントします。 +クライアントコンテナで証明書ファイルを使用します。そこで、シークレットリソースを作成し、クライアントコンテナにマウントします。 -1. 秘密リソース `client-keys` を作成します。 +1. シークレットリソース `client-keys` を作成します。 ``` kubectl create secret generic client-keys --from-file=certificate=./certs/client.pem --from-file=private-key=./certs/client-key.pem ``` -1. Kubernetes クラスター上でクライアント コンテナーを起動します。 +1. Kubernetes クラスター上でクライアントコンテナーを起動します。 ```console cat << 'EOF' | kubectl apply -f - apiVersion: v1 @@ -423,7 +424,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ - name: "client-keys" secret: secretName: "client-keys" - restartPolicy: Never + restartPolicy: Never EOF ``` @@ -437,17 +438,17 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ scalardl-client 1/1 Running 0 11s ``` -## ステップ 8. クライアント コンテナで ScalarDL サンプル コントラクトを実行する +## ステップ8. クライアントコンテナで ScalarDL サンプルコントラクトを実行する -以下に最低限の手順を説明します。 ScalarDL の詳細やコントラクトについて知りたい場合は、[Getting Started with ScalarDL](https://scalardl.scalar-labs.com/ja-jp/docs/latest/getting-started) をご覧ください。 +以下に最低限の手順を説明します。ScalarDL の詳細やコントラクトについて知りたい場合は、[Getting Started with ScalarDL](https://scalardl.scalar-labs.com/ja-jp/docs/latest/getting-started) をご覧ください。 1. クライアントコンテナで bash を実行します。 ```console kubectl exec -it scalardl-client -- bash ``` - この手順の後、クライアント コンテナで各コマンドを実行します。 + この手順の後、クライアントコンテナで各コマンドを実行します。 -1. git、curl、および unzip コマンドをクライアント コンテナにインストールします。 +1. git、curl、および unzip コマンドをクライアントコンテナにインストールします。 ```console apt update && apt install -y git curl unzip ``` @@ -482,7 +483,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ master * v3.6.0 ``` - 別のバージョンを使用する場合は、使用するバージョン（タグ）を指定してください。 同じバージョンの ScalarDL Ledger と ScalarDL Java Client SDK を使用する必要があります。 + 別のバージョンを使用する場合は、使用するバージョン (タグ) を指定してください。同じバージョンの ScalarDL Ledger と ScalarDL Java Client SDK を使用する必要があります。 1. サンプルコントラクトを作成します。 ```console @@ -529,7 +530,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ ```console ./scalardl-java-client-sdk-3.6.0/bin/execute-contract --properties ./client.properties --contract-id StateUpdater --contract-argument '{"asset_id": "test_asset", "state": 3}' ``` - このサンプル コントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 + このサンプルコントラクトは、`test_asset` という名前のアセットの `state` (値) を `3` に更新します。 1. コントラクト `StateReader` を実行します。 ```console @@ -566,9 +567,9 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ } ``` * 参考情報 - * 資産データが改ざんされていない場合、検証リクエスト(validate-ledger コマンド)は結果として `OK` を返します。 - * 資産データが改ざんされている場合（例：DBの `state` 値が改ざんされている場合）、検証リクエスト（validate-ledger コマンド）は結果として `OK` 以外の値（例：`INVALID_OUTPUT`）を返します。 以下のような。 - 【コマンド実行結果（資産データが改ざんされた場合）】 + * 資産データが改ざんされていない場合、検証リクエスト (validate-ledger コマンド) は結果として `OK` を返します。 + * 資産データが改ざんされている場合 (例: DB の `state` 値が改ざんされている場合)、検証リクエスト (validate-ledger コマンド) は結果として `OK` 以外の値 (例：`INVALID_OUTPUT`) を返します。以下のような。 + 【コマンド実行結果 (資産データが改ざんされた場合) 】 ```console { "status_code" : "INVALID_OUTPUT", @@ -584,7 +585,7 @@ ScalarDL Schema Loader は、PostgreSQL で ScalarDL Ledger の DB スキーマ ``` * このようにして、ScalarDL Ledger はデータの改ざんを検出できます。 -## ステップ 9. すべてのリソースを削除する +## ステップ9. すべてのリソースを削除する Kubernetes クラスターで ScalarDL Ledger テストを完了したら、すべてのリソースを削除します。 @@ -598,7 +599,7 @@ Kubernetes クラスターで ScalarDL Ledger テストを完了したら、す kubectl delete pod scalardl-client --force --grace-period 0 ``` -1. 作業ディレクトリとサンプル ファイル (構成ファイル、キー、証明書) を削除します。 +1. 作業ディレクトリとサンプルファイル (構成ファイル、秘密鍵、証明書) を削除します。 ```console cd ~ ``` @@ -610,6 +611,6 @@ Kubernetes クラスターで ScalarDL Ledger テストを完了したら、す Scalar 製品の監視またはログ記録を開始する方法については、次のドキュメントで説明しています。 -* [Helm Charts の入門 (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) -* [Helm Charts の入門 (Loki スタックを使用したロギング)](getting-started-logging.mdx) -* [Helm Charts の入門 (Scalar Manager)](getting-started-scalar-manager.mdx) +* [Helm Charts をはじめよう (Prometheus Operator を使用したモニタリング)](getting-started-monitoring.mdx) +* [Helm Charts をはじめよう (Loki スタックを使用したロギング)](getting-started-logging.mdx) +* [Helm Charts をはじめよう (Scalar Manager)](getting-started-scalar-manager.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-admin-for-kubernetes.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-admin-for-kubernetes.mdx index 735b8f92..447e0ad3 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-admin-for-kubernetes.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-admin-for-kubernetes.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # Kubernetes 用に Scalar Admin をデプロイする方法 @@ -10,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して Kubernetes に Scalar Admin をデプロイする方法について説明します。 Scalar Admin for Kubernetes のカスタム値ファイルの詳細については、[Scalar Admin for Kubernetes のカスタム値ファイルの構成](configure-custom-values-scalar-admin-for-kubernetes.mdx) を参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して Kubernetes に Scalar Admin をデプロイする方法について説明します。Scalar Admin for Kubernetes のカスタム値ファイルの詳細については、[Scalar Admin for Kubernetes のカスタム値ファイルの構成](configure-custom-values-scalar-admin-for-kubernetes.mdx)を参照してください。 ## Kubernetes 用の Scalar Admin をデプロイする diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-products.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-products.mdx index 433df160..a3f1a9d3 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-products.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalar-products.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # Scalar Helm Chart を使用して Scalar 製品をデプロイする @@ -10,15 +11,15 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して Scalar 製品をデプロイする方法について説明します。 minikube クラスターを使用してローカル環境で Scalar 製品をテストする場合は、次のスタート ガイドを参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して Scalar 製品をデプロイする方法について説明します。minikube クラスターを使用してローカル環境で Scalar 製品をテストする場合は、次のスタートガイドを参照してください。 -* [Scalar Helm Charts の入門](getting-started-scalar-helm-charts.mdx) +* [Scalar Helm Charts をはじめよう](getting-started-scalar-helm-charts.mdx) ## 前提条件 ### Helm コマンドをインストールする -Scalar Helm Charts を使用するには、helm コマンドをインストールする必要があります。 [Helm ドキュメント](https://helm.sh/docs/intro/install/)に従って helm コマンドをインストールしてください。 +Scalar Helm Charts を使用するには、helm コマンドをインストールする必要があります。[Helm ドキュメント](https://helm.sh/docs/intro/install/)に従って helm コマンドをインストールしてください。 ### Scalar Helm Charts リポジトリを追加する @@ -31,7 +32,7 @@ helm repo update scalar-labs ### Kubernetes クラスターを準備する -Scalar 製品を展開するには、Kubernetes クラスターを準備する必要があります。 運用環境で EKS (Amazon Elastic Kubernetes Service) または AKS (Azure Kubernetes Service) を使用している場合。 詳細については、次のドキュメントを参照してください。 +Scalar 製品を展開するには、Kubernetes クラスターを準備する必要があります。運用環境で EKS (Amazon Elastic Kubernetes Service) または AKS (Azure Kubernetes Service) を使用している場合。詳細については、次のドキュメントを参照してください。 - [Scalar 製品用の Amazon EKS クラスターを作成するためのガイドライン](../scalar-kubernetes/CreateEKSClusterForScalarProducts.mdx) - [Scalar 製品用の AKS クラスターを作成するためのガイドライン](../scalar-kubernetes/CreateAKSClusterForScalarProducts.mdx) @@ -40,21 +41,21 @@ Scalar 製品を展開するには、Kubernetes クラスターを準備する ### データベースの準備 (ScalarDB、ScalarDL Ledger、ScalarDL Auditor) -ScalarDB/ScalarDLのバックエンドストレージとしてデータベースを用意する必要があります。 ScalarDB/ScalarDL がサポートするデータベースは次のドキュメントで確認できます。 +ScalarDB/ScalarDLのバックエンドストレージとしてデータベースを用意する必要があります。ScalarDB/ScalarDL がサポートするデータベースは次のドキュメントで確認できます。 * [ScalarDB がサポートするデータベース](https://scalardb.scalar-labs.com/docs/latest/requirements#databases) ### カスタム値ファイルを準備する -環境に基づいてカスタム値ファイルを準備する必要があります。 カスタム値ファイルの作成方法の詳細については、次のドキュメントを参照してください。 +環境に基づいてカスタム値ファイルを準備する必要があります。カスタム値ファイルの作成方法の詳細については、次のドキュメントを参照してください。 * [Scalar Helm Charts のカスタム値ファイルを構成する](configure-custom-values-file.mdx) ### コンテナイメージを取得する -特に商用ライセンス製品を使用する場合は、Scalar 製品のコンテナ イメージを取得する必要があります。 Scalar 製品のコンテナ リポジトリの詳細については、[Scalar 製品のコンテナ イメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx) を参照してください。 +特に商用ライセンス製品を使用する場合は、Scalar 製品のコンテナイメージを取得する必要があります。Scalar 製品のコンテナリポジトリの詳細については、[Scalar 製品のコンテナイメージを取得する方法](../scalar-kubernetes/HowToGetContainerImages.mdx)を参照してください。 -PostgreSQL で ScalarDB Analytics などの OSS 製品を使用する場合は、パブリック コンテナ リポジトリからコンテナ イメージを取得できます。 +ScalarDB Analytics with PostgreSQL などの OSS 製品を使用する場合は、パブリックコンテナリポジトリからコンテナイメージを取得できます。 ## Scalar 製品をデプロイする diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-analytics-postgresql.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-analytics-postgresql.mdx index 12d0e680..ca4cd7ad 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-analytics-postgresql.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-analytics-postgresql.mdx @@ -1,6 +1,7 @@ --- tags: - Community +displayed_sidebar: docsJapanese --- # ScalarDB Analytics with PostgreSQL の導入方法 @@ -9,11 +10,11 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Analytics with PostgreSQL をデプロイする方法について説明します。 ScalarDB Analytics with PostgreSQL のカスタム値ファイルの詳細については、[ScalarDB Analytics with PostgreSQL のカスタム値ファイルの構成](configure-custom-values-scalardb-analytics-postgresql.mdx) を参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Analytics with PostgreSQL をデプロイする方法について説明します。ScalarDB Analytics with PostgreSQL のカスタム値ファイルの詳細については、[ScalarDB Analytics with PostgreSQL のカスタム値ファイルの構成](configure-custom-values-scalardb-analytics-postgresql.mdx)を参照してください。 ## シークレットリソースを準備する -`ScalarDB Analytics with PostgreSQL` をデプロイする前に、キー `superuser-password` を使用して、PostgreSQL のスーパーユーザー パスワードを含むシークレット リソース `scalardb-analytics-postgresql-superuser-password` を作成する必要があります。 Scalar Helm Chart は、この秘密リソースをマウントし、`POSTGRES_PASSWORD` 環境変数を `superuser-password` キーの値に設定します。 +`ScalarDB Analytics with PostgreSQL` をデプロイする前に、キー `superuser-password` を使用して、PostgreSQL のスーパーユーザーパスワードを含むシークレットリソース `scalardb-analytics-postgresql-superuser-password` を作成する必要があります。Scalar Helm Chart は、このシークレットリソースをマウントし、`POSTGRES_PASSWORD` 環境変数を `superuser-password` キーの値に設定します。 ```console kubectl create secret generic scalardb-analytics-postgresql-superuser-password --from-literal=superuser-password= -n diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-cluster.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-cluster.mdx index bfb0a74c..6a40c39c 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-cluster.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-cluster.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # ScalarDB Cluster のデプロイする方法 @@ -10,7 +11,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Cluster をデプロイする方法について説明します。 ScalarDB Cluster のカスタム値ファイルの詳細については、[ScalarDB Cluster のカスタム値ファイルの構成](configure-custom-values-scalardb-cluster.mdx) を参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Cluster をデプロイする方法について説明します。ScalarDB Cluster のカスタム値ファイルの詳細については、[ScalarDB Cluster のカスタム値ファイルの構成](configure-custom-values-scalardb-cluster.mdx)を参照してください。 ## ScalarDB Cluster をデプロイする @@ -30,15 +31,15 @@ helm upgrade scalar-labs/scalardb-cluster -n -f / -n ``` -## `direct-kubernetes` モードを使用してクライアント アプリケーションを Kubernetes にデプロイします +## `direct-kubernetes` モードを使用してクライアントアプリケーションを Kubernetes にデプロイします ScalarDB Cluster を `direct-kubernetes` モードで使用する場合は、次のことを行う必要があります。 -1. アプリケーション ポッドを ScalarDB Cluster と同じ Kubernetes クラスターにデプロイします。 -2. 3 つの Kubernetes リソース (`Role`、`RoleBinding`、`ServiceAccount`) を作成します。 -3. アプリケーション ポッドに `ServiceAccount` をマウントします。 +1. アプリケーションポッドを ScalarDB Cluster と同じ Kubernetes クラスターにデプロイします。 +2. 3つの Kubernetes リソース (`Role`、`RoleBinding`、`ServiceAccount`) を作成します。 +3. アプリケーションポッドに `ServiceAccount` をマウントします。 -このメソッドが必要なのは、`direct-kubernetes` モードの ScalarDB Cluster クライアント ライブラリがアプリケーション ポッド内から Kubernetes API を実行して、ScalarDB Cluster ポッドに関する情報を取得するためです。 +このメソッドが必要なのは、`direct-kubernetes` モードの ScalarDB Cluster クライアントライブラリがアプリケーションポッド内から Kubernetes API を実行して、ScalarDB Cluster ポッドに関する情報を取得するためです。 * Role ```yaml diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-graphql.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-graphql.mdx index 8f613748..0443480e 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-graphql.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb-graphql.mdx @@ -2,6 +2,7 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # [非推奨] ScalarDB GraphQL をデプロイする方法 @@ -12,23 +13,23 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; :::note -ScalarDB GraphQL サーバーは非推奨になりました。 代わりに [ScalarDB Cluster](how-to-deploy-scalardb-cluster.mdx) を使用してください。 +ScalarDB GraphQL サーバーは非推奨になりました。代わりに [ScalarDB Cluster](how-to-deploy-scalardb-cluster.mdx) を使用してください。 ::: -このドキュメントでは、Scalar Helm Chart を使用して ScalarDB GraphQL をデプロイする方法について説明します。 カスタム値ファイルを準備する必要があります。 ScalarDB GraphQL のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDB GraphQL をデプロイする方法について説明します。カスタム値ファイルを準備する必要があります。ScalarDB GraphQL のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 * [[非推奨] ScalarDB GraphQL のカスタム値ファイルを構成する](configure-custom-values-scalardb-graphql.mdx) ## ScalarDB Server のデプロイ (推奨オプション) -ScalarDB GraphQL をデプロイする場合は、次のように ScalarDB GraphQL とバックエンド データベースの間に ScalarDB Server をデプロイすることをお勧めします。 +ScalarDB GraphQL をデプロイする場合は、次のように ScalarDB GraphQL とバックエンドデータベースの間に ScalarDB Server をデプロイすることをお勧めします。 ``` [クライアント] ---> [ScalarDB GraphQL] ---> [ScalarDB Server] ---> [バックエンドデータベース] ``` -ScalarDB GraphQLをデプロイする前に、ドキュメント [ScalarDB Server をデプロイする方法](how-to-deploy-scalardb.mdx) に従ってScalarDB Serverをデプロイしてください。 +ScalarDB GraphQLをデプロイする前に、ドキュメント [ScalarDB Server をデプロイする方法](how-to-deploy-scalardb.mdx)に従ってScalarDB Serverをデプロイしてください。 ## ScalarDB GraphQL をデプロイする diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb.mdx index 0c4eb676..79371b5d 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardb.mdx @@ -3,6 +3,7 @@ tags: - Enterprise Standard - Enterprise Premium - Deprecated +displayed_sidebar: docsJapanese --- # [非推奨] ScalarDB Server をデプロイする方法 @@ -13,11 +14,11 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; :::note -ScalarDB Server は非推奨になりました。 代わりに [ScalarDB Cluster](how-to-deploy-scalardb-cluster.mdx) を使用してください。 +ScalarDB Server は非推奨になりました。代わりに [ScalarDB Cluster](how-to-deploy-scalardb-cluster.mdx) を使用してください。 ::: -このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Server をデプロイする方法について説明します。 カスタム値ファイルを準備する必要があります。 ScalarDB Server のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDB Server をデプロイする方法について説明します。カスタム値ファイルを準備する必要があります。ScalarDB Server のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 * [[非推奨] ScalarDB Server のカスタム値ファイルを構成する](configure-custom-values-scalardb.mdx) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-auditor.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-auditor.mdx index 74852ba2..7727ab26 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-auditor.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-auditor.mdx @@ -1,4 +1,5 @@ --- +displayed_sidebar: docsJapanese --- # ScalarDL Auditor のデプロイする方法 @@ -7,20 +8,20 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して ScalarDL Auditor をデプロイする方法について説明します。 カスタム値ファイルを準備する必要があります。 ScalarDL Auditor および ScalarDL Schema Loader のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDL Auditor をデプロイする方法について説明します。カスタム値ファイルを準備する必要があります。ScalarDL Auditor および ScalarDL Schema Loader のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 * [ScalarDL Auditor のカスタム値ファイルを構成する](configure-custom-values-scalardl-auditor.mdx) * [ScalarDL Schema Loaderのカスタム値ファイルを構成する](configure-custom-values-scalardl-schema-loader.mdx) ## 秘密鍵ファイルと証明書ファイルを準備する -ScalarDL Auditor をデプロイするときは、秘密キー ファイルと証明書ファイルを ScalarDL Auditor ポッドにマウントするための Secrete リソースを作成する必要があります。 +ScalarDL Auditor をデプロイするときは、秘密鍵ファイルと証明書ファイルを ScalarDL Auditor ポッドにマウントするための Secrete リソースを作成する必要があります。 -ScalarDL ポッドにキー ファイルと証明書ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドにキーファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする) を参照してください。 +ScalarDL ポッドに秘密鍵ファイルと証明書ファイルをマウントする方法の詳細については、[ScalarDL Helm Charts のポッドに秘密鍵ファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする)を参照してください。 ## ScalarDL Auditor のスキーマの作成 (ScalarDL Schema Loader のデプロイ) -ScalarDL Auditor をデプロイする前に、バックエンド データベースに ScalarDL Auditor のスキーマを作成する必要があります。 +ScalarDL Auditor をデプロイする前に、バックエンドデータベースに ScalarDL Auditor のスキーマを作成する必要があります。 ```console helm install scalar-labs/schema-loading -n -f / --version diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-ledger.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-ledger.mdx index c9267056..07897ff9 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-ledger.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/how-to-deploy-scalardl-ledger.mdx @@ -1,4 +1,5 @@ --- +displayed_sidebar: docsJapanese --- # ScalarDL Ledger のデプロイ方法 @@ -7,22 +8,22 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -このドキュメントでは、Scalar Helm Chart を使用して ScalarDL Ledger をデプロイする方法について説明します。 カスタム値ファイルを準備する必要があります。 ScalarDL Ledger および ScalarDL Schema Loader のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 +このドキュメントでは、Scalar Helm Chart を使用して ScalarDL Ledger をデプロイする方法について説明します。カスタム値ファイルを準備する必要があります。ScalarDL Ledger および ScalarDL Schema Loader のカスタム値ファイルの詳細については、次のドキュメントを参照してください。 * [ScalarDL Ledger のカスタム値ファイルを構成する](configure-custom-values-scalardl-ledger.mdx) * [ScalarDL Schema Loaderのカスタム値ファイルを構成する](configure-custom-values-scalardl-schema-loader.mdx) ## 秘密鍵ファイルを準備します (オプション / ScalarDL Auditor を使用する場合は必要です) -ScalarDL Ledger の [asset proofs](https://scalardl.scalar-labs.com/ja-jp/docs/latest/how-to-use-proof) を使用する場合は、秘密キー ファイルを ScalarDL Ledger ポッドにマウントするための Secrete リソースを作成する必要があります。 ScalarDL Auditorを使用する場合は資産証明が必要です。 +ScalarDL Ledger の [asset proofs](https://scalardl.scalar-labs.com/ja-jp/docs/latest/how-to-use-proof) を使用する場合は、秘密鍵ファイルを ScalarDL Ledger ポッドにマウントするための Secrete リソースを作成する必要があります。ScalarDL Auditor を使用する場合はアセット証明が必要です。 ScalarDL ポッドにキー/証明書ファイルをマウントする方法の詳細については、次のドキュメントを参照してください。 -* [ScalarDL Helm Charts のポッドにキーファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドにキーファイルと証明書ファイルをマウントする) +* [ScalarDL Helm Charts のポッドに秘密鍵ファイルと証明書ファイルをマウントする](mount-files-or-volumes-on-scalar-pods.mdx#scalardl-helm-charts-のポッドに秘密鍵ファイルと証明書ファイルをマウントする) ## ScalarDL Ledger のスキーマの作成 (ScalarDL Schema Loader のデプロイ) -ScalarDL Ledger をデプロイする前に、バックエンド データベースに ScalarDL Ledger のスキーマを作成する必要があります。 +ScalarDL Ledger をデプロイする前に、バックエンドデータベースに ScalarDL Ledger のスキーマを作成する必要があります。 ```console helm install scalar-labs/schema-loading -n -f / --version diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/mount-files-or-volumes-on-scalar-pods.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/mount-files-or-volumes-on-scalar-pods.mdx index 11bd03d2..fd11df55 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/mount-files-or-volumes-on-scalar-pods.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/mount-files-or-volumes-on-scalar-pods.mdx @@ -2,15 +2,16 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- # Scalar 製品ポッドにファイルまたはボリュームをマウントします ScalarDB Server、ScalarDB Cluster、ScalarDB Analytics with PostgreSQL、または ScalarDL Helm Charts (ScalarDL Ledger および ScalarDL Auditor) を使用する場合、Scalar 製品ポッドに任意のファイルまたはボリュームをマウントできます。 -## ScalarDL Helm Charts のポッドにキーファイルと証明書ファイルをマウントする +## ScalarDL Helm Charts のポッドに秘密鍵ファイルと証明書ファイルをマウントする -ScalarDL Auditor を実行するには、キー ファイルと証明書ファイルをマウントする必要があります。 +ScalarDL Auditor を実行するには、秘密鍵ファイルと証明書ファイルをマウントする必要があります。 * 構成例 * ScalarDL Ledger @@ -31,9 +32,9 @@ ScalarDL Auditor を実行するには、キー ファイルと証明書ファ scalar.dl.auditor.cert_path=/keys/certificate ``` -この例では、**秘密キー** ファイルと **証明書** ファイルをコンテナ内の `/keys` ディレクトリにマウントする必要があります。 そして、`private-key` と `certificate` という名前のファイルをマウントする必要があります。 これらのファイルをマウントするには、`extraVolumes` および `extraVolumeMounts` を使用できます。 +この例では、**秘密鍵** ファイルと **証明書** ファイルをコンテナ内の `/keys` ディレクトリにマウントする必要があります。そして、`private-key` と `certificate` という名前のファイルをマウントする必要があります。これらのファイルをマウントするには、`extraVolumes` および `extraVolumeMounts` を使用できます。 -1. Kubernetes マニフェストと同じ構文を使用して、カスタム値ファイルに `extraVolumes` と `extraVolumeMounts` を設定します。 `mountPath` キーにディレクトリ名を指定する必要があります。 +1. Kubernetes マニフェストと同じ構文を使用して、カスタム値ファイルに `extraVolumes` と `extraVolumeMounts` を設定します。`mountPath` キーにディレクトリ名を指定する必要があります。 * 例 * ScalarDL Ledger ```yaml @@ -79,16 +80,16 @@ ScalarDL Auditor を実行するには、キー ファイルと証明書ファ 1. 上記のカスタム値ファイルを使用して Scalar 製品をデプロイします。 - Scalar 製品を展開した後、次のようにキー ファイルと証明書ファイルが `/keys` ディレクトリにマウントされます。 + Scalar 製品を展開した後、次のように秘密鍵ファイルと証明書ファイルが `/keys` ディレクトリにマウントされます。 * 例 * ScalarDL Ledger ```console ls -l /keys/ ``` - + 次のような結果が表示されます： - + ```console total 0 lrwxrwxrwx 1 root root 18 Jun 27 03:12 private-key -> ..data/private-key @@ -99,16 +100,16 @@ ScalarDL Auditor を実行するには、キー ファイルと証明書ファ ``` 次のような結果が表示されます： - + ```console total 0 lrwxrwxrwx 1 root root 18 Jun 27 03:16 certificate -> ..data/certificate lrwxrwxrwx 1 root root 18 Jun 27 03:16 private-key -> ..data/private-key ``` -## emptyDir をマウントしてヒープ ダンプ ファイルを取得します +## emptyDir をマウントしてヒープダンプファイルを取得します -カスタム値ファイルで次のキーを使用して、emptyDir を Scalar 製品ポッドにマウントできます。 たとえば、このボリュームを使用して、Scalar 製品のヒープ ダンプを取得できます。 +カスタム値ファイルで次のキーを使用して、emptyDir を Scalar 製品ポッドにマウントできます。たとえば、このボリュームを使用して、Scalar 製品のヒープダンプを取得できます。 * キー * `scalardb.extraVolumes` / `scalardb.extraVolumeMounts` (ScalarDB Server) diff --git a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/use-secret-for-credentials.mdx b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/use-secret-for-credentials.mdx index 8714ca07..2f62352c 100644 --- a/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/use-secret-for-credentials.mdx +++ b/i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.9/helm-charts/use-secret-for-credentials.mdx @@ -2,9 +2,10 @@ tags: - Enterprise Standard - Enterprise Premium +displayed_sidebar: docsJapanese --- -# Secret リソースを使用して資格情報を環境変数としてプロパティ ファイルに渡す方法 +# Secret リソースを使用して資格情報を環境変数としてプロパティファイルに渡す方法 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -12,7 +13,7 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx'; -Kubernetes の `Secret` リソースを介して、**username** や **password** などの資格情報を環境変数として渡すことができます。 Scalar 製品の以前のバージョンの Docker イメージは、プロパティ ファイルのテンプレート化に `dockerize` コマンドを使用します。 Scalar 製品の最新バージョンの Docker イメージは、環境変数から直接値を取得します。 +Kubernetes の `Secret` リソースを介して、**username** や **password** などの資格情報を環境変数として渡すことができます。Scalar 製品の以前のバージョンの Docker イメージは、プロパティファイルのテンプレート化に `dockerize` コマンドを使用します。Scalar 製品の最新バージョンの Docker イメージは、環境変数から直接値を取得します。 注記：次の環境変数名は、Scalar Helm Chart の内部で使用されるため、カスタム値ファイルで使用できません。 ```console @@ -63,7 +64,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ``` -

ScalarDB Server 3.8 以降 (Apache Commons Text 構文)

+

ScalarDB Server 3.8以降 (Apache Commons Text 構文)

```yaml scalardb: @@ -74,7 +75,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ... ``` -

ScalarDB Server 3.7 以前 (Go テンプレート構文)

+

ScalarDB Server 3.7以前 (Go テンプレート構文)

```yaml scalardb: @@ -86,7 +87,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ``` -

ScalarDL Ledger 3.8 以降 (Apache Commons Text 構文)

+

ScalarDL Ledger 3.8以降 (Apache Commons Text 構文)

```yaml ledger: @@ -97,7 +98,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ... ``` -

ScalarDL Ledger 3.7 以前 (Go テンプレート構文)

+

ScalarDL Ledger 3.7以前 (Go テンプレート構文)

```yaml ledger: @@ -109,7 +110,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ``` -

ScalarDL Auditor 3.8 以降 (Apache Commons Text 構文)

+

ScalarDL Auditor 3.8以降 (Apache Commons Text 構文)

```yaml auditor: @@ -120,7 +121,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ... ``` -

ScalarDL Auditor 3.7 以前 (Go テンプレート構文)

+

ScalarDL Auditor 3.7以前 (Go テンプレート構文)

```yaml auditor: @@ -132,7 +133,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ``` -

ScalarDL Schema Loader 3.8 以降 (Apache Commons Text 構文)

+

ScalarDL Schema Loader 3.8以降 (Apache Commons Text 構文)

```yaml schemaLoading: @@ -143,7 +144,7 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME ... ``` -

ScalarDL Schema Loader 3.7 以前 (Go テンプレート構文)

+

ScalarDL Schema Loader 3.7以前 (Go テンプレート構文)

```yaml schemaLoading: @@ -233,8 +234,8 @@ SCALAR_DB_CLUSTER_MEMBERSHIP_KUBERNETES_ENDPOINT_NAME scalar.db.password={{ default .Env.SCALAR_DB_PASSWORD "" }} scalar.db.storage=jdbc ``` - - * コンテナ内のプロパティ ファイル + + * コンテナ内のプロパティファイル ```properties scalar.db.contact_points=jdbc:postgresql://postgresql-scalardb.default.svc.cluster.local:5432/postgres scalar.db.username=postgres