|
| 1 | +import Tabs from '@theme/Tabs'; |
| 2 | +import TabItem from '@theme/TabItem'; |
| 3 | +import CodeBlock from '@theme/CodeBlock'; |
| 4 | + |
| 5 | +<h3>Prerequisites</h3> |
| 6 | + |
| 7 | +1. Add the Scalar Helm Chart repository and update it to the latest version by using the `helm repo add` command and `helm repo update` command as follows: |
| 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. Decide on the version of the ScalarDB product (strictly, the corresponding chart version) that you will deploy or upgrade. You can check the version by running the following command: |
| 14 | + |
| 15 | + <CodeBlock language="console">helm search repo scalar-labs/<CHART_NAME> -l</CodeBlock> |
| 16 | + |
| 17 | + :::tip |
| 18 | + |
| 19 | + In this document (when you deploy the {props.productName}), run the following command: |
| 20 | + |
| 21 | + <CodeBlock language="console">helm search repo scalar-labs/{props.helmChartName} -l</CodeBlock> |
| 22 | + |
| 23 | + ::: |
| 24 | + |
| 25 | + For example, you should see a similar output as below: |
| 26 | + |
| 27 | + <CodeBlock language="console">NAME CHART VERSION APP VERSION |
| 28 | + scalar-labs/<CHART_NAME> 1.9.0 3.16.1 |
| 29 | + scalar-labs/<CHART_NAME> 1.8.1 3.16.1 |
| 30 | + scalar-labs/<CHART_NAME> 1.8.0 3.16.0 |
| 31 | + scalar-labs/<CHART_NAME> 1.7.6 3.15.5 |
| 32 | + scalar-labs/<CHART_NAME> 1.7.5 3.15.5 |
| 33 | + scalar-labs/<CHART_NAME> 1.7.4 3.15.5 |
| 34 | + scalar-labs/<CHART_NAME> 1.7.3 3.15.4 |
| 35 | + scalar-labs/<CHART_NAME> 1.7.2 3.15.3 |
| 36 | + scalar-labs/<CHART_NAME> 1.7.1 3.15.2 |
| 37 | + scalar-labs/<CHART_NAME> 1.7.0 3.15.1 |
| 38 | + scalar-labs/<CHART_NAME> 1.6.4 3.14.4 |
| 39 | + scalar-labs/<CHART_NAME> 1.6.3 3.14.3 |
| 40 | + scalar-labs/<CHART_NAME> 1.6.2 3.14.2 |
| 41 | + scalar-labs/<CHART_NAME> 1.6.1 3.14.1 |
| 42 | + scalar-labs/<CHART_NAME> 1.6.0 3.14.0</CodeBlock> |
| 43 | + |
| 44 | + :::note |
| 45 | + |
| 46 | + - `APP VERSION` means the version of the ScalarDB product itself. First, check this version to decide which version of the ScalarDB product you will deploy or upgrade. |
| 47 | + - After checking the version under `APP VERSION` and deciding which version of the ScalarDB product you will deploy or upgrade, note the corresponding version under `CHART VERSION`. |
| 48 | + - If there are several of the same versions under `APP VERSION`, note the latest version under `CHART VERSION`. |
| 49 | + - For example: |
| 50 | + - If you want to deploy the ScalarDB product 3.16.1, note `1.9.0` as `CHART VERSION`. |
| 51 | + - If you want to deploy the ScalarDB product 3.15.5, note `1.7.6` as `CHART VERSION`. |
| 52 | + - If you want to deploy the ScalarDB product 3.14.4, note `1.6.4` as `CHART VERSION`. |
| 53 | + |
| 54 | + ::: |
| 55 | + |
| 56 | +<h3>Deploy, upgrade, or uninstall</h3> |
| 57 | + |
| 58 | +<Tabs groupId="operations" queryString> |
| 59 | + <TabItem value="deploy" label="Deploy" default> |
| 60 | + Deploy the {props.productName} by using the `helm install` command as follows: |
| 61 | + |
| 62 | + <CodeBlock language="console">helm install <RELEASE_NAME> scalar-labs/{props.helmChartName} -f {props.helmChartName}.yaml --namespace <KUBERNETES_NAMESPACE> --version <CHART_VERSION></CodeBlock> |
| 63 | + |
| 64 | + :::note |
| 65 | + |
| 66 | + - Change `<RELEASE_NAME>` to the arbitrary (unique) name of your deployment. |
| 67 | + - For the `--namespace` option, change `<KUBERNETES_NAMESPACE>` to the name of the Kubernetes namespace that you want to deploy the {props.productName} to. |
| 68 | + - For the `--version` option, change `<CHART_VERSION>` to the version that you noted in the previous step. |
| 69 | + |
| 70 | + ::: |
| 71 | + </TabItem> |
| 72 | + <TabItem value="upgrade" label="Upgrade"> |
| 73 | + Upgrade the existing {props.productName} deployment by using the `helm upgrade` command as follows: |
| 74 | + |
| 75 | + <CodeBlock language="console">helm upgrade <RELEASE_NAME> scalar-labs/{props.helmChartName} -f {props.helmChartName}.yaml --namespace <KUBERNETES_NAMESPACE> --version <CHART_VERSION></CodeBlock> |
| 76 | + |
| 77 | + :::note |
| 78 | + |
| 79 | + - Change `<RELEASE_NAME>` to the arbitrary (unique) name of the deployment that you want to upgrade. |
| 80 | + - For the `--namespace` option, change `<KUBERNETES_NAMESPACE>` to the name of the Kubernetes namespace that you want to upgrade the {props.productName} of. |
| 81 | + - For the `--version` option, change `<CHART_VERSION>` to the version that you noted in the previous step. |
| 82 | + |
| 83 | + ::: |
| 84 | + |
| 85 | + :::important |
| 86 | + |
| 87 | + Downgrading the version of the {props.productName} is not supported. When specifying a version number, you can do only the following: |
| 88 | + |
| 89 | + - Specify the same version as the existing deployment. For example, you might do this when updating configurations. |
| 90 | + - Specify a version that is greater than the existing deployment. For example, you might do this when upgrading the version of the {props.productName}. |
| 91 | + |
| 92 | + ::: |
| 93 | + </TabItem> |
| 94 | + <TabItem value="uninstall" label="Uninstall"> |
| 95 | + Uninstall the existing {props.productName} deployment by using the `helm uninstall` command as follows: |
| 96 | + |
| 97 | + <CodeBlock language="console">helm uninstall <RELEASE_NAME> --namespace <KUBERNETES_NAMESPACE></CodeBlock> |
| 98 | + |
| 99 | + :::note |
| 100 | + |
| 101 | + - Change `<RELEASE_NAME>` to the arbitrary (unique) name of the deployment that you want to uninstall. |
| 102 | + - For the `--namespace` option, change `<KUBERNETES_NAMESPACE>` to the name of the Kubernetes namespace that you want to uninstall the {props.productName} of. |
| 103 | + |
| 104 | + ::: |
| 105 | + </TabItem> |
| 106 | +</Tabs> |
0 commit comments