Skip to content

Commit 85b38b7

Browse files
josh-wongjosh-wong
committed
AUTO: Sync Kubernetes docs to ScalarDB docs site repo
1 parent afc2204 commit 85b38b7

File tree

61 files changed

+5003
-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.

61 files changed

+5003
-0
lines changed

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

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

0 commit comments

Comments
 (0)