Skip to content

Commit ac83adb

Browse files
committed
AUTO: Sync ScalarDB docs in English to docs site repo
1 parent 5466951 commit ac83adb

File tree

9 files changed

+20
-60
lines changed

9 files changed

+20
-60
lines changed

versioned_docs/version-3.11/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart.mdx

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,7 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
9696
helm repo add scalar-labs https://scalar-labs.github.io/helm-charts
9797
```
9898

99-
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).
100-
101-
```console
102-
SCALAR_DB_CLUSTER_LICENSE_KEY='<YOUR_LICENSE_KEY>'
103-
SCALAR_DB_CLUSTER_LICENSE_CHECK_CERT_PEM='<CERT_PEM_FOR_YOUR_LICENSE_KEY>'
104-
```
105-
106-
3. Create a custom values file for ScalarDB Cluster (`scalardb-cluster-custom-values.yaml`):
99+
2. Create a custom values file for ScalarDB Cluster (`scalardb-cluster-custom-values.yaml`):
107100

108101
```console
109102
cat << 'EOF' > scalardb-cluster-custom-values.yaml
@@ -147,10 +140,10 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
147140
secretName: "scalardb-credentials-secret"
148141
EOF
149142
```
150-
143+
151144
For the tutorials, the service type for ScalarDB Cluster GraphQL and Envoy is set to `LoadBalancer`.
152145

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

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

165-
5. Set the chart version of ScalarDB Cluster.
158+
4. Set the chart version of ScalarDB Cluster.
166159

167160
```console
168161
SCALAR_DB_CLUSTER_VERSION=3.12.5
169162
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)
170163
```
171164

172-
6. Deploy ScalarDB Cluster.
165+
5. Deploy ScalarDB Cluster.
173166

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

178-
7. Check if the ScalarDB Cluster pods are deployed:
171+
6. Check if the ScalarDB Cluster pods are deployed:
179172

180173
```console
181174
kubectl get pod
182175
```
183-
176+
184177
Command execution result:
185-
178+
186179
```console
187180
NAME READY STATUS RESTARTS AGE
188181
postgresql-scalardb-cluster-0 1/1 Running 0 84s
@@ -193,17 +186,17 @@ You can deploy PostgreSQL on the Kubernetes cluster as follows:
193186
scalardb-cluster-node-866c756c79-9zhq5 1/1 Running 0 35s
194187
scalardb-cluster-node-866c756c79-t6v86 1/1 Running 0 35s
195188
```
196-
189+
197190
If the ScalarDB Cluster Node Pods and the Envoy Pods are deployed properly, the `STATUS` for each pod will be `Running`.
198191

199-
8. Check if the service resources of the ScalarDB Cluster are deployed:
192+
7. Check if the service resources of the ScalarDB Cluster are deployed:
200193

201194
```console
202195
kubectl get svc
203196
```
204-
197+
205198
Command execution result:
206-
199+
207200
```console
208201
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
209202
kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 260d

versioned_docs/version-3.11/scalardb-cluster/standalone-mode.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,6 @@ You can use the primary key or the secondary key in your Azure Cosmos DB account
212212
</TabItem>
213213
</Tabs>
214214

215-
### Set the license key
216-
217-
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).
218-
219215
### Start ScalarDB Cluster in standalone mode
220216

221217
To start ScalarDB Cluster in standalone mode, run the following command:

versioned_docs/version-3.11/scalardb-samples/README.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,5 @@ The following are sample applications for ScalarDB:
1212
- [Multi-storage Transaction Sample](multi-storage-transaction-sample/README.mdx)
1313
- [Microservice Transaction Sample](microservice-transaction-sample/README.mdx)
1414
- [ScalarDB Analytics with PostgreSQL](scalardb-analytics-postgresql-sample/README.mdx)
15-
- [ScalarDB Analytics with Spark](scalardb-analytics-spark-sample/README.mdx)
1615
- [Spring Data JDBC for ScalarDB with Multi-storage Transaction Sample](spring-data-multi-storage-transaction-sample/README.mdx)
1716
- [Spring Data JDBC for ScalarDB with Microservice Transaction Sample](spring-data-microservice-transaction-sample/README.mdx)

versioned_docs/version-3.11/scalardb-samples/spring-data-microservice-transaction-sample/README.mdx

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,6 @@ scalar.db.consensus_commit.isolation_level=SERIALIZABLE
107107

