Skip to content

Commit 96cf311

Browse files
committed
add ec2 to README
1 parent a7660b3 commit 96cf311

3 files changed

Lines changed: 7 additions & 17 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ nimbus-secrets.json
1212
secrets.env
1313
.envrc
1414
outputs/
15+

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,10 @@
55
This repository contains instructions and configuration for running your own unison.cloud "Bring Your Own Cloud" (BYOC) cluster. There are multiple options based on how you'd like to deploy your cluster:
66

77
- [Docker Compose instructions](docker/README.md) for a simple deployment on a local cluster.
8-
- [EKS instructions](eks/README.md) to use Terraform (or OpenTofu) to deploy on a Kubernetes cluster via AWS Elastic Kubernetes Service (EKS).
8+
- [EC2 instructions](ec2/README.md) to use Terraform (or OpenTofu) to deploy to to AWS EC2 instances
9+
- [EKS instructions](eks/README.md) to use Terraform (or OpenTofu) to deploy on a Kubernetes cluster via AWS Elastic Kubernetes Service (EKS) and deploy Unison Cloud on the resulting Kubernetes cluster.
910

1011

1112
## Scope
1213

1314
These configurations are intended to demonstrate minimalist deployments of unison.cloud. They are **not production-ready** but serve testing, development, and demonstration purposes. They provide an easy way to test unison.cloud in your own environment, with the expectation that you might later integrate these learnings into an existing production environment.
14-
15-
## Prerequisites
16-
17-
### Cluster name
18-
19-
To register a Unison Cloud cluster, you'll need a cluster name. You can come up with your own or have one generated for you, but it must be unique across all Unison Cloud clusters. It should be a valid DNS subdomain, meaning it must consist of only lowercase letters, numbers, and hyphens, and must start and end with a letter or number.
20-
21-
### Register a BYOC cluster
22-
23-
See [the Unison Cloud BYOC website](https://www.unison.cloud/byoc/) for more info.
24-
25-
26-
### Cluster token
27-
28-
Before deploying your cluster you will need a cluster token to authenticate your nodes with the Unison Cloud control plane. You will receive one of these when your cluster is registered.

eks/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,10 @@ $ tofu init
7878
$ tofu apply
7979
```
8080
`tofu init` will inspect the configuration and download any necessary terraform modules.
81-
`tofu apply` will create all the needed resources in your AWS account, this might take 20-30 minutes. The script will generate a `outputs/cluster_setup.u` file that that contains a `ClientConfig` which you can use to deploy services and
81+
`tofu apply` will create all the needed resources in your AWS account, this might take 20-30 minutes. Upon successful completion, `tofu apply` will display all out the "outputs" which can later be retrieved by running `tofu output`.
82+
83+
### Using the cluster
84+
The script will generate a `outputs/cluster_setup.u` file that that contains a `ClientConfig` which you can use to deploy services and
8285
run jobs against your cluster.
8386

8487
You can save this output into your scratch file, or load this file into a ucm session with `> load /path/to/outputs/cluster_setup.u`. and then you should be able to `> run myJob` to launch a job on your new cluster!

0 commit comments

Comments
 (0)