From 1ed8a94ddc073e289617239c11dc4edaf3f724f5 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Thu, 29 Aug 2024 06:00:37 +0000 Subject: [PATCH] AUTO: Sync Kubernetes docs to ScalarDL docs site repo --- .../scalar-kubernetes/AwsMarketplaceGuide.mdx | 499 +++++++++++------- .../AzureMarketplaceGuide.mdx | 155 ++++-- .../HowToUseContainerImages.mdx | 200 +++---- .../K8sLogCollectionGuide.mdx | 163 +++--- 4 files changed, 625 insertions(+), 392 deletions(-) diff --git a/docs/scalar-kubernetes/AwsMarketplaceGuide.mdx b/docs/scalar-kubernetes/AwsMarketplaceGuide.mdx index dbd05c72..6b9ad24f 100644 --- a/docs/scalar-kubernetes/AwsMarketplaceGuide.mdx +++ b/docs/scalar-kubernetes/AwsMarketplaceGuide.mdx @@ -1,21 +1,48 @@ # How to install Scalar products through AWS Marketplace +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Scalar products (ScalarDB, ScalarDL, and their tools) are available in the AWS Marketplace as container images. This guide explains how to install Scalar products through the AWS Marketplace. -Note that some Scalar products are available under commercial licenses, and the AWS Marketplace provides those products as pay-as-you-go pricing or a Bring Your Own License (BYOL) option. If you select pay-as-you-go pricing, AWS will charge you our product license fee based on your usage. If you select BYOL, please make sure you have the appropriate license for the product. +Note that some Scalar products are available under commercial licenses, and the AWS Marketplace provides those products as pay-as-you-go (PAYG) pricing or a Bring Your Own License (BYOL) option. If you select pay-as-you-go pricing, AWS will charge you our product license fee based on your usage. If you select BYOL, please make sure you have the appropriate license for the product. ## Subscribe to Scalar products from AWS Marketplace -1. Access to the AWS Marketplace. - * [ScalarDB Cluster Standard Edition (Pay-As-You-Go)](https://aws.amazon.com/marketplace/pp/prodview-jx6qxatkxuwm4) - * [ScalarDB Cluster Premium Edition (Pay-As-You-Go)](https://aws.amazon.com/marketplace/pp/prodview-djqw3zk6dwyk6) - * [ScalarDB Cluster (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-alcwrmw6v4cfy) - * [ScalarDL Ledger (Pay-As-You-Go)](https://aws.amazon.com/marketplace/pp/prodview-wttioaezp5j6e) - * [ScalarDL Auditor (Pay-As-You-Go)](https://aws.amazon.com/marketplace/pp/prodview-ke3yiw4mhriuu) - * [ScalarDL Ledger (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-3jdwfmqonx7a2) - * [ScalarDL Auditor (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-tj7svy75gu7m6) - * [Scalar Manager (Pay-As-You-Go)](https://aws.amazon.com/marketplace/pp/prodview-gfyn6ipmxf2hq) - * [[Deprecated] ScalarDB Server (BYOL)](https://aws.amazon.com/marketplace/pp/prodview-rzbuhxgvqf4d2) +1. Select your Scalar product to see the links to the AWS Marketplace. + + + + Select your edition of ScalarDB Enterprise. + + + | PAYG | BYOL | + |:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------| + | [ScalarDB Cluster](https://aws.amazon.com/marketplace/pp/prodview-jx6qxatkxuwm4) | [ScalarDB Cluster](https://aws.amazon.com/marketplace/pp/prodview-alcwrmw6v4cfy) | + + + | PAYG | BYOL | + |:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------| + | [ScalarDB Cluster](https://aws.amazon.com/marketplace/pp/prodview-djqw3zk6dwyk6) | [ScalarDB Cluster](https://aws.amazon.com/marketplace/pp/prodview-alcwrmw6v4cfy) | + + + + + | PAYG | BYOL | + |:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------| + | [ScalarDL Ledger](https://aws.amazon.com/marketplace/pp/prodview-wttioaezp5j6e) | [ScalarDL Ledger](https://aws.amazon.com/marketplace/pp/prodview-3jdwfmqonx7a2) | + + + | PAYG | BYOL | + |:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------| + | [ScalarDL Auditor](https://aws.amazon.com/marketplace/pp/prodview-ke3yiw4mhriuu) | [ScalarDL Auditor](https://aws.amazon.com/marketplace/pp/prodview-tj7svy75gu7m6) | + + + | PAYG | BYOL | + |:-------------------------------------------------------------------------------|:-------------------------------------------| + | [Scalar Manager](https://aws.amazon.com/marketplace/pp/prodview-gfyn6ipmxf2hq) | Scalar Manager doesn't have a BYOL option. | + + 1. Select **Continue to Subscribe**. @@ -56,10 +83,15 @@ By subscribing to Scalar products in the AWS Marketplace, you can pull the conta ``` 1. Update the custom values file of the Helm Chart for the Scalar product that you want to install. - You need to specify the private container registry (ECR) of the AWS Marketplace as the value for `[].image.repository` in the custom values file. You also need to specify the service account name that you created in the previous step as the value for `[].serviceAccount.serviceAccountName` and set `[].serviceAccount.automountServiceAccountToken` to `true`. + You need to specify the private container registry (ECR) of the AWS Marketplace as the value for `[].image.repository` in the custom values file. You also need to specify the service account name that you created in the previous step as the value for `[].serviceAccount.serviceAccountName` and set `[].serviceAccount.automountServiceAccountToken` to `true`. See the following examples based on the product you're using. + + + + Select your edition of ScalarDB Enterprise. + + + In the `scalardb-cluster-standard-custom-values.yaml` file: - * ScalarDB Cluster Examples - * ScalarDB Cluster Standard Edition (scalardb-cluster-standard-custom-values.yaml) ```yaml scalardbCluster: image: @@ -68,155 +100,231 @@ By subscribing to Scalar products in the AWS Marketplace, you can pull the conta serviceAccountName: "" automountServiceAccountToken: true ``` - * ScalarDB Cluster Premium Edition (scalardb-cluster-premium-custom-values.yaml) - ```yaml - scalardbCluster: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-payg-premium" - serviceAccount: - serviceAccountName: "" - automountServiceAccountToken: true - ``` - * ScalarDL Examples - * ScalarDL Ledger (scalardl-ledger-custom-values.yaml) - ```yaml - ledger: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-ledger-aws-payg" - serviceAccount: - serviceAccountName: "" - automountServiceAccountToken: true - ``` - * ScalarDL Auditor (scalardl-auditor-custom-values.yaml) + + + In the `scalardb-cluster-premium-custom-values.yaml` file: + ```yaml - auditor: + scalardbCluster: image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-auditor-aws-payg" + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-payg-premium" serviceAccount: serviceAccountName: "" automountServiceAccountToken: true ``` - * ScalarDL Schema Loader for Ledger (schema-loader-ledger-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger-aws-payg" - ``` - * ScalarDL Schema Loader for Auditor (schema-loader-auditor-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor-aws-payg" - ``` - * Scalar Manager Example - * Scalar Manager (scalar-manager-custom-values.yaml) + + + + +

