Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 3.35 KB

README.md

File metadata and controls

74 lines (57 loc) · 3.35 KB
Raw

XMTPD Helm Charts

⚠️ Experimental: This software is in early development. Expect frequent changes and unresolved issues.

xmtpd (XMTP daemon) is an experimental version of XMTP node software. It is not the node software that currently forms the XMTP network.

This repository includes Helm Charts that can be used to deploy XMTPD in Kubernetes. You may also contribute by submitting enhancement requests if you like. Charts are curated application definitions for Helm. For more information about installing and using Helm, see its README.md. To get a quick introduction to Helm Charts see this chart document. For more information on using Helm, refer to the Helm's documentation.

XMTPD Helm Chart Installation

To add the XMTPD charts to your local helm repository, clone this repository locally.

Eventually XMTP will provide a public Helm Charts release.

1) Dependencies

XMTPD needs a Postgres database to be running accessible from the cluster. For example, you can use Bitnami PG Helm Charts, or any other tooling to provision a Postgres database.

2) Installing MLS Validation Service

The XMTP MLS Validation Service does not have any external dependencies. It is a stateless horizontally-scalable service.

To install, run:

helm install mls-validation-service mls-validation-service/

3) Installing the XMTPD Node

The XMPT daemon depends on the following:

  • a PG database running locally
  • the MLS validation service running locally
  • a blockchain with the Nodes contract
  • a private key
  • the private key needs to be registered with the blockchain smart contract and a NodeID has to be issued. For more info see Onboarding

Create a xmtpd.yaml file and fill out all required variables:

env:
  secret:
    XMTPD_DB_WRITER_CONNECTION_STRING: "postgres://postgres:[email protected]:5432/postgres?sslmode=disable"
    XMTPD_SIGNER_PRIVATE_KEY: "<private-key>"
    XMTPD_PAYER_PRIVATE_KEY: "<private-key>"
    XMTPD_CONTRACTS_RPC_URL: "https://rpc-testnet-staging-88dqtxdinc.t.conduit.xyz/"
    XMTPD_MLS_VALIDATION_GRPC_ADDRESS: "mls-validation-service.default.svc.cluster.local:50051"
    XMTPD_CONTRACTS_CHAIN_ID: "34498"
    XMTPD_CONTRACTS_NODES_ADDRESS: "<nodes-address>"
    XMTPD_CONTRACTS_MESSAGES_ADDRESS: "<messages-address>"
    XMTPD_CONTRACTS_IDENTITY_UPDATES_ADDRESS: "<identity-address>"
    XMTPD_METRICS_ENABLE: "true"
    XMTPD_REFLECTION_ENABLE: "true"
    XMTPD_LOG_LEVEL: "debug"

Install the helm chart

helm install xmtpd xmtpd/ -f xmtpd.yaml

Validating the installation

Once you have successfully installed all charts, including a DB, you should see 4 pods running. You can confirm via:

$ kubectl get pods
NAME                                      READY   STATUS    RESTARTS   AGE
mls-validation-service-75b6b96f79-kp4jq   1/1     Running   0          6h30m
psql-postgresql-0                         1/1     Running   0          6h26m
xmtpd-7dd49f6b88-mfwls                    1/1     Running   0          4h56m
xmtpd-7dd49f6b88-xdk6k                    1/1     Running   0          4h56m