Skip to content

Commit

Permalink
AUTO: Sync Kubernetes docs to ScalarDB Enterprise docs site repo
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed Apr 9, 2024
1 parent 2413564 commit deb02ce
Show file tree
Hide file tree
Showing 6 changed files with 160 additions and 5 deletions.
8 changes: 8 additions & 0 deletions docs/latest/scalar-kubernetes/AzureMarketplaceGuide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
{% capture notice-2 %}
**Note**

Scalar products are currently not available in Azure Marketplace. For details on other ways to get the container images of Scalar products, please see [How to get the container images of Scalar products](./HowToGetContainerImages.md).
{% endcapture %}

<div class="notice--info">{{ notice-2 | markdownify }}</div>

# How to install Scalar products through Azure Marketplace

Scalar products (ScalarDB, ScalarDL, and their tools) are provided in Azure Marketplace as container offers. This guide explains how to install Scalar products through Azure Marketplace.
Expand Down
27 changes: 27 additions & 0 deletions docs/latest/scalar-kubernetes/HowToGetContainerImages.md
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 docs/latest/scalar-kubernetes/HowToUseContainerImages.md
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>
```
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Deploy ScalarDB Server on Azure Kubernetes Service (AKS)
# [Deprecated] Deploy ScalarDB Server on Azure Kubernetes Service (AKS)

This guide explains how to deploy ScalarDB Server on Azure Kubernetes Service (AKS).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ In this guide, you will create one of the following three environments in your A

**Note:** This guide follows the second recommended way, "Use different VNets."

## Step 1. Subscribe to ScalarDL Ledger and ScalarDL Auditor in Azure Marketplace
## Step 1. Get the ScalarDL Ledger and ScalarDL Auditor container images

You must get the ScalarDL Ledger and ScalarDL Auditor container images by visiting [Azure Marketplace](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardl) and subscribing to ScalarDL Ledger and ScalarDL Auditor. For details on how to subscribe to ScalarDL Ledger and ScalarDL Auditor in Azure Marketplace, see [Get Scalar products from Microsoft Azure Marketplace](AzureMarketplaceGuide.md#get-scalar-products-from-microsoft-azure-marketplace).
You must get the ScalarDL Ledger and ScalarDL Auditor container images. For details, see [How to get the container images of Scalar products](../scalar-kubernetes/HowToGetContainerImages.md).

## Step 2. Create an AKS cluster for ScalarDL Ledger

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ In this guide, you will create the following environment in your Azure environme

![image](images/png/AKS_ScalarDL_Ledger.drawio.png)

## Step 1. Subscribe to ScalarDL Ledger in Azure Marketplace
## Step 1. Get the ScalarDL Ledger container image

You must get the ScalarDL Ledger container image from [Azure Marketplace](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardl) and subscribe to ScalarDL. For details on how to subscribe to ScalarDL Ledger in Azure Marketplace, see [Get Scalar products from Microsoft Azure Marketplace](AzureMarketplaceGuide.md#get-scalar-products-from-microsoft-azure-marketplace).
You must get the ScalarDL Ledger container image. For details, see [How to get the container images of Scalar products](../scalar-kubernetes/HowToGetContainerImages.md).

## Step 2. Create an AKS cluster

Expand Down

0 comments on commit deb02ce

Please sign in to comment.