diff --git a/README.md b/README.md index 50c300cf6866f5f9f262cd20502844965ee3a4de..258c7c65b843657111f1754009c1bb21cf3ebad4 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,22 @@ * Copy `terraform.tfvars.example` to `terraform.tfvars` and edit in appropriate values * Run `terraform init` * Run `terraform apply` + +# Variables + +| Variable | Type | Required | Default | Description | +| :--- | :--- | :--- | :--- | :--- | +| `user_name` | string | yes | | OpenStack username | +| `user_domain_name` | string | no | `uab` | The login domain to use for the user | +| `appcred_id` | string | yes | | Application credential ID. Get one from the openstack dashboard | +| `appcred_name` | string | yes | | Name of the application credential | +| `appcred_secret` | string | yes | | Application credential secret | +| `ssh_keypair` | string | yes | | ssh keypair name to use for authentication | +| `base_image_name` | string | no | `sles-15-sp2-x86_64` | Base image to use for all instances | +| `osd_node_count` | number | no | 3 | Amount of OSD node(s) to provision | +| `public_network_dns` | list(string) | no | \["138.26.134.2"\] | DNS to use for hosts | +| `sles_reg_code` | string | yes | | SUSE Enterprise registration code | +| `sles_reg_email` | string | yes | | email for use with SUSE registration | +| `sles_ses_reg` | string | yes | | code to register for the storage package in SUSE | +| `osd_disk_sizes` | list(number) | no | \[8, 8\] | Amount/size of disks to add, in GB | +