Pre-flight check

If you haven't subscribed to Sextant for DAML and installed it then go to Subscribing to Sextant for Daml below.

Step 1: Login to Sextant for Daml

Use a browser to login to your Sextant for DAML instance. Assuming that you using a persistent connection following these instructions, you can use the hostname and initial credentials obtained during the installation process.

Step 2: Add a Kubernetes cluster to Sextant for Daml

NOTE that if you've already added a Kubernetes cluster to Sextant you can skip this step and go straight to Step 3.

In order to get started you need to add your first cluster to Sextant. When you login you are directed to the Clusters page. Click Add+ and you will be presented with the following form.

There are comprehensive instructions that take you through the two step process to obtain the three key parameters needed to add your cluster to Sextant. * API Server URL * Access Token * Certificate Authority

NOTE these instructions assume that you are familiar with the Kubernetes CLI kubectl.

Once you have obtained these parameters all you need to do is name your cluster - in this case we have chosen the name sfd-demo-cluster - then click Submit and it will be available for deployments.

The four symbols to the right are Delete, Edit, View and Deployments.

Enabling Daml on AWS Services

If you intend to deploy DAML on QLDB or DAML on Aurora on your Kubernetes cluster you will need to enable it first by following these instructions.

NOTE that there is no issue with updating your Kubernetes cluster after it has been added to Sextant for DAML but you only need to do this once.

Step 3: Deploy Daml on X

Sextant for DAML currently supports four Daml on X options.

It is important to note that Sextant does not permit more than one deployment on any given cluster.

Deploy Daml on Besu network

NOTE these instructions assume you are using the cluster sfd-demo-cluster added above.

Click on the Deployments symbol and you will directed to the Deployments page for your cluster.

Click Add+ and you are prompted to select either DAML on Besu, DAML on Sawtooth, DAML on Aurora, or DAML on QLDB.

Select DAML on Besu and you will be presented with a form.

NOTE Full instructions to follow shortly.

Deploy Daml on Sawtooth network

NOTE these instructions assume you are using the cluster sfd-demo-cluster added above.

Click on the Deployments symbol and you will directed to the Deployments page for your cluster.

Click Add+ and you are prompted to select either DAML on Besu, DAML on Sawtooth, DAML on Aurora, or DAML on QLDB.

Select DAML on Sawtooth and you will be presented with a form. In this example the network name we have chosen is sfd-demo-network and the Kubernetes namespace is sfd-demo-namespace.

There is no need to change the defaults so simply scroll down and click Deploy and Sextant will deploy your DAML on Sawtooth network.

Select View and you can drill down on your deployment.

In order to create a gRPC session and interact with the Daml ledger you will need to follow these instructions.

Once you have done this you should see a new LoadBalancer service with an ExternalIP appear when you drill down on your deployment.

You can now to connect to your Daml ledger using this ExternalIP and port 39000. If you are unsure how to do this go to Connecting to your Daml ledger below.

NOTE that you also have the option to expose various underlying Sawtooth services by following these instructions.

Return to Daml on X options.

Deploy Daml on Amazon QLDB

NOTE these instructions assume that you are using a cluster sfd-aws-cluster capable of supporting Daml on AWS Services by following these instructions.

Go to the Clusters page and select this cluster.

Click on the Deployments symbol and you will be directed to the Deployments page for this cluster.

Click Add+ and once again you will be prompted to select DAML on Besu, DAML on Sawtooth, DAML on Aurora, or DAML on QLDB.

Select DAML on QLDB and you will be presented with a form similar to the DAML on Sawtooth form. In this example the network name and Kubernetes namespace are both named sfd-qldb-deployment. The Daml Ledger ID is named sfd-qldb-ledger-2020-03-25 and the defaults accepted.

Click Deploy and Sextant will deploy DAML on QLDB.

Select View on sfd-qldb-deployment and you can drill down on your deployment.

In order to create a gRPC session and interact with the Daml ledger you will need to follow these instructions.

Once you have done this you should see a new LoadBalancer service with an ExternalIP appear when you drill down on your deployment.

You can now to connect to your Daml ledger using this ExternalIP. If you are unsure how to do this go to Connecting to your Daml ledger below.

Return to Daml on X options.

Deploy Daml on Amazon Aurora

NOTE these instructions assume that you are using a cluster sfd-aws-cluster capable of supporting Daml on AWS Services by following these instructions.

Go to the Clusters page and select this cluster.

Click on the Deployments symbol and you will be directed to the Deployments page for this cluster.

Click Add+ and once again you will be prompted to select DAML on Besu, DAML on Sawtooth, DAML on Aurora, or DAML on QLDB.

Select DAML on Aurora and you will be presented with a form similar to the DAML on Sawtooth form. In this example the network name and Kubernetes namespace are both named sfd-aurora-deployment. The Daml Ledger ID is named sfd-aurora-ledger and the defaults accepted.

Click Deploy and Sextant will deploy DAML on Aurora and by default create a new Aurora RDS instance.

NOTE that if you opt for a new Aurora RDS instance then this could take up to 30 minutes.

Select View on sfd-aurora-deployment and you can drill down on your deployment.

In order to create a gRPC session and interact with the Daml ledger you will need to follow these instructions.

Once you have done this you should see a new LoadBalancer service with an ExternalIP appear when you drill down on your deployment.

You can now to connect to your Daml ledger using this ExternalIP. If you are unsure how to do this go to Connecting to your Daml ledger below.

Return to Daml on X options.

Connecting to your Daml ledger

Provided that you have added a NLB to your deployment you can connect to your Daml ledger using the daml Daml Assistant with ExternalIP as the host.

You can find additional information in the Daml documentation here but here are two examples.

  1. Deploying to your Daml ledger from within a project
daml deploy --host <ExternalIP> --port 39000
  1. Exploring your Daml ledger with the navigator
daml ledger navigator --host <ExternalIP> --port 39000

NOTE that it is also possible to explore the ledger using Sextant for DAML. Details to follow.

That's the end of our Sextant for DAML getting started guide. For further information or to speak to someone at BTP please contact us here.

Subscribing to Sextant for Daml

To subscribe to Sextant for Daml make sure you are logged in to your preferred AWS account then click on this link which will take you to the Sextant for Daml listing in the AWS Marketplace.

Once there you can step through the standard AWS Marketplace subscription process which primarily consists of reviewing and accepting our terms then installing an instance of Sextant for Daml by following our detailed instructions.

Note that these instructions assume that you are familiar with Kubernetes and that you have AWS sufficient privileges on your account.