Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AUTO: Docs repo sync - Scalar Kubernetes #416

Merged
merged 1 commit into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/scalar-kubernetes/HowToScaleScalarDB.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# How to Scale ScalarDB

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide explains how to scale ScalarDB.

:::note

You might be able to resolve some performance issues by scaling ScalarDB Cluster if a bottleneck exists on the ScalarDB Cluster side. However, sometimes a performance issue is caused by a bottleneck in the backend databases. In such cases, scaling ScalarDB Cluster will not resolve the performance issue.

Instead, please check where the bottleneck exists. If the bottleneck exists in the backend databases, consider scaling the backend databases.

:::

<Tabs groupId="editions" queryString>
<TabItem value="ScalarDB_Cluster" label="ScalarDB Cluster (Enterprise edition)" default>
Select your preferred tool for scaling ScalarDB Cluster.

<Tabs groupId="tools" queryString>
<TabItem value="Helm_Chart" label="Using Scalar Helm Chart (recommended)" default>

If you use [Scalar Helm Chart](https://github.com/scalar-labs/helm-charts) to deploy ScalarDB Cluster, you can scale your ScalarDB Cluster deployment as follows:

1. Add the following to your custom values file, replacing `<NUMBER_OF_PODS>` with the number of pods you want to scale:

```yaml
scalardbCluster:
replicaCount: <NUMBER_OF_PODS>
```

1. Upgrade your ScalarDB Cluster deployment by running the following `helm upgrade` command, which uses the updated custom values file. Be sure to replace the contents in the angle brackets as described:

```console
helm upgrade <RELEASE_NAME> scalar-labs/scalardb-cluster -n <NAMESPACE> -f /<PATH_TO_YOUR_CUSTOM_VALUES_FILE_FOR_SCALARDB_CLUSTER> --version <CHART_VERSION>
```

</TabItem>
<TabItem value="kubectl" label="Using kubectl">

If you deploy ScalarDB Cluster in a Kubernetes environment, you can temporarily scale your ScalarDB Cluster deployment by using the `kubectl scale` command.

1. Run the following `kubectl scale` command, replacing the contents in the angle brackets as described:

```console
kubectl scale --replicas=<NUMBER_OF_PODS> deployment/<DEPLOYMENT_RESOURCE_NAME_OF_SCALARDB_CLUSTER>
```
</TabItem>
</Tabs>
</TabItem>
<TabItem value="ScalarDB_Core" label="ScalarDB Core library (Community edition)">
<h2>Scale ScalarDB Core</h2>

ScalarDB Core is provided as a Java library. So, when you scale your application, ScalarDB scales with your application.

</TabItem>
</Tabs>

86 changes: 86 additions & 0 deletions docs/scalar-kubernetes/HowToScaleScalarDL.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# How to Scale ScalarDL

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide explains how to scale ScalarDL.

:::note

You might be able to resolve some performance issues by scaling ScalarDL if a bottleneck exists on the ScalarDL side. However, sometimes a performance issue is caused by a bottleneck in the backend databases. In such cases, scaling ScalarDL will not resolve the performance issue.

Instead, please check where the bottleneck exists. If the bottleneck exists in the backend databases, consider scaling the backend databases.

:::

<Tabs groupId="components" queryString>
<TabItem value="ScalarDL_Ledger" label="ScalarDL Ledger" default>
Select your preferred tool for scaling ScalarDL Ledger.

<Tabs groupId="tools" queryString>
<TabItem value="Helm_Chart" label="Using Scalar Helm Chart (recommended)" default>

If you use [Scalar Helm Chart](https://github.com/scalar-labs/helm-charts) to deploy ScalarDL Ledger, you can scale your ScalarDL Ledger deployment as follows:

1. Add the following to your custom values file, replacing `<NUMBER_OF_PODS>` with the number of pods you want to scale:

```yaml
ledger:
replicaCount: <NUMBER_OF_PODS>
```

1. Upgrade your ScalarDL Ledger deployment by running the following `helm upgrade` command, which uses the updated custom values file. Be sure to replace the contents in the angle brackets as described:

```console
helm upgrade <RELEASE_NAME> scalar-labs/scalardl -n <NAMESPACE> -f /<PATH_TO_YOUR_CUSTOM_VALUES_FILE_FOR_SCALARDL_LEDGER> --version <CHART_VERSION>
```

</TabItem>
<TabItem value="kubectl" label="Using kubectl">

If you deploy ScalarDL Ledger in a Kubernetes environment, you can temporarily scale your ScalarDL Ledger deployment by using the `kubectl scale` command.

1. Run the following `kubectl scale` command, replacing the contents in the angle brackets as described:

```console
kubectl scale --replicas=<NUMBER_OF_PODS> deployment/<DEPLOYMENT_RESOURCE_NAME_OF_SCALARDL_LEDGER>
```
</TabItem>
</Tabs>
</TabItem>
<TabItem value="ScalarDL_Auditor" label="ScalarDL Auditor" default>
Select your preferred tool for scaling ScalarDL Auditor.

<Tabs groupId="tools" queryString>
<TabItem value="Helm_Chart" label="Using Scalar Helm Chart (recommended)" default>

If you use [Scalar Helm Chart](https://github.com/scalar-labs/helm-charts) to deploy ScalarDL Auditor, you can scale your ScalarDL Auditor deployment as follows:

1. Add the following to your custom values file, replacing `<NUMBER_OF_PODS>` with the number of pods you want to scale:

```yaml
auditor:
replicaCount: <NUMBER_OF_PODS>
```

1. Upgrade your ScalarDL Auditor deployment by running the following `helm upgrade` command, which uses the updated custom values file. Be sure to replace the contents in the angle brackets as described:

```console
helm upgrade <RELEASE_NAME> scalar-labs/scalardl-audit -n <NAMESPACE> -f /<PATH_TO_YOUR_CUSTOM_VALUES_FILE_FOR_SCALARDL_AUDITOR> --version <CHART_VERSION>
```

</TabItem>
<TabItem value="kubectl" label="Using kubectl">

If you deploy ScalarDL Auditor in a Kubernetes environment, you can temporarily scale your ScalarDL Auditor deployment by using the `kubectl scale` command.

1. Run the following `kubectl scale` command, replacing the contents in the angle brackets as described:

```console
kubectl scale --replicas=<NUMBER_OF_PODS> deployment/<DEPLOYMENT_RESOURCE_NAME_OF_SCALARDL_AUDITOR>
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>