Skip to content

Commit

Permalink
docs: improvement on the description of the playbook variables
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobdotcosta committed Sep 28, 2023
1 parent aff7915 commit 6c629c4
Showing 1 changed file with 45 additions and 9 deletions.
54 changes: 45 additions & 9 deletions ansible/playbook/openstack/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,14 @@ NOTE: The list of flavors is identified on the link:../../../openstack/README.ad

== Playbooks

=== Create a VM
=== Create a VM

Create OpenStack instance based on passwordstore
Create OpenStack instance based on passwordstore.

.openstack_vm_create_passwordstore parameters
[cols="2,5"]
[cols="2,5"]
[cols="20%,80%"]
|===
|Field name |Mandatory |Description

// a| Use an existing SSH key (value) instead of creating one for the VM.
|Field name | Description

| `vm_name`

Expand All @@ -51,6 +47,47 @@ a| Name of the VM being created.

This name will be used both as hostname as well as Ansible Inventory name.

| `openstack.vm`

[.fuchsia]#map#

[.red]#required#

a| Map with required attributes for RHOS.

Check below for more details.

|===

.openstack.vm map parameter
[cols="20%,80%"]
|===
|Field name | Description

| `flavor`

[.fuchsia]#string#

[.red]#required#

a| RHOS Flavor specifying the CPU, RAM and DISK sizes.

| `image`

[.fuchsia]#string#

[.red]#required#

a| OS Image to be used (e.g. `Fedora-Cloud-Base-37`).

| `network`

[.fuchsia]#string#

[.red]#required#

a| Network provider in RHOS

|===

[source,bash]
Expand All @@ -60,7 +97,7 @@ $ VM_NAME=vm20210221-t01

[source,bash]
----
$ ansible-playbook playbook/openstack/openstack_vm_create_passwordstore.yml -e k8s_type=masters -e k8s_version=123 -e '{"openstack": {"vm": {"network": "provider_net_shared","image": "Fedora-Cloud-Base-35", "flavor": "m1.medium"}}}' -e key_name=test-adm-key -e vm_name=${VM_NAME}
$ ansible-playbook playbook/openstack/openstack_vm_create_passwordstore.yml -e '{"openstack": {"vm": {"network": "provider_net_shared","image": "Fedora-Cloud-Base-35", "flavor": "m1.medium"}}}' -e key_name=test-adm-key -e vm_name=${VM_NAME}
----

Although some failures might occur some might be ignored which shouldn't affect thhe process. This playbook should finish with no failed tasks.
Expand Down Expand Up @@ -155,4 +192,3 @@ All activity is being monitored.
Welcome to vm20210221-t01..
======

0 comments on commit 6c629c4

Please sign in to comment.