Skip to content

Commit 21ce7c8

Browse files
AUTO: Sync ScalarDB components to docs site repo (#1728)
Co-authored-by: josh-wong <[email protected]>
1 parent 74af428 commit 21ce7c8

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
import CodeBlock from '@theme/CodeBlock';
4+
5+
<h3>前提条件</h3>
6+
7+
1. `helm repo add` コマンドと `helm repo update` コマンドを使用して、Scalar Helm Chart リポジトリを追加し、最新バージョンに更新してください。
8+
9+
<CodeBlock language="console">helm repo add scalar-labs https://scalar-labs.github.io/helm-charts</CodeBlock>
10+
11+
<CodeBlock language="console">helm repo update</CodeBlock>
12+
13+
1. デプロイまたはアップグレードする ScalarDB 製品のバージョン(厳密には、対応するチャートバージョン)を決定してください。以下のコマンドを実行してバージョンを確認できます。
14+
15+
<CodeBlock language="console">helm search repo scalar-labs/&lt;CHART_NAME&gt; -l</CodeBlock>
16+
17+
:::tip
18+
19+
このドキュメントでは({props.productName} をデプロイする場合)、以下のコマンドを実行してください。
20+
21+
<CodeBlock language="console">helm search repo scalar-labs/{props.helmChartName} -l</CodeBlock>
22+
23+
:::
24+
25+
例えば、以下のような出力が表示されます。
26+
27+
<CodeBlock language="console">NAME CHART VERSION APP VERSION
28+
scalar-labs/&lt;CHART_NAME&gt; 1.9.0 3.16.1
29+
scalar-labs/&lt;CHART_NAME&gt; 1.8.1 3.16.1
30+
scalar-labs/&lt;CHART_NAME&gt; 1.8.0 3.16.0
31+
scalar-labs/&lt;CHART_NAME&gt; 1.7.6 3.15.5
32+
scalar-labs/&lt;CHART_NAME&gt; 1.7.5 3.15.5
33+
scalar-labs/&lt;CHART_NAME&gt; 1.7.4 3.15.5
34+
scalar-labs/&lt;CHART_NAME&gt; 1.7.3 3.15.4
35+
scalar-labs/&lt;CHART_NAME&gt; 1.7.2 3.15.3
36+
scalar-labs/&lt;CHART_NAME&gt; 1.7.1 3.15.2
37+
scalar-labs/&lt;CHART_NAME&gt; 1.7.0 3.15.1
38+
scalar-labs/&lt;CHART_NAME&gt; 1.6.4 3.14.4
39+
scalar-labs/&lt;CHART_NAME&gt; 1.6.3 3.14.3
40+
scalar-labs/&lt;CHART_NAME&gt; 1.6.2 3.14.2
41+
scalar-labs/&lt;CHART_NAME&gt; 1.6.1 3.14.1
42+
scalar-labs/&lt;CHART_NAME&gt; 1.6.0 3.14.0</CodeBlock>
43+
44+
:::note
45+
46+
- `APP VERSION` は ScalarDB 製品自体のバージョンを意味します。まず、このバージョンを確認して、デプロイまたはアップグレードする ScalarDB 製品のバージョンを決定してください。
47+
- `APP VERSION` でバージョンを確認し、デプロイまたはアップグレードする ScalarDB 製品のバージョンを決定した後、`CHART VERSION` の対応するバージョンをメモしてください。
48+
- `APP VERSION` で同じバージョンが複数ある場合は、`CHART VERSION` の最新バージョンをメモしてください。
49+
- 例:
50+
- ScalarDB 製品 3.16.1 をデプロイしたい場合は、`CHART VERSION` として `1.9.0` をメモしてください。
51+
- ScalarDB 製品 3.15.5 をデプロイしたい場合は、`CHART VERSION` として `1.7.6` をメモしてください。
52+
- ScalarDB 製品 3.14.4 をデプロイしたい場合は、`CHART VERSION` として `1.6.4` をメモしてください。
53+
54+
:::
55+
56+
<h3>デプロイ、アップグレード、またはアンインストール</h3>
57+
58+
<Tabs groupId="operations" queryString>
59+
<TabItem value="deploy" label="デプロイ" default>
60+
以下のように `helm install` コマンドを使用して {props.productName} をデプロイしてください。
61+
62+
<CodeBlock language="console">helm install &lt;RELEASE_NAME&gt; scalar-labs/{props.helmChartName} -f {props.helmChartName}.yaml --namespace &lt;KUBERNETES_NAMESPACE&gt; --version &lt;CHART_VERSION&gt;</CodeBlock>
63+
64+
:::note
65+
66+
- `<RELEASE_NAME>` をデプロイメントの任意の(一意の)名前に変更してください。
67+
- `--namespace` オプションについては、`<KUBERNETES_NAMESPACE>`{props.productName} をデプロイしたい Kubernetes 名前空間の名前に変更してください。
68+
- `--version` オプションについては、`<CHART_VERSION>` を前のステップでメモしたバージョンに変更してください。
69+
70+
:::
71+
</TabItem>
72+
<TabItem value="upgrade" label="アップグレード">
73+
以下のように `helm upgrade` コマンドを使用して既存の {props.productName} デプロイメントをアップグレードしてください。
74+
75+
<CodeBlock language="console">helm upgrade &lt;RELEASE_NAME&gt; scalar-labs/{props.helmChartName} -f {props.helmChartName}.yaml --namespace &lt;KUBERNETES_NAMESPACE&gt; --version &lt;CHART_VERSION&gt;</CodeBlock>
76+
77+
:::note
78+
79+
- `<RELEASE_NAME>` をアップグレードしたいデプロイメントの任意の(一意の)名前に変更してください。
80+
- `--namespace` オプションについては、`<KUBERNETES_NAMESPACE>`{props.productName} をアップグレードしたい Kubernetes 名前空間の名前に変更してください。
81+
- `--version` オプションについては、`<CHART_VERSION>` を前のステップでメモしたバージョンに変更してください。
82+
83+
:::
84+
85+
:::important
86+
87+
{props.productName} のバージョンのダウングレードはサポートされていません。バージョン番号を指定する際は、以下のことのみ可能です。
88+
89+
- 既存のデプロイメントと同じバージョンを指定する。例えば、設定を更新する場合などに行うことがあります。
90+
- 既存のデプロイメントよりも大きなバージョンを指定する。例えば、{props.productName} のバージョンをアップグレードする場合などに行うことがあります。
91+
92+
:::
93+
</TabItem>
94+
<TabItem value="uninstall" label="アンインストール">
95+
以下のように `helm uninstall` コマンドを使用して既存の {props.productName} デプロイメントをアンインストールしてください。
96+
97+
<CodeBlock language="console">helm uninstall &lt;RELEASE_NAME&gt; --namespace &lt;KUBERNETES_NAMESPACE&gt;</CodeBlock>
98+
99+
:::note
100+
101+
- `<RELEASE_NAME>` をアンインストールしたいデプロイメントの任意の(一意の)名前に変更してください。
102+
- `--namespace` オプションについては、`<KUBERNETES_NAMESPACE>`{props.productName} をアンインストールしたい Kubernetes 名前空間の名前に変更してください。
103+
104+
:::
105+
</TabItem>
106+
</Tabs>

0 commit comments

Comments
 (0)