AUTO: Sync Kubernetes docs to ScalarDL docs site repo

scalar-labs · Jul 29, 2024 · 7d1364d · 7d1364d
1 parent 5a34e7f
commit 7d1364d
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 15 deletions.
diff --git a/...cusaurus-plugin-content-docs/current/scalar-kubernetes/AccessScalarProducts.mdx b/...cusaurus-plugin-content-docs/current/scalar-kubernetes/AccessScalarProducts.mdx
@@ -10,20 +10,30 @@ import TranslationBanner from '/src/components/_translation-ja-jp.mdx';
 * Kubernetes クラスターの外部からのロード バランサー経由。
 * `kubectl port-forward` コマンドを使用して要塞サーバーから実行します (テスト目的のみ)。
 
-リソース名 `<HELM_RELEASE_NAME>-envoy` は Helm リリース名に基づいて決定されます。 `helm list` コマンドを実行すると、helm リリース名を確認できます。
+リソース名 `<HELM_RELEASE_NAME>-envoy` は Helm リリース名に基づいて決定されます。 次のコマンドを実行すると、helm リリース名を確認できます。
+
+```console
+helm list -n ns-scalar
+```
+
+次のような結果が表示されます：
 
 ```console
-$ helm list -n ns-scalar
 NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS                                                       CHART                    APP VERSION
 scalardb                ns-scalar       1               2023-02-09 19:31:40.527130674 +0900 JST deployed                                                     scalardb-2.5.0           3.8.0
 scalardl-auditor        ns-scalar       1               2023-02-09 19:32:03.008986045 +0900 JST deployed                                                     scalardl-audit-2.5.1     3.7.1
 scalardl-ledger         ns-scalar       1               2023-02-09 19:31:53.459548418 +0900 JST deployed                                                     scalardl-4.5.1           3.7.1
 ```
 
-`kubectl get service` コマンドを実行すると、envoy サービス名 `<HELM_RELEASE_NAME>-envoy` を確認することもできます。
+次のコマンドを実行すると、envoy サービス名 `<HELM_RELEASE_NAME>-envoy` を確認することもできます。
+
+```console
+kubectl get service -n ns-scalar
+```
+
+次のような結果が表示されます：
 
 ```console
-$ kubectl get service -n ns-scalar
 NAME                             TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)                           AGE
 scalardb-envoy                   LoadBalancer   10.99.245.143    <pending>     60051:31110/TCP                   2m2s
 scalardb-envoy-metrics           ClusterIP      10.104.56.87     <none>        9001/TCP                          2m2s

diff --git a/.../ja-jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/BackupNoSQL.mdx b/.../ja-jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/BackupNoSQL.mdx
@@ -55,20 +55,30 @@ Scalar Helm Chart を使用して ScalarDB または ScalarDL をデプロイす
     _scalardl-auditor-admin._tcp.<helm release name>-headless.<namespace>.svc.cluster.local
     ```
 
-Helm リリース名によって、ヘッドレス サービス名 `<helm release name>-headless` が決まります。 `helm list` コマンドを実行すると、helm リリース名を確認できます。
+Helm リリース名によって、ヘッドレス サービス名 `<helm release name>-headless` が決まります。 次のコマンドを実行すると、helm リリース名を確認できます。
+
+```console
+helm list -n ns-scalar
+```
+
+次のような結果が表示されます：
 
 ```console
-$ helm list -n ns-scalar
 NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS                                                       CHART                    APP VERSION
 scalardb                ns-scalar       1               2023-02-09 19:31:40.527130674 +0900 JST deployed                                                     scalardb-2.5.0           3.8.0
 scalardl-auditor        ns-scalar       1               2023-02-09 19:32:03.008986045 +0900 JST deployed                                                     scalardl-audit-2.5.1     3.7.1
 scalardl-ledger         ns-scalar       1               2023-02-09 19:31:53.459548418 +0900 JST deployed                                                     scalardl-4.5.1           3.7.1
 ```
 