ScalarDL Ledger

- ```yaml - api: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-manager-api-aws-payg" - web: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-manager-web-aws-payg" - serviceAccount: - serviceAccountName: "" - automountServiceAccountToken: true - ``` + In the `scalardl-ledger-custom-values.yaml` file: -1. Deploy Scalar products by using Helm Charts in conjunction with the above custom values files. - * ScalarDB Cluster Examples - * ScalarDB Cluster Standard Edition - ```console - helm install scalardb-cluster-standard scalar-labs/scalardb-cluster -f scalardb-cluster-standard-custom-values.yaml - ``` - * ScalarDB Cluster Premium Edition - ```console - helm install scalardb-cluster-premium scalar-labs/scalardb-cluster -f scalardb-cluster-premium-custom-values.yaml - ``` - * ScalarDL Examples - * ScalarDL Ledger - ```console - helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml - ``` - * ScalarDL Auditor - ```console - helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml - ``` - * ScalarDL Schema Loader (Ledger) + ```yaml + ledger: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-ledger-aws-payg" + serviceAccount: + serviceAccountName: "" + automountServiceAccountToken: true + ``` + +

ScalarDL Schema Loader for Ledger

+ + In the `schema-loader-ledger-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger-aws-payg" + ``` + + +

ScalarDL Auditor

