-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AUTO: Sync Kubernetes docs to ScalarDB Enterprise docs site repo
- Loading branch information
Showing
6 changed files
with
160 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# How to get the container images of Scalar products | ||
|
||
You can get the container images of Scalar products in several ways. Please choose one of the following methods. | ||
|
||
<div id="tabset-1"> | ||
<div class="tab"> | ||
<button class="tablinks" onclick="openTab(event, 'Container_images', 'tabset-1')" id="defaultOpen-1">Container images</button> | ||
<button class="tablinks" onclick="openTab(event, 'AWS_Marketplace', 'tabset-1')">AWS Marketplace</button> | ||
<button class="tablinks" onclick="openTab(event, 'Azure_Marketplace', 'tabset-1')">Azure Marketplace</button> | ||
</div> | ||
|
||
<div id="Container_images" class="tabcontent" markdown="1"> | ||
|
||
You can get the container images from the public container repository if you have a commercial license. For more details on how to use container images, see [How to use the container images](./HowToUseContainerImages.md). | ||
|
||
</div> | ||
<div id="AWS_Marketplace" class="tabcontent" markdown="1"> | ||
|
||
For details on how to get Scalar products from AWS Marketplace, see [How to install Scalar products through AWS Marketplace](./AwsMarketplaceGuide.md). | ||
|
||
</div> | ||
<div id="Azure_Marketplace" class="tabcontent" markdown="1"> | ||
|
||
Scalar products are currently not available in Azure Marketplace. Please get the container images from one of the other methods. | ||
|
||
</div> | ||
</div> |
120 changes: 120 additions & 0 deletions
120
docs/latest/scalar-kubernetes/HowToUseContainerImages.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
# How to use the container images | ||
|
||
You can pull the container images from the public container repository. You must configure the license key and the certificate in your `.properties` file if you use the container images. | ||
|
||
## Prerequisites | ||
|
||
The public container images are available for the following products and versions: | ||
|
||
* ScalarDB Cluster v3.12 or later | ||
* ScalarDL v3.9 or later | ||
|
||
## Pull the container images from the public container repository | ||
|
||
You can pull the container image of each product from the public container repository. | ||
|
||
* ScalarDB Cluster | ||
* Standard Edition | ||
|
||
https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-node-byol-standard | ||
|
||
* Premium Edition | ||
|
||
https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-node-byol-premium | ||
|
||
* ScalarDL Ledger | ||
|
||
https://github.com/orgs/scalar-labs/packages/container/package/scalardl-ledger-byol | ||
|
||
* ScalarDL Auditor | ||
|
||
https://github.com/orgs/scalar-labs/packages/container/package/scalardl-auditor-byol | ||
|
||
If you're using Scalar Helm Charts, you must set `*.image.repository` in the custom values file for the product that you're using as follows: | ||
|
||
* ScalarDB Cluster | ||
* Standard Edition | ||
|
||
```yaml | ||
scalardbCluster: | ||
image: | ||
repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-standard" | ||
``` | ||
* Premium Edition | ||
```yaml | ||
scalardbCluster: | ||
image: | ||
repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium" | ||
``` | ||
* ScalarDL Ledger | ||
```yaml | ||
ledger: | ||
image: | ||
repository: "ghcr.io/scalar-labs/scalardl-ledger-byol" | ||
``` | ||
* ScalarDL Auditor | ||
```yaml | ||
auditor: | ||
image: | ||
repository: "ghcr.io/scalar-labs/scalardl-auditor-byol" | ||
``` | ||
## Set the license key in the `.properties` file | ||
|
||
To run the container images, you must set `license key` and `certificate` in your `.properties` file. If you don't have a license key, please [contact us](https://www.scalar-labs.com/contact). | ||
|
||
* ScalarDB Clsuter | ||
|
||
```properties | ||
scalar.db.cluster.node.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.db.cluster.node.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` | ||
|
||
* ScalarDL Ledger | ||
|
||
```properties | ||
scalar.dl.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.dl.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` | ||
|
||
* ScalarDL Auditor | ||
|
||
```properties | ||
scalar.dl.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.dl.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` | ||
|
||
If you're using Scalar Helm Charts, you must set the properties in the custom values file for the product that you're using as follows: | ||
|
||
* ScalarDB Cluster | ||
|
||
```yaml | ||
scalardbCluster: | ||
scalardbClusterNodeProperties: | | ||
scalar.db.cluster.node.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.db.cluster.node.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` | ||
|
||
* ScalarDL Ledger | ||
|
||
```yaml | ||
ledger: | ||
ledgerProperties: | | ||
scalar.dl.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.dl.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` | ||
|
||
* ScalarDL Auditor | ||
|
||
```yaml | ||
auditor: | ||
auditorProperties: | | ||
scalar.dl.licensing.license_key=<YOUR_LICENSE_KEY> | ||
scalar.dl.licensing.license_check_cert_pem=<CERT_PEM_FOR_LICENSE_KEY> | ||
``` |
2 changes: 1 addition & 1 deletion
2
docs/latest/scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnAKS.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters