Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,7 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
helm repo add scalar-labs https://scalar-labs.github.io/helm-charts
```

2. Set your license key and certificate as environment variables. If you don't have a license key, please [contact us](https://www.scalar-labs.com/contact). For details about the value for `<CERT_PEM_FOR_YOUR_LICENSE_KEY>`, see [How to Configure a Product License Key](../scalar-licensing/README.mdx).

```console
SCALAR_DB_CLUSTER_LICENSE_KEY='<YOUR_LICENSE_KEY>'
SCALAR_DB_CLUSTER_LICENSE_CHECK_CERT_PEM='<CERT_PEM_FOR_YOUR_LICENSE_KEY>'
```

3. Create a custom values file for ScalarDB Cluster (`scalardb-cluster-custom-values.yaml`):
2. Create a custom values file for ScalarDB Cluster (`scalardb-cluster-custom-values.yaml`):

```console
cat << 'EOF' > scalardb-cluster-custom-values.yaml
Expand Down Expand Up @@ -147,10 +140,10 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
secretName: "scalardb-credentials-secret"
EOF
```

For the tutorials, the service type for ScalarDB Cluster GraphQL and Envoy is set to `LoadBalancer`.

4. Create a secret resource named `scalardb-credentials-secret` that includes credentials and license keys.
3. Create a secret resource named `scalardb-credentials-secret` that includes credentials and license keys.

```console
kubectl create secret generic scalardb-credentials-secret \
Expand All @@ -162,27 +155,27 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
-n default
```

5. Set the chart version of ScalarDB Cluster.
4. Set the chart version of ScalarDB Cluster.

```console
SCALAR_DB_CLUSTER_VERSION=3.12.5
SCALAR_DB_CLUSTER_CHART_VERSION=$(helm search repo scalar-labs/scalardb-cluster -l | grep -F "${SCALAR_DB_CLUSTER_VERSION}" | awk '{print $2}' | sort --version-sort -r | head -n 1)
```

6. Deploy ScalarDB Cluster.
5. Deploy ScalarDB Cluster.

```console
helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml --version ${SCALAR_DB_CLUSTER_CHART_VERSION} -n default
```

7. Check if the ScalarDB Cluster pods are deployed:
6. Check if the ScalarDB Cluster pods are deployed:

```console
kubectl get pod
```

Command execution result:

```console
NAME READY STATUS RESTARTS AGE
postgresql-scalardb-cluster-0 1/1 Running 0 84s
Expand All @@ -193,17 +186,17 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
scalardb-cluster-node-866c756c79-9zhq5 1/1 Running 0 35s
scalardb-cluster-node-866c756c79-t6v86 1/1 Running 0 35s
```

If the ScalarDB Cluster Node Pods and the Envoy Pods are deployed properly, the `STATUS` for each pod will be `Running`.

8. Check if the service resources of the ScalarDB Cluster are deployed:
7. Check if the service resources of the ScalarDB Cluster are deployed:

```console
kubectl get svc
```

Command execution result:

```console
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 260d
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,10 +212,6 @@ You can use the primary key or the secondary key in your Azure Cosmos DB account
</TabItem>
</Tabs>

### Set the license key

Set the license key (trial license or commercial license) for the ScalarDB Clusters in the configuration file `scalardb-cluster-node.properties`. For details, see [How to Configure a Product License Key](../scalar-licensing/README.mdx).

### Start ScalarDB Cluster in standalone mode