+ + In the `scalardl-auditor-custom-values.yaml` file: + + ```yaml + auditor: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-auditor-aws-payg" + serviceAccount: + serviceAccountName: "" + automountServiceAccountToken: true + ``` + +

ScalarDL Schema Loader for Auditor

+ + In the `schema-loader-auditor-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor-aws-payg" + ``` + + + In the `scalar-manager-custom-values.yaml` file: + + ```yaml + api: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-manager-api-aws-payg" + web: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-manager-web-aws-payg" + serviceAccount: + serviceAccountName: "" + automountServiceAccountToken: true + ``` + + + +1. Deploy Scalar products by using Helm Charts in conjunction with the above custom values files. See the following examples based on the product you're using. + + + + Select your edition of ScalarDB Enterprise. + + ```console - helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml + helm install scalardb-cluster-standard scalar-labs/scalardb-cluster -f scalardb-cluster-standard-custom-values.yaml ``` - * ScalarDL Schema Loader (Auditor) + + ```console - helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml + helm install scalardb-cluster-premium scalar-labs/scalardb-cluster -f scalardb-cluster-premium-custom-values.yaml ``` - * Scalar Manager Example - * Scalar Manager + + + + +

ScalarDL Ledger

- ```console - helm install scalar-manager scalar-labs/scalar-manager -f ./scalar-manager-custom-values.yaml - ``` + ```console + helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml + ``` + +

ScalarDL Schema Loader for Ledger

+ + ```console + helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml + ``` + + +

ScalarDL Auditor

+ + ```console + helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml + ``` + +

ScalarDL Schema Loader for Auditor

+ + ```console + helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml + ``` + + + ```console + helm install scalar-manager scalar-labs/scalar-manager -f ./scalar-manager-custom-values.yaml + ``` + + ## **[BYOL]** Deploy containers on EKS (Amazon Elastic Kubernetes Service) from AWS Marketplace using Scalar Helm Charts By subscribing to Scalar products in the AWS Marketplace, you can pull the container images of Scalar products from the private container registry ([ECR](https://aws.amazon.com/ecr/)) of the AWS Marketplace. This section explains how to deploy Scalar products with the BYOL option in your [EKS](https://aws.amazon.com/eks/) cluster from the private container registry. 1. Update the custom values file of the Helm Chart for the Scalar product that you want to install. - You need to specify the private container registry (ECR) of AWS Marketplace as the value of `[].image.repository` in the custom values file. - * ScalarDB Cluster Examples - ```yaml - scalardbCluster: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-byol" - ``` - * ScalarDL Examples - * ScalarDL Ledger (scalardl-ledger-custom-values.yaml) - ```yaml - ledger: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" - ``` - * ScalarDL Auditor (scalardl-auditor-custom-values.yaml) - ```yaml - auditor: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-auditor" - ``` - * ScalarDL Schema Loader for Ledger (schema-loader-ledger-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger" - ``` - * ScalarDL Schema Loader for Auditor (schema-loader-auditor-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor" - ``` + You need to specify the private container registry (ECR) of AWS Marketplace as the value of `[].image.repository` in the custom values file. See the following examples based on the product you're using. -1. Deploy the Scalar products using the Helm Chart with the above custom values files. - * ScalarDB Cluster Examples - ```console - helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml - ``` - * ScalarDL Examples - * ScalarDL Ledger - ```console - helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml - ``` - * ScalarDL Auditor - ```console - helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml - ``` - * ScalarDL Schema Loader (Ledger) - ```console - helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml - ``` - * ScalarDL Schema Loader (Auditor) - ```console - helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml - ``` + + + ```yaml + scalardbCluster: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-byol" + ``` + + +

ScalarDL Ledger

+ + In the `scalardl-ledger-custom-values.yaml` file: + + ```yaml + ledger: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" + ``` + +

ScalarDL Schema Loader for Ledger

