Skip to content

Commit f5b0bb3

Browse files
AUTO: Sync ScalarDB docs in English to docs site repo (#1732)
Co-authored-by: josh-wong <[email protected]>
1 parent c30b655 commit f5b0bb3

File tree

2 files changed

+17
-23
lines changed

2 files changed

+17
-23
lines changed

versioned_docs/version-3.16/scalardb-analytics/deploy-scalardb-analytics-server.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import HelmCommandUsage from '/src/components/en-us/_helm-command-usage.mdx';
1313

1414
This document explains how to deploy a ScalarDB Analytics server in your local or production environment.
1515

16-
## Step 1. Decide on the billing method for ScalarDB Analytics
16+
## Step 1. Select a billing plan for ScalarDB Analytics
1717

1818
You can get the ScalarDB Analytics server in several ways:
1919

20-
<Tabs groupId="billing-method" queryString>
20+
<Tabs groupId="billing-plan" queryString>
2121
<TabItem value="pay-as-you-go" label="Pay as you go" default>
2222
You can use ScalarDB Analytics in a pay-as-you-go plan. In this case, you will pay the license fee based on your query usage.
2323
<Tabs groupId="cloud" queryString>
@@ -46,11 +46,11 @@ After subscribing, you'll have permission to pull the container image of the Sca
4646
</TabItem>
4747
</Tabs>
4848
</TabItem>
49-
<TabItem value="fixed-price-byil" label="Fixed price (bring your own license)">
50-
You can use ScalarDB Analytics in a fixed-price method. In this case, you will pay the fixed license fee based on your contract, with an upper limit on the queries you can run.
49+
<TabItem value="fixed-price-byol" label="Fixed price (bring your own license)">
50+
You can use ScalarDB Analytics at a fixed price. In this case, you will pay the fixed license fee based on your contract, with an upper limit on the queries you can run.
5151
<Tabs groupId="cloud" queryString>
5252
<TabItem value="any-supported-kubernetes" label="Any supported Kubernetes platform" default>
53-
You can use ScalarDB Analytics in the fixed-price method on any supported Kubernetes platforms. You can see the supported Kubernetes platforms in [Requirements](../requirements.mdx#kubernetes).
53+
You can use ScalarDB Analytics at a fixed price on any supported Kubernetes platforms. You can see the supported Kubernetes platforms in [Requirements](../requirements.mdx#kubernetes).
5454
<Tabs groupId="offering" queryString>
5555
<TabItem value="container" label="Container offer" default>
5656
<WarningLicenseKeyContact product="ScalarDB Analytics server" />
@@ -76,10 +76,10 @@ You will specify this container registry in a later step, so keep note of it.
7676

7777
Deploy a cluster on your preferred Kubernetes platform based on the following requirements and checkpoints:
7878

79-
1. Decide which Kubernetes platform to use based on the billing method and purpose.
79+
1. Decide which Kubernetes platform to use based on the billing plan and purpose.
8080

81-
- If you chose **Pay as you go (container offer - AWS Marketplace)** in [Step 1. Decide on the billing method for ScalarDB Analytics](#step-1-decide-on-the-billing-method-for-scalardb-analytics), you need to deploy Amazon Elastic Kubernetes Service (EKS) in the supported regions. The supported regions will be referred to in a later step.
82-
- If you chose **Fixed price w/bring your own license (container offer - any supported Kubernetes platform)** in [Step 1. Decide on the billing method for ScalarDB Analytics](#step-1-decide-on-the-billing-method-for-scalardb-analytics), you can use any of the supported Kubernetes platforms.
81+
- If you chose **Pay as you go (container offer - AWS Marketplace)** in [Step 1. Select a billing plan for ScalarDB Analytics](#step-1-select-a-billing-plan-for-scalardb-analytics), you need to deploy Amazon Elastic Kubernetes Service (EKS) in the supported regions. The supported regions will be referred to in a later step.
82+
- If you chose **Fixed price w/bring your own license (container offer - any supported Kubernetes platform)** in [Step 1. Select a billing plan for ScalarDB Analytics](#step-1-select-a-billing-plan-for-scalardb-analytics), you can use any of the supported Kubernetes platforms.
8383

8484
:::note
8585

@@ -109,7 +109,7 @@ Deploy a cluster on your preferred Kubernetes platform based on the following re
109109
<Tabs groupId="kubernetes" queryString>
110110
<TabItem value="eks" label="EKS" default>
111111
- If you chose **Fixed price w/ bring your own license (container offer - any supported Kubernetes platform)**, you can use Amazon Elastic Kubernetes Service (EKS).
112-
- If you chose **Pay as you go (container offer - AWS Marketplace)** in [Step 1. Decide on the billing method for ScalarDB Analytics](#step-1-decide-on-the-billing-method-for-scalardb-analytics), you need to do the following:
112+
- If you chose **Pay as you go (container offer - AWS Marketplace)** in [Step 1. Select a billing plan for ScalarDB Analytics](#step-1-select-a-billing-plan-for-scalardb-analytics), you need to do the following:
113113
1. Deploy EKS in supported regions that are described in the AWS documentation [MeterUsage Region support for Amazon ECS and Amazon EKS](https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#meterusage-region-support-ecs-eks).
114114
1. Run the following two commands after you deploy EKS:
115115
- `eksctl utils associate-iam-oidc-provider`
@@ -226,9 +226,9 @@ Create your custom values file `scalardb-analytics-server.yaml` based on your en
226226

227227
1. Set the container image and the license configurations
228228

229-
Based on the billing method you chose in [Step 1. Decide on the billing method for ScalarDB Analytics](#step-1-decide-on-the-billing-method-for-scalardb-analytics), set the container image configuration to `scalarDbAnalyticsServer.image.repository`. Select one of the following billing methods to see an example of this configuration.
229+
Based on the billing plan you chose in [Step 1. Select a billing plan for ScalarDB Analytics](#step-1-select-a-billing-plan-for-scalardb-analytics), set the container image configuration to `scalarDbAnalyticsServer.image.repository`. Select one of the following billing plans to see an example of this configuration.
230230

231-
<Tabs groupId="billing-method" queryString>
231+
<Tabs groupId="billing-plan" queryString>
232232
<TabItem value="payg-container-offer-aws-marketplace" label="Pay as you go (container offer - AWS Marketplace)" default>
233233
```yaml
234234
scalarDbAnalyticsServer:
@@ -251,9 +251,9 @@ Create your custom values file `scalardb-analytics-server.yaml` based on your en
251251
252252
1. Set the service account configurations
253253
254-
Based on the billing method you chose in [Step 1. Decide on the billing method for ScalarDB Analytics](#step-1-decide-on-the-billing-method-for-scalardb-analytics), set the service account configurations to `scalarDbAnalyticsServer.serviceAccount`. Select one of the following billing methods to see an example of this configuration.
254+
Based on the billing plan you chose in [Step 1. Select a billing plan for ScalarDB Analytics](#step-1-select-a-billing-plan-for-scalardb-analytics), set the service account configurations to `scalarDbAnalyticsServer.serviceAccount`. Select one of the following billing plans to see an example of this configuration.
255255

256-
<Tabs groupId="billing-method" queryString>
256+
<Tabs groupId="billing-plan" queryString>
257257
<TabItem value="payg-container-offer-aws-marketplace" label="Pay as you go (container offer - AWS Marketplace)" default>
258258
```yaml
259259
scalarDbAnalyticsServer:

versioned_docs/version-3.16/scalardb-cluster/scalardb-cluster-configurations.mdx

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,29 +1210,23 @@ For details about how to configure Spring Data JDBC for ScalarDB, see [Configura
12101210
- **Description:** Maximum size of metadata allowed to be received.
12111211
- **Default value:** The gRPC default value
12121212

1213-
#### Authentication and authorization configurations
1213+
### Authentication and authorization configurations
12141214

12151215
The following shows the authentication and authorization configurations for the ScalarDB Cluster client.
12161216

1217-
##### `auth.enabled`
1217+
#### `auth.enabled`
12181218

12191219
- **Field:** `scalar.db.cluster.auth.enabled`
12201220
- **Description:** Whether authentication and authorization are enabled.
12211221
- **Default value:** `false`
12221222

1223-
:::warning
1224-
1225-
If you enable authentication and authorization, you will also need to set [`scalar.db.cross_partition_scan.enabled`](#cross-partition-scan-configurations) to `true` for the system namespace (`scalardb` by default). This is because the ABAC feature performs cross-partition scans internally.
1226-
1227-
:::
1228-
1229-
##### `auth.username`
1223+
#### `auth.username`
12301224

12311225
- **Field:** `scalar.db.sql.cluster_mode.username`
12321226
- **Description:** The username of the client.
12331227
- **Default value:** empty
12341228

1235-
##### `auth.password`
1229+
#### `auth.password`
12361230

12371231
- **Field:** `scalar.db.sql.cluster_mode.password`
12381232
- **Description:** The password of the client.

0 commit comments

Comments
 (0)