To start ScalarDB Cluster in standalone mode, run the following command:
Expand Down
1 change: 0 additions & 1 deletion versioned_docs/version-3.11/scalardb-samples/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ The following are sample applications for ScalarDB:
- [Multi-storage Transaction Sample](multi-storage-transaction-sample/README.mdx)
- [Microservice Transaction Sample](microservice-transaction-sample/README.mdx)
- [ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql-sample/README.mdx)
- [ScalarDB Analytics with Spark](scalardb-analytics-spark-sample/README.mdx)
- [Spring Data JDBC for ScalarDB with Multi-storage Transaction Sample](spring-data-multi-storage-transaction-sample/README.mdx)
- [Spring Data JDBC for ScalarDB with Microservice Transaction Sample](spring-data-microservice-transaction-sample/README.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,6 @@ scalar.db.consensus_commit.isolation_level=SERIALIZABLE

scalar.db.cluster.node.standalone_mode.enabled=true
scalar.db.sql.enabled=true

# License key configurations
scalar.db.cluster.node.licensing.license_key=
scalar.db.cluster.node.licensing.license_check_cert_pem=
```

- `scalar.db.sql.connection_mode`: This configuration decides how to connect to ScalarDB.
Expand All @@ -136,10 +132,6 @@ scalar.db.consensus_commit.isolation_level=SERIALIZABLE

scalar.db.cluster.node.standalone_mode.enabled=true
scalar.db.sql.enabled=true

# License key configurations
scalar.db.cluster.node.licensing.license_key=
scalar.db.cluster.node.licensing.license_check_cert_pem=
```

- `scalar.db.storage`: `cassandra` is specified since this servcise uses only Cassandra as an underlying database.
Expand All @@ -152,8 +144,6 @@ scalar.db.cluster.node.licensing.license_check_cert_pem=

In this sample application, the ScalarDB Clusters are running in standalone mode (`scalar.db.cluster.node.standalone_mode.enabled=true`).

Also, you need to set the license key (trial license or commercial license) for the ScalarDB Clusters in the configuration file. For details, see [How to Configure a Product License Key](../../scalar-licensing/README.mdx).

## Setup

### Clone the ScalarDB samples repository
Expand All @@ -170,10 +160,6 @@ Then, go to the directory with this sample by running the following command:
cd scalardb-samples/spring-data-microservice-transaction-sample
```

### Set the license key

Set the license key (trial license or commercial license) for the ScalarDB Clusters in the configuration files [`scalardb-cluster-node-for-customer-service.properties`](https://github.com/scalar-labs/scalardb-samples/blob/main/spring-data-microservice-transaction-sample/scalardb-cluster-node-for-customer-service.properties) and [`scalardb-cluster-node-for-order-service.properties`](https://github.com/scalar-labs/scalardb-samples/blob/main/spring-data-microservice-transaction-sample/scalardb-cluster-node-for-order-service.properties). For details, see [How to Configure a Product License Key](../../scalar-licensing/README.mdx).

### Start Cassandra, MySQL, and ScalarDB Clusters

To start Cassandra, MySQL, and ScalarDB Clusters, you need to run the following `docker-compose` command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,6 @@ scalar.db.multi_storage.default_storage=cassandra

scalar.db.cluster.node.standalone_mode.enabled=true
scalar.db.sql.enabled=true

# License key configurations
scalar.db.cluster.node.licensing.license_key=
scalar.db.cluster.node.licensing.license_check_cert_pem=
```

- `scalar.db.storage`: Specifying `multi-storage` is necessary to use Multi-storage Transactions in ScalarDB.
Expand All @@ -141,8 +137,6 @@ For details, see [Multi-Storage Transactions](../../multi-storage-transactions.m

In this sample application, ScalarDB Cluster is running in standalone mode (`scalar.db.cluster.node.standalone_mode.enabled=true`).

Also, you need to set the license key (trial license or commercial license) for ScalarDB Cluster in the configuration file. For details, see [How to Configure a Product License Key](../../scalar-licensing/README.mdx).

## Client Configuration

[The client configuration](https://github.com/scalar-labs/scalardb-samples/blob/main/spring-data-multi-storage-transaction-sample/scalardb-sql.properties) is as follows:
Expand All @@ -168,10 +162,6 @@ Then, go to the directory with this sample by running the following command:
cd scalardb-samples/spring-data-multi-storage-transaction-sample
```

### Set the license key

Set the license key (trial license or commercial license) for the ScalarDB Clusters in the configuration file [`scalardb-cluster-node.properties`](https://github.com/scalar-labs/scalardb-samples/blob/main/spring-data-multi-storage-transaction-sample/scalardb-cluster-node.properties). For details, see [How to Configure a Product License Key](../../scalar-licensing/README.mdx).

### Start Cassandra, MySQL, and ScalarDB Cluster

To start Cassandra, MySQL, and ScalarDB Cluster, you need to run the following `docker-compose` command:
Expand Down
6 changes: 1 addition & 5 deletions versioned_docs/version-3.11/scalardb-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,7 @@ scalar.db.grpc.max_inbound_metadata_size=

## Further reading

Please see the following sample to learn ScalarDB Server further:

- [ScalarDB Server Sample](scalardb-samples/scalardb-server-sample/README.mdx)

Please also see the following documents to learn how to deploy ScalarDB Server:
Please see the following documents to learn how to deploy ScalarDB Server:

- [Deploy ScalarDB Server on AWS](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnEKS.mdx)
- [Deploy ScalarDB Server on Azure](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnAKS.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol

## Store & retrieve data

[`ElectronicMoney.java`](./getting-started-with-jdbc/src/main/java/sample/ElectronicMoney.java) is a simple electronic money application.
The following is a simple electronic money application.
(Be careful: it is simplified for ease of reading and far from practical and is certainly not production-ready.)

```java
Expand Down Expand Up @@ -184,7 +184,7 @@ public class ElectronicMoney {
```

Before you run the application, you need to specify your GitHub username and your personal access token to access our private Maven repository.
One of the ways to specify them is using environment variables as follows (See [build.gradle](./getting-started-with-jdbc/build.gradle)):
One of the ways to specify them is using environment variables as follows:

```console
export GPR_USERNAME=<your GitHub username>
Expand Down Expand Up @@ -225,6 +225,6 @@ These are just simple examples of how ScalarDB JDBC is used. For more informatio
* [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx)
* [ScalarDB JDBC Guide](jdbc-guide.mdx)
* [ScalarDB SQL Grammar](grammar.mdx)
* [ScalarDB SQL Command Line interface](command-line-interface.mdx)
* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
* [ScalarDB SQL Server](sql-server.mdx)
* [ScalarDB SQL Configurations](configurations.mdx)
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol

## Store & retrieve data

[`ElectronicMoney.java`](./getting-started-with-sql/src/main/java/sample/ElectronicMoney.java) is a simple electronic money application.
The following is a simple electronic money application.
(Be careful: it is simplified for ease of reading and far from practical and is certainly not production-ready.)

```java
Expand Down Expand Up @@ -172,7 +172,7 @@ public class ElectronicMoney {
```

Before you run the application, you need to specify your GitHub username and your personal access token to access our private Maven repository.
One of the ways to specify them is using environment variables as follows (See [build.gradle](./getting-started-with-sql/build.gradle)):
One of the ways to specify them is using environment variables as follows:

```console
export GPR_USERNAME=<your GitHub username>
Expand Down Expand Up @@ -213,6 +213,6 @@ These are just simple examples of how ScalarDB SQL is used. For more information
* [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx)
* [ScalarDB SQL API Guide](sql-api-guide.mdx)
* [ScalarDB SQL Grammar](grammar.mdx)
* [ScalarDB SQL Command Line interface](command-line-interface.mdx)
* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
* [ScalarDB SQL Server](sql-server.mdx)
* [ScalarDB SQL Configurations](configurations.mdx)
2 changes: 1 addition & 1 deletion versioned_docs/version-3.11/scalardb-sql/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ To add a dependency using Maven:
- [ScalarDB SQL API Guide](sql-api-guide.mdx)
- [ScalarDB JDBC Guide](jdbc-guide.mdx)
- [ScalarDB SQL Grammar](grammar.mdx)
- [ScalarDB SQL Command Line interface](command-line-interface.mdx)
- [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
- [ScalarDB SQL Server](sql-server.mdx)
- [ScalarDB SQL Configurations](configurations.mdx)
- [Guide of Spring Data JDBC for ScalarDB](spring-data-guide.mdx)
Expand Down