Skip to content

Latest commit

 

History

History
172 lines (148 loc) · 8.62 KB

AzureMarketplaceGuide.md

File metadata and controls

172 lines (148 loc) · 8.62 KB
Raw

Caution

The contents of the docs folder have been moved to the docs-internal-orchestration repository. Please update this documentation in that repository instead.

To view the Scalar Kubernetes documentation, visit the documentation site for the product you are using:

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.

Note that some Scalar products are licensed under commercial licenses, and the Azure Marketplace provides them as BYOL (Bring Your Own License). Please make sure you have appropriate licenses.

Get Scalar products from Microsoft Azure Marketplace

  1. Access to the Microsoft Azure Marketplace.

  2. Select Get It Now.

  3. Sign in to Azure Marketplace using your work email address.
    Please use the work email address that is used as an account of Microsoft Azure.
    If you have already signed in, this step will be skipped automatically.

  4. Input your information.
    Note that Company is not required, but please enter it.

  5. Select a Software plan you need from the pull-down.
    Software plan means a combination of the container image and the license. Please select the Software plan you use.

  6. Select Continue.
    After selecting the Continue, it automatically moves to the Azure Portal.

  7. Create a private container registry (Azure Container Registry).
    Follow the on-screen instructions, please create your private container registry.
    The container images of Scalar products will be copied to your private container registry.

  8. 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

Now, you can pull the container images of the Scalar products from your private container registry. Please refer to the Azure Container Registry documentation for more details about the Azure Container Registry.

Deploy containers on AKS (Azure Kubernetes Service) from your private container registry using Scalar Helm Charts

  1. Specify your private container registry (Azure Container Registry) when you create an AKS cluster.

    • GUI (Azure Portal)
      At the Azure Container Registry parameter in the Integrations tab, please specify your private container registry.
    • CLI (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 command with --attach-acr flag. Please refer to the Azure Official Document for more details.

  2. 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 
      scalardbCluster:
  image:
    repository: "example.azurecr.io/scalarinc/scalardb-cluster-node-azure-byol"
    • ScalarDL Examples
      • ScalarDL Ledger (scalardl-ledger-custom-values.yaml) 
        ledger:
  image:
    repository: "example.azurecr.io/scalarinc/scalar-ledger"
      • ScalarDL Auditor (scalardl-auditor-custom-values.yaml) 
        auditor:
  image:
    repository: "example.azurecr.io/scalarinc/scalar-auditor"
      • ScalarDL Schema Loader (schema-loader-custom-values.yaml) 
        schemaLoading:
  image:
    repository: "example.azurecr.io/scalarinc/scalardl-schema-loader"

  3. Deploy the Scalar product using the Helm Chart with the above custom values file.

    • ScalarDB Cluster Examples 
      helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml
    • ScalarDL Examples
      • ScalarDL Ledger 
        helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml
      • ScalarDL Auditor 
        helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml
      • ScalarDL Schema Loader 
        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

  1. Install the az command according to the Azure Official Document (How to install the Azure CLI).

  2. Sign in with Azure CLI.

    az login

  3. Create a service principal for authentication to your private container registry according to the Azure Official Document (Azure Container Registry authentication with service principals).
    We use the Service principal ID and the Service principal password in the next step.

  4. Create a reg-acr-secrets secret resource for pulling the container images from your private container registry.

    kubectl create secret docker-registry reg-acr-secrets \
  --docker-server=<your private container registry login server> \
  --docker-username=<Service principal ID> \
  --docker-password=<Service principal password>

  5. 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 
      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) 
        ledger:
  image:
    repository: "example.azurecr.io/scalarinc/scalar-ledger"
  imagePullSecrets:
    - name: "reg-acr-secrets"
      • ScalarDL Auditor (scalardl-auditor-custom-values.yaml) 
        auditor:
  image:
    repository: "example.azurecr.io/scalarinc/scalar-auditor"
  imagePullSecrets:
    - name: "reg-acr-secrets"
      • ScalarDL Schema Loader (schema-loader-custom-values.yaml) 
        schemaLoading:
  image:
    repository: "example.azurecr.io/scalarinc/scalardl-schema-loader"
  imagePullSecrets:
    - name: "reg-acr-secrets"

  6. Deploy the Scalar product using the Helm Chart with the above custom values file.

    • Examples
      Please refer to the Deploy containers on AKS (Azure Kubernetes Service) from your private container registry using Scalar Helm Charts section of this document.