+ + In the `schema-loader-ledger-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger" + ``` + + +

ScalarDL Auditor

+ + In the `scalardl-auditor-custom-values.yaml` file: + + ```yaml + auditor: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-auditor" + ``` + +

ScalarDL Schema Loader for Auditor

+ + In the `schema-loader-auditor-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor" + ``` + + + +1. Deploy the Scalar products using the Helm Chart with the above custom values files. See the following examples based on the product you're using. See the following examples based on the product you're using. + + + + ```console + helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml + ``` + + +

ScalarDL Ledger

+ + ```console + helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml + ``` + +

ScalarDL Schema Loader for Ledger

+ + ```console + helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml + ``` + + +

ScalarDL Auditor

+ + ```console + helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml + ``` + +

ScalarDL Schema Loader for Auditor

+ + ```console + helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml + ``` + + ## **[BYOL]** Deploy containers on Kubernetes other than EKS from AWS Marketplace using Scalar Helm Charts @@ -234,48 +342,69 @@ By subscribing to Scalar products in the AWS Marketplace, you can pull the conta 1. Update the custom values file of the Helm Chart for the Scalar product that you want to install. You need to specify the private container registry (ECR) of AWS Marketplace as the value of `[].image.repository` in the custom values file. - Also, you need to specify the `reg-ecr-mp-secrets` as the value of `[].imagePullSecrets`. - * ScalarDB Cluster Examples - ```yaml - scalardbCluster: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-byol" - imagePullSecrets: - - name: "reg-ecr-mp-secrets" - ``` - * ScalarDL Examples - * ScalarDL Ledger (scalardl-ledger-custom-values.yaml) - ```yaml - ledger: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" - imagePullSecrets: - - name: "reg-ecr-mp-secrets" - ``` - * ScalarDL Auditor (scalardl-auditor-custom-values.yaml) - ```yaml - auditor: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-auditor" - imagePullSecrets: - - name: "reg-ecr-mp-secrets" - ``` - * ScalarDL Schema Loader for Ledger (schema-loader-ledger-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger" - imagePullSecrets: - - name: "reg-ecr-mp-secrets" - ``` - * ScalarDL Schema Loader for Auditor (schema-loader-auditor-custom-values.yaml) - ```yaml - schemaLoading: - image: - repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor" - imagePullSecrets: - - name: "reg-ecr-mp-secrets" - ``` + Also, you need to specify the `reg-ecr-mp-secrets` as the value of `[].imagePullSecrets`. See the following examples based on the product you're using. + + + + ```yaml + scalardbCluster: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-byol" + imagePullSecrets: + - name: "reg-ecr-mp-secrets" + ``` + + +

ScalarDL Ledger

+ + In the `scalardl-ledger-custom-values.yaml` file: + + ```yaml + ledger: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger" + imagePullSecrets: + - name: "reg-ecr-mp-secrets" + ``` + +

ScalarDL Schema Loader for Ledger

+ + In the `schema-loader-ledger-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-ledger" + imagePullSecrets: + - name: "reg-ecr-mp-secrets" + ``` + + +

ScalarDL Auditor

+ + In the `scalardl-auditor-custom-values.yaml` file: + + ```yaml + auditor: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-auditor" + imagePullSecrets: + - name: "reg-ecr-mp-secrets" + ``` + +

ScalarDL Schema Loader for Auditor

