Skip to content

Commit

Permalink
add terraform variable descriptions.
Browse files Browse the repository at this point in the history
  • Loading branch information
balchua committed Mar 21, 2021
1 parent 1b6814e commit 88d58b3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For example to bootstrap a 7 node cluster.
```hcl
module "microk8s" {
source = "git::https://github.com/balchua/do-microk8s?ref=master"
source = "git::https://github.com/balchua/do-microk8s?ref=master"
node_count = "7"
os_image = "ubuntu-20-04-x64"
node_size = "s-4vcpu-8gb"
Expand All @@ -29,7 +29,23 @@ module "microk8s" {
```

**The `cluster_token` must be 32 alphanumeric characters long.**
| Fields | Description |
| ----------------------------- |:-----------------------------------------|
| source | The source of the terraform module |
| node_count | The number of MicroK8s nodes to create |
| os_image | DigitalOcean OS images. <br/>To get the list OS images `doctl compute image list-distribution`|
| node_size | DigitalOcean droptlet sizes <br/> To get the list of droplet sizes `doctl compute size list`|
| node_disksize | Additional volume to add to the droplet. Size in GB| |
| region | DigitalOcean region <br/> To get the list of regions `doctl compute region list`|
| dns_zone | The DNS zone representing your site. Need to register your domain. |
| microk8s_channel | Specify the MicroK8s channel to use. Refer [here](https://snapcraft.io/microk8s)|
| cluster_token | The bootstrap token to use when joining nodes together, must be 32 alphanumeric characters long.|
| cluster_token_ttl_seconds | How long the token validity (in seconds)|
| digitalocean_ssh_fingerprint | Your DigitalOcean SSH fingerprint to use, so you can seemlessly `ssh` into your nodes|
| digitalocean_private_key | The private key location to use when connecting to your droplets|
| digitalocean_token | Your DigitalOcean token|
| digitalocean_pub_key | The public key to use to connect to the droplet|


## DigitalOcean TF environment variables

Expand Down

0 comments on commit 88d58b3

Please sign in to comment.