Skip to content

Commit eeaba22

Browse files
committed
os_flavors: Update README
1 parent bafeb14 commit eeaba22

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

roles/os_flavors/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
OpenStack Flavors
22
=================
33

4-
This role can be used to register flavors in nova using the
5-
openstack.cloud.compute\_flavor module.
4+
This role can be used to register flavors in Nova using the
5+
`openstack.cloud.compute_flavor` module.
66

77
Requirements
88
------------
99

10-
The OpenStack nova API should be accessible from the target host.
10+
The OpenStack Nova API should be accessible from the target host.
1111

1212
Role Variables
1313
--------------
@@ -16,17 +16,17 @@ Role Variables
1616
virtualenv.
1717

1818
`os_flavors_auth_type` is an authentication type compatible with
19-
the `auth_type` argument of `os_*` Ansible modules.
19+
the `auth_type` argument of `openstack.cloud` Ansible modules.
2020

2121
`os_flavors_auth` is a dict containing authentication information
22-
compatible with the `auth` argument of `os_*` Ansible modules.
22+
compatible with the `auth` argument of `openstack.cloud` Ansible modules.
2323

2424
`os_flavors_cacert` is an optional path to a CA certificate bundle.
2525

2626
`os_flavors_interface` is the endpoint URL type to fetch from the service
2727
catalog. Maybe be one of `public`, `admin`, or `internal`.
2828

29-
`os_flavors` is a list of nova flavors to register. Each item should be a dict
29+
`os_flavors` is a list of Nova flavors to register. Each item should be a dict
3030
containing the items 'name', 'ram', 'disk', and 'vcpus'. Optionally, the dict
3131
may contain 'ephemeral', 'flavorid', 'rxtx_factor' and 'swap' items.
3232
Optionally, the dict may also contain an item 'extra_specs', which is a dict of
@@ -35,18 +35,18 @@ metadata to attach to the flavor object.
3535
Dependencies
3636
------------
3737

38-
This role depends on the `stackhpc.os_openstacksdk` role.
38+
This role depends on the `stackhpc.openstack.os_openstacksdk` role.
3939

4040
Example Playbook
4141
----------------
4242

43-
The following playbook registers a nova flavor.
43+
The following playbook registers a Nova flavor.
4444

4545
---
46-
- name: Ensure nova flavors are registered
47-
hosts: nova-api
46+
- name: Ensure Nova flavors are registered
47+
hosts: localhost
4848
roles:
49-
- role: os-flavors
49+
- role: stackhpc.openstack.os_flavors
5050
os_flavors_venv: "~/os-flavors-venv"
5151
os_flavors_auth_type: "password"
5252
os_flavors_auth:

0 commit comments

Comments
 (0)