+ + In the `schema-loader-auditor-custom-values.yaml` file: + + ```yaml + schemaLoading: + image: + repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor" + imagePullSecrets: + - name: "reg-ecr-mp-secrets" + ``` + + 1. Deploy the Scalar products using the Helm Chart with the above custom values files. * Examples diff --git a/docs/scalar-kubernetes/AzureMarketplaceGuide.mdx b/docs/scalar-kubernetes/AzureMarketplaceGuide.mdx index bcf65044..44796627 100644 --- a/docs/scalar-kubernetes/AzureMarketplaceGuide.mdx +++ b/docs/scalar-kubernetes/AzureMarketplaceGuide.mdx @@ -1,6 +1,9 @@ # How to install Scalar products through Azure Marketplace -:::note +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::warning 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.mdx). @@ -12,9 +15,16 @@ Note that some Scalar products are licensed under commercial licenses, and the A ## Get Scalar products from Microsoft Azure Marketplace -1. Access to the Microsoft Azure Marketplace. - * [ScalarDB](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardb) - * [ScalarDL](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardl) +1. Select your Scalar product to see the links to the Microsoft Azure Marketplace. + + + + - [ScalarDB](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardb) + + + - [ScalarDL](https://azuremarketplace.microsoft.com/en/marketplace/apps/scalarinc.scalardl) + + 1. Select **Get It Now**. @@ -37,17 +47,22 @@ Note that **Company** is not required, but please enter it. 1. Repeat these steps as needed. You need several container images to run Scalar products on Kubernetes, but Azure Marketplace copies only one container image at a time. So, you need to subscribe to several software plans (repeat subscribe operation) as needed. - * Container images that you need are the following. - * ScalarDB - * ScalarDB Cluster (BYOL) - * [Deprecated] ScalarDB Server Default (2vCPU, 4GiB Memory) - * [Deprecated] ScalarDB GraphQL Server (optional) - * [Deprecated] ScalarDB SQL Server (optional) - * ScalarDL - * ScalarDL Ledger Default (2vCPU, 4GiB Memory) - * ScalarDL Auditor Default (2vCPU, 4GiB Memory) - * The **ScalarDL Auditor** is optional. If you use the **ScalarDL Auditor**, subscribe to it. - * ScalarDL Schema Loader + - Container images that you need are the following. Select your Scalar product to see details about the container images. + + + + - ScalarDB Cluster (BYOL) + - [Deprecated] ScalarDB Server Default (2vCPU, 4GiB Memory) + - [Deprecated] ScalarDB GraphQL Server (optional) + - [Deprecated] ScalarDB SQL Server (optional) + + + - ScalarDL Ledger Default (2vCPU, 4GiB Memory) + - ScalarDL Auditor Default (2vCPU, 4GiB Memory) + - **ScalarDL Auditor** is optional. If you use **ScalarDL Auditor**, subscribe to it. + - ScalarDL Schema Loader + + Now, you can pull the container images of the Scalar products from your private container registry. Please refer to the [Azure Container Registry documentation](https://docs.microsoft.com/en-us/azure/container-registry/) for more details about the Azure Container Registry. @@ -60,52 +75,79 @@ Please refer to the [Azure Container Registry documentation](https://docs.micros * CLI ([az aks create](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-create) command) Please specify `--attach-acr` flag with the name of your private container registry. Also, you can configure Azure Container Registry integration for existing AKS clusters using [az aks update](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-update) command with `--attach-acr` flag. Please refer to the [Azure Official Document](https://docs.microsoft.com/en-us/azure/aks/cluster-container-registry-integration) for more details. -1. Update the custom values file of the Helm Chart of a Scalar product you want to install. - You need to specify your private container registry as the value of `[].image.repository` in the custom values file. - * ScalarDB Cluster Examples - ```yaml - scalardbCluster: - image: - repository: "example.azurecr.io/scalarinc/scalardb-cluster-node-azure-byol" - ``` - * ScalarDL Examples - * ScalarDL Ledger (scalardl-ledger-custom-values.yaml) +1. Update the custom values file of the Helm Chart of a Scalar product you want to install. You need to specify your private container registry as the value of `[].image.repository` in the custom values file. See the following examples based on the product you're using. + + + + ```yaml + scalardbCluster: + image: + repository: "example.azurecr.io/scalarinc/scalardb-cluster-node-azure-byol" + ``` + + + Select the ScalarDL product you're using. + + + In the `scalardl-ledger-custom-values.yaml` file: + ```yaml ledger: image: repository: "example.azurecr.io/scalarinc/scalar-ledger" ``` - * ScalarDL Auditor (scalardl-auditor-custom-values.yaml) + + + In the `scalardl-auditor-custom-values.yaml` file: + ```yaml auditor: image: repository: "example.azurecr.io/scalarinc/scalar-auditor" ``` - * ScalarDL Schema Loader (schema-loader-custom-values.yaml) + + + In the `schema-loader-custom-values.yaml` file: + ```yaml schemaLoading: image: repository: "example.azurecr.io/scalarinc/scalardl-schema-loader" ``` + + + + -1. Deploy the Scalar product using the Helm Chart with the above custom values file. - * ScalarDB Cluster Examples +1. Deploy the Scalar product using the Helm Chart with the above custom values file. See the following examples based on the product you're using. + + + ```console helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml ``` - * ScalarDL Examples - * ScalarDL Ledger + + + Select the ScalarDL product you're using. + + ```console helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml ``` - * ScalarDL Auditor + + ```console helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml ``` - * ScalarDL Schema Loader + + ```console helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-custom-values.yaml ``` + + + + ## Deploy containers on Kubernetes other than AKS (Azure Kubernetes Service) from your private container registry using Scalar Helm Charts @@ -127,19 +169,26 @@ Please refer to the [Azure Container Registry documentation](https://docs.micros --docker-password= ``` -1. Update the custom values file of the Helm Chart of a Scalar product you want to install. - You need to specify your private container registry as the value of `[].image.repository` in the custom values file. - Also, you need to specify the `reg-acr-secrets` as the value of `[].imagePullSecrets`. - * ScalarDB Cluster Examples - ```yaml - scalardbCluster: - image: - repository: "example.azurecr.io/scalarinc/scalardb-cluster-node-azure-byol" - imagePullSecrets: - - name: "reg-acr-secrets" - ``` - * ScalarDL Examples - * ScalarDL Ledger (scalardl-ledger-custom-values.yaml) +1. Update the custom values file of the Helm Chart of a Scalar product you want to install. + You need to specify your private container registry as the value of `[].image.repository` in the custom values file. + Also, you need to specify the `reg-acr-secrets` as the value of `[].imagePullSecrets`. See the following examples based on the product you're using. + + + + ```yaml + scalardbCluster: + image: + repository: "example.azurecr.io/scalarinc/scalardb-cluster-node-azure-byol" + imagePullSecrets: + - name: "reg-acr-secrets" + ``` + + + Select the ScalarDL product you're using. + + + In the `scalardl-ledger-custom-values.yaml` file: + ```yaml ledger: image: @@ -147,7 +196,10 @@ Please refer to the [Azure Container Registry documentation](https://docs.micros imagePullSecrets: - name: "reg-acr-secrets" ``` - * ScalarDL Auditor (scalardl-auditor-custom-values.yaml) + + + In the `scalardl-auditor-custom-values.yaml` file: + ```yaml auditor: image: @@ -155,7 +207,10 @@ Please refer to the [Azure Container Registry documentation](https://docs.micros imagePullSecrets: - name: "reg-acr-secrets" ``` - * ScalarDL Schema Loader (schema-loader-custom-values.yaml) + + + In the `schema-loader-custom-values.yaml` file: + ```yaml schemaLoading: image: @@ -163,6 +218,10 @@ Please refer to the [Azure Container Registry documentation](https://docs.micros imagePullSecrets: - name: "reg-acr-secrets" ``` + + + + 1. Deploy the Scalar product using the Helm Chart with the above custom values file. * Examples diff --git a/docs/scalar-kubernetes/HowToUseContainerImages.mdx b/docs/scalar-kubernetes/HowToUseContainerImages.mdx index 998c2aad..5ff0c92b 100644 --- a/docs/scalar-kubernetes/HowToUseContainerImages.mdx +++ b/docs/scalar-kubernetes/HowToUseContainerImages.mdx @@ -1,5 +1,8 @@ # How to use the container images +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + 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 @@ -11,110 +14,117 @@ The public container images are available for the following products and version ## 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 - +You can pull the container image of each product from the public container repository. To pull a container image, select your Scalar product to see the link to the container image. + + + + + Select your edition of ScalarDB Enterprise. + + + https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-node-byol-standard + + + https://github.com/orgs/scalar-labs/packages/container/package/scalardb-cluster-node-byol-premium + + + + + https://github.com/orgs/scalar-labs/packages/container/package/scalardl-ledger-byol + + + 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. Select your Scalar product to see how to set `*.image.repository`. + + + + Select your edition of ScalarDB Enterprise. + + + ```yaml + scalardbCluster: + image: + repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-standard" + ``` + + + ```yaml + scalardbCluster: + image: + repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium" + ``` + + + + ```yaml - scalardbCluster: + ledger: image: - repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-standard" + repository: "ghcr.io/scalar-labs/scalardl-ledger-byol" ``` - - * Premium Edition - + + ```yaml - scalardbCluster: + auditor: image: - repository: "ghcr.io/scalar-labs/scalardb-cluster-node-byol-premium" + repository: "ghcr.io/scalar-labs/scalardl-auditor-byol" ``` - -* 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). +To run the container images, you must set `license key` and `certificate` in your `.properties` file. Select your Scalar product to see how to set `license key` and `certificate`. 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= - scalar.db.cluster.node.licensing.license_check_cert_pem= - ``` - -* ScalarDL Ledger - - ```properties - scalar.dl.licensing.license_key= - scalar.dl.licensing.license_check_cert_pem= - ``` - -* ScalarDL Auditor - - ```properties - scalar.dl.licensing.license_key= - scalar.dl.licensing.license_check_cert_pem= - ``` - -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= - scalar.db.cluster.node.licensing.license_check_cert_pem= - ``` - -* ScalarDL Ledger - - ```yaml - ledger: - ledgerProperties: | - scalar.dl.licensing.license_key= - scalar.dl.licensing.license_check_cert_pem= - ``` + + + ```properties + scalar.db.cluster.node.licensing.license_key= + scalar.db.cluster.node.licensing.license_check_cert_pem= + ``` + + + ```properties + scalar.dl.licensing.license_key= + scalar.dl.licensing.license_check_cert_pem= + ``` + + + ```properties + scalar.dl.licensing.license_key= + scalar.dl.licensing.license_check_cert_pem= + ``` + + -* ScalarDL Auditor +If you're using Scalar Helm Charts, you must set the properties in the custom values file for the product that you're using. Select your Scalar product to see how to set the properties in the custom values file. - ```yaml - auditor: - auditorProperties: | - scalar.dl.licensing.license_key= - scalar.dl.licensing.license_check_cert_pem= - ``` + + + ```yaml + scalardbCluster: + scalardbClusterNodeProperties: | + scalar.db.cluster.node.licensing.license_key= + scalar.db.cluster.node.licensing.license_check_cert_pem= + ``` + + + ```yaml + ledger: + ledgerProperties: | + scalar.dl.licensing.license_key= + scalar.dl.licensing.license_check_cert_pem= + ``` + + + ```yaml + auditor: + auditorProperties: | + scalar.dl.licensing.license_key= + scalar.dl.licensing.license_check_cert_pem= + ``` + + diff --git a/docs/scalar-kubernetes/K8sLogCollectionGuide.mdx b/docs/scalar-kubernetes/K8sLogCollectionGuide.mdx index 0b05553a..2f3c1778 100644 --- a/docs/scalar-kubernetes/K8sLogCollectionGuide.mdx +++ b/docs/scalar-kubernetes/K8sLogCollectionGuide.mdx @@ -1,5 +1,8 @@ # Collecting logs from Scalar products on a Kubernetes cluster +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + This document explains how to deploy Grafana Loki and Promtail on Kubernetes with Helm. After following this document, you can collect logs of Scalar products on your Kubernetes environment. If you use a managed Kubernetes cluster and you want to use the cloud service features for monitoring and logging, please refer to the following document. @@ -39,32 +42,48 @@ In the production environment, it is recommended to add labels to the worker nod * [EKS - Add a label to the worker node that is used for nodeAffinity](CreateEKSClusterForScalarProducts.mdx#add-a-label-to-the-worker-node-that-is-used-for-nodeaffinity) * [AKS - Add a label to the worker node that is used for nodeAffinity](CreateAKSClusterForScalarProducts.mdx#add-a-label-to-the-worker-node-that-is-used-for-nodeaffinity) -Since the promtail pods deployed in this document collect only Scalar product logs, it is sufficient to deploy promtail pods only on the worker node where Scalar products are running. So, you should set nodeSelector in the custom values file (scalar-loki-stack-custom-values.yaml) as follows if you add labels to your Kubernetes worker node. - -* ScalarDB Cluster Example - ```yaml - promtail: - nodeSelector: - scalar-labs.com/dedicated-node: scalardb-cluster - ``` -* (Deprecated) ScalarDB Server Example - ```yaml - promtail: - nodeSelector: - scalar-labs.com/dedicated-node: scalardb - ``` -* ScalarDL Ledger Example - ```yaml - promtail: - nodeSelector: - scalar-labs.com/dedicated-node: scalardl-ledger - ``` -* ScalarDL Auditor Example - ```yaml - promtail: - nodeSelector: - scalar-labs.com/dedicated-node: scalardl-auditor - ``` +Since the promtail pods deployed in this document collect only Scalar product logs, it is sufficient to deploy promtail pods only on the worker node where Scalar products are running. So, you should set nodeSelector in the custom values file (scalar-loki-stack-custom-values.yaml) as follows if you add labels to your Kubernetes worker node. See the following examples based on the product you're using. + + + + Select the ScalarDB product you're using. + + + ```yaml + promtail: + nodeSelector: + scalar-labs.com/dedicated-node: scalardb-cluster + ``` + + + ```yaml + promtail: + nodeSelector: + scalar-labs.com/dedicated-node: scalardb + ``` + + + + + Select the ScalarDL product you're using. + + + ```yaml + promtail: + nodeSelector: + scalar-labs.com/dedicated-node: scalardl-ledger + ``` + + + ```yaml + promtail: + nodeSelector: + scalar-labs.com/dedicated-node: scalardl-auditor + ``` + + + + ### Set tolerations in the custom values file (Recommended in the production environment) @@ -73,44 +92,60 @@ In the production environment, it is recommended to add taints to the worker nod * [EKS - Add taint to the worker node that is used for toleration](CreateEKSClusterForScalarProducts.mdx#add-taint-to-the-worker-node-that-is-used-for-toleration) * [AKS - Add taint to the worker node that is used for toleration](CreateAKSClusterForScalarProducts.mdx#add-taint-to-the-worker-node-that-is-used-for-toleration) -Since promtail pods are deployed as DaemonSet, you must set tolerations in the custom values file (scalar-loki-stack-custom-values.yaml) as follows if you add taints to your Kubernetes worker node. - -* ScalarDB Cluster Example - ```yaml - promtail: - tolerations: - - effect: NoSchedule - key: scalar-labs.com/dedicated-node - operator: Equal - value: scalardb-cluster - ``` -* (Deprecated) ScalarDB Server Example - ```yaml - promtail: - tolerations: - - effect: NoSchedule - key: scalar-labs.com/dedicated-node - operator: Equal - value: scalardb - ``` -* ScalarDL Ledger Example - ```yaml - promtail: - tolerations: - - effect: NoSchedule - key: scalar-labs.com/dedicated-node - operator: Equal - value: scalardl-ledger - ``` -* ScalarDL Auditor Example - ```yaml - promtail: - tolerations: - - effect: NoSchedule - key: scalar-labs.com/dedicated-node - operator: Equal - value: scalardl-auditor - ``` +Since promtail pods are deployed as DaemonSet, you must set tolerations in the custom values file (scalar-loki-stack-custom-values.yaml) as follows if you add taints to your Kubernetes worker node. See the following examples based on the product you're using. + + + + Select the ScalarDB product you're using. + + + ```yaml + promtail: + tolerations: + - effect: NoSchedule + key: scalar-labs.com/dedicated-node + operator: Equal + value: scalardb-cluster + ``` + + + ```yaml + promtail: + tolerations: + - effect: NoSchedule + key: scalar-labs.com/dedicated-node + operator: Equal + value: scalardb + ``` + + + + + Select the ScalarDL product you're using. + + + ```yaml + promtail: + tolerations: + - effect: NoSchedule + key: scalar-labs.com/dedicated-node + operator: Equal + value: scalardl-ledger + ``` + + + ```yaml + promtail: + tolerations: + - effect: NoSchedule + key: scalar-labs.com/dedicated-node + operator: Equal + value: scalardl-auditor + ``` + + + + ## Deploy Loki and Promtail