-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,29 @@ | ||
# XMTPD Infrastructure | ||
# xmtpd infrastructure | ||
|
||
This repository provides examples of running XMTPD node software using various infrastructure tooling. | ||
We provide: | ||
- [Helm](./helm/README.md) (in progress) | ||
- [Terraform](./terraform/README.md) (not started) | ||
This repository provides infrastructure-as-code examples and tooling to help node operators deploy and manage xmtpd nodes. xmtpd (XMTP daemon) is the node software that powers the testnet and will power the mainnet of the decentralized XMTP network. | ||
|
||
## Available tooling | ||
|
||
- [Helm charts](./helm/README.md) - Deploy xmtpd nodes on Kubernetes clusters | ||
- [Terraform](./terraform/README.md) - Provision cloud infrastructure for xmtpd nodes | ||
|
||
## Production deployment guide for GKE | ||
|
||
See [Deploy xmtpd on Google Kubernetes Engine secured by SSL/TLS](./doc/nginx-cert-gke.md) for a detailed guide to creating a production-ready deployment of xmtpd on GKE using NGINX Ingress Controller and Let's Encrypt certificates. | ||
|
||
## Get started | ||
|
||
1. Choose your infrastructure approach: | ||
- Use Helm charts if you have an existing Kubernetes cluster or want to deploy on managed Kubernetes services | ||
- Use Terraform if you need to provision the underlying cloud infrastructure | ||
2. Follow the respective README for your chosen tool | ||
3. For GKE production deployments, refer to the SSL/TLS deployment guide for securing your node | ||
|
||
## Learn more | ||
|
||
- [Decentralizing XMTP](https://xmtp.org/decentralizing-xmtp) | ||
- [XMTP documentation](https://docs.xmtp.org) | ||
|
||
## Contribute | ||
|
||
Contributions are welcome! See the [contributing guidelines](CONTRIBUTING.md) for details on how to get involved. |