108108
scalar.db.cluster.node.standalone_mode.enabled=true
109109
scalar.db.sql.enabled=true
110-
111-
# License key configurations
112-
scalar.db.cluster.node.licensing.license_key=
113-
scalar.db.cluster.node.licensing.license_check_cert_pem=
114110
```
115111

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

137133
scalar.db.cluster.node.standalone_mode.enabled=true
138134
scalar.db.sql.enabled=true
139-
140-
# License key configurations
141-
scalar.db.cluster.node.licensing.license_key=
142-
scalar.db.cluster.node.licensing.license_check_cert_pem=
143135
```
144136

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

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

155-
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).
156-
157147
## Setup
158148

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

173-
### Set the license key
174-
175-
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).
176-
177163
### Start Cassandra, MySQL, and ScalarDB Clusters
178164

179165
To start Cassandra, MySQL, and ScalarDB Clusters, you need to run the following `docker-compose` command:

versioned_docs/version-3.11/scalardb-samples/spring-data-multi-storage-transaction-sample/README.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,6 @@ scalar.db.multi_storage.default_storage=cassandra
124124

125125
scalar.db.cluster.node.standalone_mode.enabled=true
126126
scalar.db.sql.enabled=true
127-
128-
# License key configurations
129-
scalar.db.cluster.node.licensing.license_key=
130-
scalar.db.cluster.node.licensing.license_check_cert_pem=
131127
```
132128

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

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

144-
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).
145-
146140
## Client Configuration
147141

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

171-
### Set the license key
172-
173-
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).
174-
175165
### Start Cassandra, MySQL, and ScalarDB Cluster
176166

177167
To start Cassandra, MySQL, and ScalarDB Cluster, you need to run the following `docker-compose` command:

versioned_docs/version-3.11/scalardb-server.mdx

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,7 @@ scalar.db.grpc.max_inbound_metadata_size=
162162

163163
## Further reading
164164

165-
Please see the following sample to learn ScalarDB Server further:
166-
167-
- [ScalarDB Server Sample](scalardb-samples/scalardb-server-sample/README.mdx)
168-
169-
Please also see the following documents to learn how to deploy ScalarDB Server:
165+
Please see the following documents to learn how to deploy ScalarDB Server:
170166

171167
- [Deploy ScalarDB Server on AWS](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnEKS.mdx)
172168
- [Deploy ScalarDB Server on Azure](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnAKS.mdx)

versioned_docs/version-3.11/scalardb-sql/getting-started-with-jdbc.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol
3636

3737
## Store & retrieve data
3838

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

4242
```java
@@ -184,7 +184,7 @@ public class ElectronicMoney {
184184
```
185185

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

189189
```console
190190
export GPR_USERNAME=<your GitHub username>
@@ -225,6 +225,6 @@ These are just simple examples of how ScalarDB JDBC is used. For more informatio
225225
* [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx)
226226
* [ScalarDB JDBC Guide](jdbc-guide.mdx)
227227
* [ScalarDB SQL Grammar](grammar.mdx)
228-
* [ScalarDB SQL Command Line interface](command-line-interface.mdx)
228+
* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
229229
* [ScalarDB SQL Server](sql-server.mdx)
230230
* [ScalarDB SQL Configurations](configurations.mdx)

versioned_docs/version-3.11/scalardb-sql/getting-started-with-sql.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol
3636

3737
## Store & retrieve data
3838

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

4242
```java
@@ -172,7 +172,7 @@ public class ElectronicMoney {
172172
```
173173

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

177177
```console
178178
export GPR_USERNAME=<your GitHub username>
@@ -213,6 +213,6 @@ These are just simple examples of how ScalarDB SQL is used. For more information
213213
* [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx)
214214
* [ScalarDB SQL API Guide](sql-api-guide.mdx)
215215
* [ScalarDB SQL Grammar](grammar.mdx)
216-
* [ScalarDB SQL Command Line interface](command-line-interface.mdx)
216+
* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
217217
* [ScalarDB SQL Server](sql-server.mdx)
218218
* [ScalarDB SQL Configurations](configurations.mdx)

versioned_docs/version-3.11/scalardb-sql/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ To add a dependency using Maven:
121121
- [ScalarDB SQL API Guide](sql-api-guide.mdx)
122122
- [ScalarDB JDBC Guide](jdbc-guide.mdx)
123123
- [ScalarDB SQL Grammar](grammar.mdx)
124-
- [ScalarDB SQL Command Line interface](command-line-interface.mdx)
124+
- [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli)
125125
- [ScalarDB SQL Server](sql-server.mdx)
126126
- [ScalarDB SQL Configurations](configurations.mdx)
127127
- [Guide of Spring Data JDBC for ScalarDB](spring-data-guide.mdx)

0 commit comments

Comments
 (0)