Skip to content

Commit d9532e3

Browse files
josh-wongjosh-wong
committed
AUTO: Sync Kubernetes docs to ScalarDL docs site repo
1 parent a8a2047 commit d9532e3

File tree

77 files changed

+11556
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+11556
-0
lines changed

‎i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/AccessScalarProducts.mdx‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
---
2+
tags:
3+
- Enterprise Standard
4+
- Enterprise Premium
5+
displayed_sidebar: docsJapanese
6+
---
7+
8+
# Kubernetes クラスター環境にデプロイされた ScalarDB または ScalarDL をアプリケーションから利用できるようにする
9+
10+
import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
11+
12+
<TranslationBanner />
13+
14+
このドキュメントでは、Kubernetes クラスター環境にデプロイされた ScalarDB または ScalarDL をアプリケーションから利用できるようにする方法について説明します。ScalarDB または ScalarDL をアプリケーションから利用できるようにするには、`<HELM_RELEASE_NAME>-envoy` という名前の Kubernetes サービスリソース経由で Scalar Envoy を使用します。`<HELM_RELEASE_NAME>-envoy` は次のようないくつかの方法で使用できます。
15+
16+
* ScalarDB または ScalarDL と同じ Kubernetes クラスター内から直接。
17+
* Kubernetes クラスターの外部からのロードバランサー経由。
18+
* `kubectl port-forward` コマンドを使用して踏み台サーバーから実行します (テスト目的のみ)。
19+
20+
リソース名 `<HELM_RELEASE_NAME>-envoy` は Helm リリース名に基づいて決定されます。次のコマンドを実行すると、helm リリース名を確認できます。
21+
22+
```console
23+
helm list -n ns-scalar
24+
```
25+
26+
次のような結果が表示されます：
27+
28+
```console
29+
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
30+
scalardb ns-scalar 1 2023-02-09 19:31:40.527130674 +0900 JST deployed scalardb-2.5.0 3.8.0
31+
scalardl-auditor ns-scalar 1 2023-02-09 19:32:03.008986045 +0900 JST deployed scalardl-audit-2.5.1 3.7.1
32+
scalardl-ledger ns-scalar 1 2023-02-09 19:31:53.459548418 +0900 JST deployed scalardl-4.5.1 3.7.1
33+
```
34+
35+
次のコマンドを実行すると、envoy サービス名 `<HELM_RELEASE_NAME>-envoy` を確認することもできます。
36+
37+
```console
38+
kubectl get service -n ns-scalar
39+
```
40+
41+
次のような結果が表示されます：
42+
43+
```console
44+
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
45+
scalardb-envoy LoadBalancer 10.99.245.143 <pending> 60051:31110/TCP 2m2s
46+
scalardb-envoy-metrics ClusterIP 10.104.56.87 <none> 9001/TCP 2m2s
47+
scalardb-headless ClusterIP None <none> 60051/TCP 2m2s
48+
scalardb-metrics ClusterIP 10.111.213.194 <none> 8080/TCP 2m2s
49+
scalardl-auditor-envoy LoadBalancer 10.111.141.43 <pending> 40051:31553/TCP,40052:31171/TCP 99s
50+
scalardl-auditor-envoy-metrics ClusterIP 10.104.245.188 <none> 9001/TCP 99s
51+
scalardl-auditor-headless ClusterIP None <none> 40051/TCP,40053/TCP,40052/TCP 99s
52+
scalardl-auditor-metrics ClusterIP 10.105.119.158 <none> 8080/TCP 99s
53+
scalardl-ledger-envoy LoadBalancer 10.96.239.167 <pending> 50051:32714/TCP,50052:30857/TCP 109s
54+
scalardl-ledger-envoy-metrics ClusterIP 10.97.204.18 <none> 9001/TCP 109s
55+
scalardl-ledger-headless ClusterIP None <none> 50051/TCP,50053/TCP,50052/TCP 109s
56+
scalardl-ledger-metrics ClusterIP 10.104.216.189 <none> 8080/TCP 109s
57+
```
58+
59+
## 同じ Kubernetes クラスター内からサービスリソースを介して、ScalarDB または ScalarDL へのアプリケーション (クライアント) リクエストを直接実行します。
60+
61+
アプリケーション (クライアント) を ScalarDB または ScalarDL と同じ Kubernetes クラスターにデプロイする場合 (たとえば、アプリケーション [クライアント] を同じ Kubernetes クラスター内の別のノードグループまたはプールにデプロイする場合)、アプリケーションは次の方法で ScalarDB または ScalarDL にアクセスできます。Kubernetes サービスリソースを使用します。サービスリソース名 (FQDN) の形式は、`<HELM_RELEASE_NAME>-envoy.<NAMESPACE>.svc.cluster.local` です。
62+
63+
以下は、`ns-scalar` 名前空間での ScalarDB および ScalarDL のデプロイメントの例です。
64+
65+
* **ScalarDB Server**
66+
```console
67+
scalardb-envoy.ns-scalar.svc.cluster.local
68+
```
69+
* **ScalarDL Ledger**
70+
```console
71+
scalardl-ledger-envoy.ns-scalar.svc.cluster.local
72+
```
73+
* **ScalarDL Auditor**
74+
```console
75+
scalardl-auditor-envoy.ns-scalar.svc.cluster.local
76+
```
77+
78+
Kubernetes サービスリソースを使用する場合、アプリケーション (クライアント) のプロパティファイルに上記の FQDN を次のように設定する必要があります。
79+
80+
* **ScalarDB Server のクライアントプロパティファイル**
81+
```properties
82+
scalar.db.contact_points=<HELM_RELEASE_NAME>-envoy.<NAMESPACE>.svc.cluster.local
83+
scalar.db.contact_port=60051
84+
scalar.db.storage=grpc
85+
scalar.db.transaction_manager=grpc
86+
```
87+
* **ScalarDL Ledger のクライアントプロパティファイル**
88+
```properties
89+
scalar.dl.client.server.host=<HELM_RELEASE_NAME>-envoy.<NAMESPACE>.svc.cluster.local
90+
scalar.dl.ledger.server.port=50051
91+
scalar.dl.ledger.server.privileged_port=50052
92+
```
93+
* **ScalarDL Auditor モードが有効になっている ScalarDL Ledger のクライアントプロパティファイル**
94+
```properties
95+
# Ledger
96+
scalar.dl.client.server.host=<HELM_RELEASE_NAME>-envoy.<NAMESPACE>.svc.cluster.local
97+
scalar.dl.ledger.server.port=50051
98+
scalar.dl.ledger.server.privileged_port=50052
99+
100+
# Auditor
101+
scalar.dl.client.auditor.enabled=true
102+
scalar.dl.client.auditor.host=<HELM_RELEASE_NAME>-envoy.<NAMESPACE>.svc.cluster.local
103+
scalar.dl.auditor.server.port=40051
104+
scalar.dl.auditor.server.privileged_port=40052
105+
```
106+
107+
## Kubernetes クラスターの外部からロードバランサー経由で ScalarDB または ScalarDL へのアプリケーション (クライアント) リクエストを実行します
108+
109+
ScalarDB または ScalarDL の Kubernetes クラスターの外部の環境にアプリケーション (クライアント) をデプロイする場合 (たとえば、アプリケーション [クライアント] を別の Kubernetes クラスター、コンテナープラットフォーム、またはサーバーにデプロイする場合)、アプリケーションは ScalarDB または ScalarDL にアクセスできます。各クラウドサービスが提供するロードバランサーを利用します。
110+
111+
カスタム値ファイルで `envoy.service.type` を `LoadBalancer` に設定することで、ロードバランサーを作成できます。カスタム値ファイルを構成した後、ロードバランサーを使用して、Kubernetes サービスリソースを通じて Scalar Envoy を使用できるようになります。注釈を使用してロードバランサーの構成を設定することもできます。
112+
113+
カスタム値ファイルの設定方法の詳細については、[サービス設定](../helm-charts/configure-custom-values-envoy.mdx#サービス構成)を参照してください。
114+
115+
ロードバランサを使用する場合、アプリケーション (クライアント) のプロパティファイルにロードバランサのFQDNまたはIPアドレスを以下のように設定する必要があります。
116+
117+
* **ScalarDB Server のクライアントプロパティファイル**
118+
```properties
119+
scalar.db.contact_points=<LOAD_BALANCER_FQDN_OR_IP_ADDRESS>
120+
scalar.db.contact_port=60051
121+
scalar.db.storage=grpc
122+
scalar.db.transaction_manager=grpc
123+
```
124+
* **ScalarDL Ledger のクライアントプロパティファイル**
125+
```properties
126+
scalar.dl.client.server.host=<LOAD_BALANCER_FQDN_OR_IP_ADDRESS>
127+
scalar.dl.ledger.server.port=50051
128+
scalar.dl.ledger.server.privileged_port=50052
129+
```
130+
* **ScalarDL Auditor モードが有効になっている ScalarDL Ledger のクライアントプロパティファイル**
131+
```properties
132+
# Ledger
133+
scalar.dl.client.server.host=<LOAD_BALANCER_FQDN_OR_IP_ADDRESS>
134+
scalar.dl.ledger.server.port=50051
135+
scalar.dl.ledger.server.privileged_port=50052
136+
137+
# Auditor
138+
scalar.dl.client.auditor.enabled=true
139+
scalar.dl.client.auditor.host=<LOAD_BALANCER_FQDN_OR_IP_ADDRESS>
140+
scalar.dl.auditor.server.port=40051
141+
scalar.dl.auditor.server.privileged_port=40052
142+
```
143+
144+
ロードバランサーの具体的な実装とアクセス方法は、Kubernetes クラスターに依存します。マネージド Kubernetes クラスターを使用している場合は、クラウドサービスプロバイダーに基づいて次の公式ドキュメントを参照してください。
145+
146+
* **Amazon Elastic Kubernetes Service (EKS)**
147+
* [Network load balancing on Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/network-load-balancing.html)
148+
* **Azure Kubernetes Service (AKS)**
149+
* [Use a public standard load balancer in Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/load-balancer-standard)
150+
* [Use an internal load balancer with Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/internal-lb)
151+
152+
## 踏み台サーバーから ScalarDB または ScalarDL へのクライアントリクエストを実行します (テスト目的のみ。運用環境では推奨されません)
153+
154+
`kubectl port-forward` コマンドを実行すると、踏み台サーバーから ScalarDB または ScalarDL へのクライアントリクエストを実行できます。ただし、ScalarDL Auditor モード環境を作成する場合、2つの Kubernetes クラスターにアクセスするには、1つの踏み台サーバーから異なる kubeconfig ファイルを使用して2つの `kubectl port-forward` コマンドを実行する必要があります。
155+
156+
1. **(ScalarDL Auditor モードのみ)** ScalarDL Ledger の踏み台サーバーで、ScalarDL Auditor の Kubernetes クラスターにアクセスするために既存の kubeconfig ファイルを構成するか、新しい kubeconfig ファイルを追加します。管理対象の各 Kubernetes クラスターの kubeconfig ファイルを構成する方法の詳細については、[kubeconfig の構成](CreateBastionServer.mdx#kubeconfig-の構成)を参照してください。
157+
2. 踏み台サーバーから各サービスへのポート転送を構成します。
158+
* **ScalarDB Server**
159+
```console
160+
kubectl port-forward -n <NAMESPACE> svc/<RELEASE_NAME>-envoy 60051:60051
161+
```
162+
* **ScalarDL Ledger**
163+
```console
164+
kubectl --context <CONTEXT_IN_KUBERNETES_FOR_SCALARDL_LEDGER> port-forward -n <NAMESPACE> svc/<RELEASE_NAME>-envoy 50051:50051
165+
kubectl --context <CONTEXT_IN_KUBERNETES_FOR_SCALARDL_LEDGER> port-forward -n <NAMESPACE> svc/<RELEASE_NAME>-envoy 50052:50052
166+
```
167+
* **ScalarDL Auditor**
168+
```console
169+
kubectl --context <CONTEXT_IN_KUBERNETES_FOR_SCALARDL_AUDITOR> port-forward -n <NAMESPACE> svc/<RELEASE_NAME>-envoy 40051:40051
170+
kubectl --context <CONTEXT_IN_KUBERNETES_FOR_SCALARDL_AUDITOR> port-forward -n <NAMESPACE> svc/<RELEASE_NAME>-envoy 40052:40052
171+
```
172+
3. `localhost` 経由で ScalarDB または ScalarDL にアクセスするようにプロパティファイルを設定します。
173+
* **ScalarDB Server のクライアントプロパティファイル**
174+
```properties
175+
scalar.db.contact_points=localhost
176+
scalar.db.contact_port=60051
177+
scalar.db.storage=grpc
178+
scalar.db.transaction_manager=grpc
179+
```
180+
* **ScalarDL Ledger のクライアントプロパティファイル**
181+
```properties
182+
scalar.dl.client.server.host=localhost
183+
scalar.dl.ledger.server.port=50051
184+
scalar.dl.ledger.server.privileged_port=50052
185+
```
186+
* **ScalarDL Auditor モードが有効になっている ScalarDL Ledger のクライアントプロパティファイル**
187+
```properties
188+
# Ledger
189+
scalar.dl.client.server.host=localhost
190+
scalar.dl.ledger.server.port=50051
191+
scalar.dl.ledger.server.privileged_port=50052
192+
193+
# Auditor
194+
scalar.dl.client.auditor.enabled=true
195+
scalar.dl.client.auditor.host=localhost
196+
scalar.dl.auditor.server.port=40051
197+
scalar.dl.auditor.server.privileged_port=40052
198+
```

0 commit comments

Comments
 (0)