Install (Kubernetes)
Install (Kubernetes)
Warning
Make sure to complete the Prerequisites before proceeding.
The utilities application must be installed in the same namespace as your validator (shown as cnu in the example below).
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 -n cnu utilities -f values.yaml \
oci://europe-docker.pkg.dev/da-images/public/charts/utilities:0.12.5
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)
hostname: <some-host>
oidc:
clientId: <frontend client ID (from prerequisites)>
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 |
|
Enable commercial topup |
autoTopup.commercial.maxBalance |
int |
|
Topup to this balance |
autoTopup.commercial.minThreshold |
int |
|
Minimum threshold when to topup |
autoTopup.issuerParty |
string |
|
Issuer party to use when topping up |
autoTopup.retry |
int |
|
Retry count when topup fails |
autoTopup.schedule |
string |
|
Cron schedule for when to run the topup |
Frontend
Key |
Type |
Default |
Description |
|---|---|---|---|
frontend.enabled |
bool |
|
Enable the frontend |
frontend.hostname |
string |
|
hostname for the frontend |
frontend.oidc.audience |
string |
|
Token audience |
frontend.oidc.clientId |
string |
|
IDP client ID for callback |
frontend.oidc.issuerUri |
string |
|
IDP issuer uri for callback |
frontend.oidc.scope |
string |
|
Token scope (optional) |
Network
Key |
Type |
Default |
Description |
|---|---|---|---|
network.oidc.audience |
string |
|
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 |
|
Token scope |
network.operatorApiUrl |
string |
|
Public endpoint for fetching the operator’s party literal and explicitly disclosed contracts |
network.participant.host |
string |
|
Hostname |
network.participant.ports.admin |
int |
|
Admin port, used for installing dars |
network.participant.ports.jsonApi |
int |
|
Json api port |
network.participant.ports.ledger |
int |
|
Ledger port |
network.participant.user |
string |
|
Username to connect with |
network.validator.host |
string |
|
Hostname |
network.validator.ports.http |
int |
|
Http port, used for ui and api access |
Observability
Key |
Type |
Default |
Description |
|---|---|---|---|
observability.datadogEnabled |
bool |
|
Add datadog annotations to all workload for auto discovery |
Other Values
Key |
Type |
Default |
Description |
|---|---|---|---|
image.repo |
string |
|
Base image repository |
image.tag |
string |
|
Image tag override |