-`kubectl get service` コマンドを実行すると、ヘッドレス サービス名 `<helm release name>-headless` を確認することもできます。
+次のコマンドを実行すると、ヘッドレス サービス名 `<helm release name>-headless` を確認することもできます。
+
+```console
+kubectl get service -n ns-scalar
+```
+
+次のような結果が表示されます：
 
 ```console
-$ kubectl get service -n ns-scalar
 NAME                             TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)                           AGE
 scalardb-envoy                   LoadBalancer   10.99.245.143    <pending>     60051:31110/TCP                   2m2s
 scalardb-envoy-metrics           ClusterIP      10.104.56.87     <none>        9001/TCP                          2m2s

diff --git a/...usaurus-plugin-content-docs/current/scalar-kubernetes/K8sLogCollectionGuide.mdx b/...usaurus-plugin-content-docs/current/scalar-kubernetes/K8sLogCollectionGuide.mdx
@@ -126,10 +126,15 @@ helm install scalar-logging-loki grafana/loki-stack -n monitoring -f scalar-loki
 
 ## Loki と Promtail がデプロイされているかどうかを確認する
 
-Loki および Promtail ポッドが適切にデプロイされている場合は、`kubectl get pod -n monitoring` コマンドを使用して、`STATUS` が `Running` であることが確認できます。 promtail ポッドは DaemonSet としてデプロイされるため、promtail ポッドの数は Kubernetes ノードの数によって異なります。 次の例では、Kubernetes クラスター内に Scalar 製品のワーカーノードが 3 つあります。
+Loki および Promtail ポッドが適切にデプロイされている場合は、次のコマンドを使用して、`STATUS` が `Running` であることが確認できます。 promtail ポッドは DaemonSet としてデプロイされるため、promtail ポッドの数は Kubernetes ノードの数によって異なります。 次の例では、Kubernetes クラスター内に Scalar 製品のワーカーノードが 3 つあります。
 
+```console
+kubectl get pod -n monitoring
 ```
-$ kubectl get pod -n monitoring
+
+次のような結果が表示されます：
+
+```console
 NAME                                 READY   STATUS    RESTARTS   AGE
 scalar-logging-loki-0                1/1     Running   0          35m
 scalar-logging-loki-promtail-2fnzn   1/1     Running   0          32m

diff --git a/...jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/K8sMonitorGuide.mdx b/...jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/K8sMonitorGuide.mdx
@@ -56,10 +56,15 @@ Scalar 製品は、Prometheus Operator がデフォルトで `monitoring` 名前
 
 ## Prometheus Operator がデプロイされているかどうかを確認する
 
-Prometheus Operator (Prometheus、Alertmanager、Grafana を含む) ポッドが適切にデプロイされている場合は、`kubectl get pod -n monitoring` コマンドを使用して `STATUS` が `Running` であることを確認できます。
+Prometheus Operator (Prometheus、Alertmanager、Grafana を含む) ポッドが適切にデプロイされている場合は、次のコマンドを使用して `STATUS` が `Running` であることを確認できます。
 
+```console
+kubectl get pod -n monitoring
 ```
-$ kubectl get pod -n monitoring
+
+次のような結果が表示されます：
+
+```console
 NAME                                                     READY   STATUS    RESTARTS   AGE
 alertmanager-scalar-monitoring-kube-pro-alertmanager-0   2/2     Running   0          55s
 prometheus-scalar-monitoring-kube-pro-prometheus-0       2/2     Running   0          55s

diff --git a/...ja-jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/RegularCheck.mdx b/...ja-jp/docusaurus-plugin-content-docs/current/scalar-kubernetes/RegularCheck.mdx
@@ -21,7 +21,12 @@ Kubernetes 名前空間を確認してください。
 * ポッドはさまざまなノードに均等に分散されます。
 
 ```console
-$ kubectl get pod -o wide -n <namespace>
+kubectl get pod -o wide -n <namespace>
+```
+
+次のような結果が表示されます：
+
+```console
 NAME                              READY   STATUS    RESTARTS   AGE     IP           NODE          NOMINATED NODE   READINESS GATES
 scalardb-7876f595bd-2jb28         1/1     Running   0          2m35s   10.244.2.6   k8s-worker2   <none>           <none>
 scalardb-7876f595bd-rfvk6         1/1     Running   0          2m35s   10.244.1.8   k8s-worker    <none>           <none>
@@ -32,7 +37,12 @@ scalardb-envoy-84c475f77b-vztqr   1/1     Running   0          2m35s   10.244.2.
 ```
 
 ```console
-$ kubectl get pod -n monitoring -o wide
+kubectl get pod -n monitoring -o wide
+```
+
+次のような結果が表示されます：
+
+```console
 NAME                                                     READY   STATUS    RESTARTS      AGE   IP           NODE                NOMINATED NODE   READINESS GATES
 alertmanager-scalar-monitoring-kube-pro-alertmanager-0   2/2     Running   1 (11m ago)   12m   10.244.2.4   k8s-worker2         <none>           <none>
 prometheus-scalar-monitoring-kube-pro-prometheus-0       2/2     Running   0             12m   10.244.1.5   k8s-worker          <none>           <none>
@@ -52,7 +62,12 @@ scalar-monitoring-kube-pro-operator-7575dd8bbd-bxhrc     1/1     Running   0
 * `STATUS` はすべて `Ready` です。
 
 ```console
-$ kubectl get nodes
+kubectl get nodes
+```
+
+次のような結果が表示されます：
+
+```console
 NAME                STATUS   ROLES           AGE   VERSION
 k8s-control-plane   Ready    control-plane   16m   v1.25.3
 k8s-worker          Ready    <none>          15m   v1.25.3