Install (Kubernetes)¶

Warning

Make sure to complete the Prerequisites before proceeding.

If you followed the 0.7.x docs, you will need to delete your old deployments before using the utilities helm charts. You do not have to migrate any data.

Helm Chart¶

We provide a helm chart to install the utilities:

helm upgrade --install --create-namespace -n cnu utilities -f values.yaml \
  oci://europe-docker.pkg.dev/da-images/public/charts/utilities:0.8.2

Typical example `values.yaml`¶

network:
  # this value differs between DevNet, TestNet, and MainNet;
  # make sure you are using the appropriate URL!
  operatorApiUrl: https://api.utilities.digitalasset-dev.com
  #operatorApiUrl: https://api.utilities.digitalasset-staging.com
  #operatorApiUrl: https://api.utilities.digitalasset.com

  # the below credentials are only used to upload dars
  oidc:
    issuerUri: <your validator issuer URI>
    audience: <your validator audience>
    clientId: <your validator client ID>
    clientSecret:
      name: splice-app-validator-ledger-api-auth
      key: client-secret
  participant:
    host: participant.<your-namespace>.svc.cluster.local
  validator:
    host: validator-app.<your-namespace>.svc.cluster.local

frontend:
  enabled: true # (you probably want the frontend)
  oidc:
    clientId: <frontend client ID (from prerequisites)>

ingressHosts:
  internal: <some-host>
  external: <some-host>

Ingress¶

To enable access to your UI, be sure to set up your Ingress.

If you want the Auto TopUp Application ¶

autoTopup:
  schedule: 0 0 * * *
  retry: 8
  issuerParty: "<your party literal>"
  commercial:
    enabled: true
    minThreshold: 934000
    maxBalance: 935000

Helm Values Reference¶

Auto topup¶

Key	Type	Default	Description
autoTopup.commercial.enabled	bool	`false`	Enable commercial topup
autoTopup.commercial.maxBalance	int	`935000`	Topup to this balance
autoTopup.commercial.minThreshold	int	`934000`	Minimum threshold when to topup
autoTopup.issuerParty	string	`""`	Issuer party to use when topping up
autoTopup.retry	int	`8`	Retry count when topup fails
autoTopup.schedule	string	`"0 0 * * *"`	Cron schedule for when to run the topup

Frontend¶

Key	Type	Default	Description
frontend.enabled	bool	`false`	Enable the frontend
frontend.oidc.audience	string	`"https://canton.network.global"`	Token audience
frontend.oidc.clientId	string	`""`	IDP client ID for callback
frontend.oidc.issuerUri	string	`""`	IDP issuer uri for callback

Ingress¶

Key	Type	Default	Description
ingressHosts.external	string	`""`	The hostname for the external routes
ingressHosts.internal	string	`""`	The hostname for the internal routes

Network¶

Key	Type	Default	Description
network.oidc.audience	string	`"https://canton.network.global"`	Token audience
network.oidc.clientId	string	`""`	Client ID for M2M access tokens
network.oidc.clientSecret.key	string	`""`	K8s secret key containing the client secret
network.oidc.clientSecret.name	string	`""`	K8s secret name containing the client secret
network.oidc.issuerUri	string	`""`	IDP’s issuer URI
network.oidc.scope	string	`"daml_ledger_api"`	Token scope
network.operatorApiUrl	string	`""`	Public endpoint for fetching the operator’s party literal and explicitly disclosed contracts
network.participant.host	string	`"participant"`	Hostname
network.participant.ports.admin	int	`5002`	Admin port, used for installing dars
network.participant.ports.jsonApi	int	`7575`	Json api port
network.participant.ports.ledger	int	`5001`	Ledger port
network.participant.user	string	`""`	Username to connect with
network.validator.host	string	`"validator-app"`	Hostname
network.validator.ports.http	int	`5003`	Http port, used for ui and api access

Observability¶

Key	Type	Default	Description
observability.datadogEnabled	bool	`false`	Add datadog annotations to all workload for auto discovery

Other Values¶

Key	Type	Default	Description
imageRepository	string	`"europe-docker.pkg.dev/da-images/public/docker"`	Base image repository