Skip to content

Commit

Permalink
Add vmware info about a new var (#722)
Browse files Browse the repository at this point in the history
Adds info about a new var for deployment with terraform in vmware
  • Loading branch information
Itxaka authored and Markus Napp committed Apr 6, 2020
1 parent 10f01eb commit 8cea51a
Showing 1 changed file with 39 additions and 29 deletions.
68 changes: 39 additions & 29 deletions adoc/deployment-terraform-example.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,86 +107,96 @@ private key. At least one of the keys must match a key loaded into your
# datastore to use in vSphere
vsphere_datastore = "STORAGE-0" // <1>
# datastore_ cluster to use in vSphere
vsphere_datastore_cluster = "STORAGE-CLUSTER-0" // <2>
# datacenter to use in vSphere
vsphere_datacenter = "DATACENTER" // <2>
vsphere_datacenter = "DATACENTER" // <3>
# network to use in vSphere
vsphere_network = "VM Network" // <3>
vsphere_network = "VM Network" // <4>
# resource pool the machines will be running in
vsphere_resource_pool = "My_RP" // <4>
vsphere_resource_pool = "My_RP" // <5>
# template name the machines will be copied from
template_name = "sles15-sp1-caasp" // <5>
template_name = "sles15-sp1-caasp" // <6>
# IMPORTANT: Replace by "efi" string in case your template was created by using EFI firmware
firmware = "bios"
# prefix that all of the booted machines will use
# IMPORTANT: please enter unique identifier below as value of
# stack_name variable to not interfere with other deployments
stack_name = "caasp-v4" // <6>
stack_name = "caasp-v4" // <7>
# Number of master nodes
masters = 1 // <7>
masters = 1 // <8>
# Optional: Size of the root disk in GB on master node
master_disk_size = 50 // <8>
master_disk_size = 50 // <9>
# Number of worker nodes
workers = 2 // <9>
workers = 2 // <10>
# Optional: Size of the root disk in GB on worker node
worker_disk_size = 40 // <10>
worker_disk_size = 40 // <11>
# Username for the cluster nodes. Must exist on base OS.
username = "sles" // <11>
username = "sles" // <12>
# Optional: Define the repositories to use
# repositories = {
# repository1 = "http://repo.example.com/repository1/"
# repository2 = "http://repo.example.com/repository2/"
# }
repositories = {} // <12>
repositories = {} // <13>
# Minimum required packages. Do not remove them.
# Feel free to add more packages
packages = [ // <13>
packages = [ // <14>
]
# ssh keys to inject into all the nodes
authorized_keys = [ // <14>
authorized_keys = [ // <15>
"ssh-rsa <example_key> example@example.com"
]
# IMPORTANT: Replace these ntp servers with ones from your infrastructure
ntp_servers = ["0.novell.pool.ntp.org", "1.novell.pool.ntp.org", "2.novell.pool.ntp.org", "3.novell.pool.ntp.org"] // <15>
ntp_servers = ["0.novell.pool.ntp.org", "1.novell.pool.ntp.org", "2.novell.pool.ntp.org", "3.novell.pool.ntp.org"] // <16>
----
<1> `vsphere_datastore`: The datastore to use.
<2> `vsphere_datacenter`: The datacenter to use.
<3> `vsphere_network`: The network to use.
<4> `vsphere_resource_pool`: The resource pool to use.
<5> `template_name`: The name of the template created according to instructions.
<6> `stack_name`: Prefix for all machines of the cluster spawned by terraform.

[IMPORTANT]
====
Only one of `vsphere_datastore` or `vsphere_datastore_cluster` can be set at the same time. Proceed to comment or delete the unused one from your `terraform.tfvars`
====

<1> `vsphere_datastore`: The datastore to use. This option is mutually exclusive with `vsphere_datastore_cluster`.
<2> `vsphere_datastore_cluster`: The datastore cluster to use. This option is mutually exclusive with `vsphere_datastore`.
<3> `vsphere_datacenter`: The datacenter to use.
<4> `vsphere_network`: The network to use.
<5> `vsphere_resource_pool`: The resource pool to use.
<6> `template_name`: The name of the template created according to instructions.
<7> `stack_name`: Prefix for all machines of the cluster spawned by terraform.
*Note*: This string will be used to generate the human readable IDs in {soc}.
If you use a generic term, deployment very likely to fail because the term is already in use by someone else. It's a good idea to use your username or some other unique identifier.
<7> `masters`: Number of master nodes to be deployed.
<8> `master_disk_size`: Size of the root disk in GB.
<8> `masters`: Number of master nodes to be deployed.
<9> `master_disk_size`: Size of the root disk in GB.
*Note*: The value must be at least the same size as the source template. It is only possible to increase the size of a disk.
<9> `workers`: Number of worker nodes to be deployed.
<10> `worker_disk_size`: Size of the root disk in GB.
<10> `workers`: Number of worker nodes to be deployed.
<11> `worker_disk_size`: Size of the root disk in GB.
*Note*: The value must be at least the same size as the source template. It is only possible to increase the size of a disk.
<11> `username`: Login username for the nodes.
<12> `username`: Login username for the nodes.
*Note*: Leave this as the default `sles`. The username must exist on the used base operating system. It will not be created.
<12> `repositories`: A list of additional repositories to be added on each
<13> `repositories`: A list of additional repositories to be added on each
machines. Leave empty if no additional packages need to be installed.
<13> `packages`: Additional packages to be installed on the node.
<14> `packages`: Additional packages to be installed on the node.
*Note*: Do not remove any of the pre-filled values in the `packages` section. This can render
your cluster unusable. You can add more packages but do not remove any of the
default packages listed.
<14> `authorized_keys`: List of ssh-public-keys that will be able to log in to the
<15> `authorized_keys`: List of ssh-public-keys that will be able to log in to the
deployed machines.
<15> `ntp_servers`: A list of `ntp` servers you would like to use with `chrony`.
<16> `ntp_servers`: A list of `ntp` servers you would like to use with `chrony`.
# end::tf_vmware[]


Expand Down

0 comments on commit 8cea51a

Please sign in to comment.