Skip to content

Latest commit

 

History

History
271 lines (240 loc) · 13.5 KB

AwsMarketplaceGuide.md

File metadata and controls

271 lines (240 loc) · 13.5 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 AWS Marketplace

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.

Subscribe to Scalar products from AWS Marketplace

  1. Access to the AWS Marketplace.

  2. Select Continue to Subscribe.

  3. Sign in to AWS Marketplace using your IAM user.
    If you have already signed in, this step will be skipped automatically.

  4. Read the Terms and Conditions and select Accept Terms.
    It takes some time. When it's done, you can see the current date in the Effective date column. Also, you can see our products on the Manage subscriptions page of AWS Console.

[Pay-As-You-Go] 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) of the AWS Marketplace. This section explains how to deploy Scalar products with pay-as-you-go pricing in your EKS cluster from the private container registry.

  1. Create an OIDC provider.

    You must create an identity and access management (IAM) OpenID Connect (OIDC) provider to run the AWS Marketplace Metering Service from ScalarDL pods.

    eksctl utils associate-iam-oidc-provider --region <REGION> --cluster <EKS_CLUSTER_NAME> --approve

    For details, see Creating an IAM OIDC provider for your cluster.

  2. Create a service account.

    To allow your pods to run the AWS Marketplace Metering Service, you can use IAM roles for service accounts.

    eksctl create iamserviceaccount \
    --name <SERVICE_ACCOUNT_NAME> \
    --namespace <NAMESPACE> \
    --region <REGION> \
    --cluster <EKS_CLUSTER_NAME> \
    --attach-policy-arn arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess \
    --approve \
    --override-existing-serviceaccounts

  3. Update the custom values file of the Helm Chart of a Scalar product 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.

    • ScalarDB Cluster Examples
      • ScalarDB Cluster Standard Edition (scalardb-cluster-standard-custom-values.yaml) 
        scalardbCluster:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-payg-standard"
  serviceAccount:
    serviceAccountName: "<SERVICE_ACCOUNT_NAME>"
    automountServiceAccountToken: true
      • ScalarDB Cluster Premium Edition (scalardb-cluster-premium-custom-values.yaml) 
        scalardbCluster:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardb-cluster-node-aws-payg-premium"
   serviceAccount:
     serviceAccountName: "<SERVICE_ACCOUNT_NAME>"
     automountServiceAccountToken: true
    • ScalarDL Examples
      • ScalarDL Ledger (scalardl-ledger-custom-values.yaml) 
        ledger:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-ledger-aws-payg"
  serviceAccount:
    serviceAccountName: "<SERVICE_ACCOUNT_NAME>"
    automountServiceAccountToken: true
      • ScalarDL Auditor (scalardl-auditor-custom-values.yaml) 
        auditor:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-auditor-aws-payg"
  serviceAccount:
    serviceAccountName: "<SERVICE_ACCOUNT_NAME>"
    automountServiceAccountToken: true
      • ScalarDL Schema Loader for Ledger (schema-loader-ledger-custom-values.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) 
        schemaLoading:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor-aws-payg"

  4. Deploy Scalar products by using Helm Charts in conjunction with the above custom values files.

    • ScalarDB Cluster Examples
      • ScalarDB Cluster Standard Edition 
        helm install scalardb-cluster-standard scalar-labs/scalardb-cluster -f scalardb-cluster-standard-custom-values.yaml
      • ScalarDB Cluster Premium Edition 
        helm install scalardb-cluster-premium scalar-labs/scalardb-cluster -f scalardb-cluster-premium-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 (Ledger) 
        helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml
      • ScalarDL Schema Loader (Auditor) 
        helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-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) of the AWS Marketplace. This section explains how to deploy Scalar products with the BYOL option in your EKS cluster from the private container registry.

  1. Update the custom values file of the Helm Chart of a Scalar product 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 
      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) 
        ledger:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalar-ledger"
      • ScalarDL Auditor (scalardl-auditor-custom-values.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) 
        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) 
        schemaLoading:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor"

  2. Deploy the Scalar products using the Helm Chart with the above custom values files.

    • 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 (Ledger) 
        helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml
      • ScalarDL Schema Loader (Auditor) 
        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

  1. Install the aws command according to the AWS Official Document (Installing or updating the latest version of the AWS CLI).

  2. Configure the AWS CLI with your credentials according to the AWS Official Document (Configuration basics).

  3. Create a reg-ecr-mp-secrets secret resource for pulling the container images from the ECR of AWS Marketplace.

    kubectl create secret docker-registry reg-ecr-mp-secrets \
  --docker-server=709825985650.dkr.ecr.us-east-1.amazonaws.com \
  --docker-username=AWS \
  --docker-password=$(aws ecr get-login-password --region us-east-1)

  4. Update the custom values file of the Helm Chart of a Scalar product 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 
      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) 
        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) 
        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) 
        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) 
        schemaLoading:
  image:
    repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor"
  imagePullSecrets:
    - name: "reg-ecr-mp-secrets"

  5. Deploy the Scalar products using the Helm Chart with the above custom values files.

    • Examples
      Please refer to the [BYOL] Deploy containers on EKS (Amazon Elastic Kubernetes Service) from AWS Marketplace using Scalar Helm Charts section of this document.