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.
- Some Scalar products are available under commercial licenses, and the AWS Marketplace provides those products as pay-as-you-go (PAYG) pricing. When you use pay-as-you-go pricing, AWS will charge you the Scalar product license fee based on your usage.
- Previously, a bring-your-own-license (BYOL) option was offered in the AWS Marketplace. However, that option has been deprecated and removed, so it is no longer supported in the AWS Marketplace.
- A BYOL option is provided in the following public container repositories outside of the AWS Marketplace. If you don't have a license key, please contact us.
Subscribe to Scalar products from AWS Marketplace
- Select your Scalar product to see the links to the AWS Marketplace.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
- Scalar Manager
Select your edition of ScalarDB Enterprise.
- ScalarDB Enterprise Edition (Standard)
- ScalarDB Enterprise Edition (Premium)
PAYG | BYOL (Deprecated) |
---|---|
ScalarDB Cluster | ScalarDB Cluster |
PAYG | BYOL (Deprecated) |
---|---|
ScalarDB Cluster | ScalarDB Cluster |
PAYG | BYOL (Deprecated) |
---|---|
ScalarDL Ledger | ScalarDL Ledger |
PAYG | BYOL (Deprecated) |
---|---|
ScalarDL Auditor | ScalarDL Auditor |
PAYG | BYOL |
---|---|
Scalar Manager | Scalar Manager doesn't have a BYOL option. |
-
Select Continue to Subscribe.
-
Sign in to AWS Marketplace using your IAM user. If you have already signed in, this step will be skipped automatically.
-
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.
-
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.
-
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 -
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
totrue
. See the following examples based on the product you're using.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
- Scalar Manager
Select your edition of ScalarDB Enterprise.
- ScalarDB Enterprise Edition (Standard)
- ScalarDB Enterprise Edition (Premium)
In the scalardb-cluster-standard-custom-values.yaml
file:
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
In the scalardb-cluster-premium-custom-values.yaml
file:
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 Ledger
In the scalardl-ledger-custom-values.yaml
file:
ledger:
image:
repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-ledger-aws-payg"
serviceAccount:
serviceAccountName: "<SERVICE_ACCOUNT_NAME>"
automountServiceAccountToken: true
ScalarDL Schema Loader for Ledger
In the schema-loader-ledger-custom-values.yaml
file:
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:
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 Auditor
In the schema-loader-auditor-custom-values.yaml
file:
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:
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: "<SERVICE_ACCOUNT_NAME>"
automountServiceAccountToken: true
- 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.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
- Scalar Manager
Select your edition of ScalarDB Enterprise.
- ScalarDB Enterprise Edition (Standard)
- ScalarDB Enterprise Edition (Premium)
helm install scalardb-cluster-standard scalar-labs/scalardb-cluster -f scalardb-cluster-standard-custom-values.yaml
helm install scalardb-cluster-premium scalar-labs/scalardb-cluster -f scalardb-cluster-premium-custom-values.yaml
ScalarDL Ledger
helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml
ScalarDL Schema Loader for Ledger
helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml
ScalarDL Auditor
helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml
ScalarDL Schema Loader for Auditor
helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml
helm install scalar-manager scalar-labs/scalar-manager -f ./scalar-manager-custom-values.yaml
[Deprecated] [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.
- 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. See the following examples based on the product you're using.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
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:
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:
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:
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:
schemaLoading:
image:
repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor"
- 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.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
helm install scalardb-cluster scalar-labs/scalardb-cluster -f scalardb-cluster-custom-values.yaml
ScalarDL Ledger
helm install scalardl-ledger scalar-labs/scalardl -f ./scalardl-ledger-custom-values.yaml
ScalarDL Schema Loader for Ledger
helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-ledger-custom-values.yaml
ScalarDL Auditor
helm install scalardl-auditor scalar-labs/scalardl-audit -f ./scalardl-auditor-custom-values.yaml
ScalarDL Schema Loader for Auditor
helm install schema-loader scalar-labs/schema-loading -f ./schema-loader-auditor-custom-values.yaml
[Deprecated] [BYOL] Deploy containers on Kubernetes other than EKS from AWS Marketplace using Scalar Helm Charts
-
Install the
aws
command according to the AWS Official Document (Installing or updating the latest version of the AWS CLI). -
Configure the AWS CLI with your credentials according to the AWS Official Document (Configuration basics).
-
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) -
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 thereg-ecr-mp-secrets
as the value of[].imagePullSecrets
. See the following examples based on the product you're using.
- ScalarDB Cluster
- ScalarDL Ledger
- ScalarDL Auditor
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:
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:
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:
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:
schemaLoading:
image:
repository: "709825985650.dkr.ecr.us-east-1.amazonaws.com/scalar/scalardl-schema-loader-auditor"
imagePullSecrets:
- name: "reg-ecr-mp-secrets"
- Deploy the Scalar products using the Helm Chart with the above custom values files.
- Examples Please refer to the [Deprecated] [BYOL] Deploy containers on EKS (Amazon Elastic Kubernetes Service) from AWS Marketplace using Scalar Helm Charts section of this document.