internet/ansible-collections-openstack
3
0
Fork 0
mirror of https://opendev.org/openstack/ansible-collections-openstack.git synced 2026-03-26 21:43:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Pivoted docs to generic resource{,s} modules and StateMachine class

Browse Source 
Change-Id: Iebcd45d0eae79ab3911fd97c63d17b42d238f875
This commit is contained in:
Jakob Meng
2023-01-16 11:38:11 +01:00
parent 90b110794f
commit f507465c9e
2 changed files with 79 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/contributing.md
View File

@@ -24,14 +24,16 @@ openstacksdk], please read our [branching docs](branching.md).
## Examples
* For an example on how to write a `*_info` module, have a look at module
[`openstack.cloud.neutron_rbac_policies_info`](../plugins/modules/neutron_rbac_policies_info.py).
* For an example on how to write a `*_info` module, have a look at modules [`openstack.cloud.identity_role_info`](
../plugins/modules/identity_role_info.py) or [`openstack.cloud.neutron_rbac_policies_info`](
../plugins/modules/neutron_rbac_policies_info.py).
* For an example on how to write a regular non-`*_info` module, have a look at module
[`openstack.cloud.neutron_rbac_policy`](../plugins/modules/neutron_rbac_policy.py) or any other module which
contains a `_will_change` method.
[`openstack.cloud.federation_idp`](../plugins/modules/federation_idp.py) or any other module which uses
[`class StateMachine`](../plugins/module_utils/resource.py).
* Do NOT use modules which define a `_system_state_change` function as examples, because they often do not properly
define Ansible's check mode, idempotency and/or updates. Refer to modules which define a `_will_change` function
instead.
define Ansible's check mode, idempotency and/or updates. Refer to modules which use [`class StateMachine`](
../plugins/module_utils/resource.py). In cases where using `class StateMachine` would cause code bloat, it might help
to look at modules which define a `_will_change` function instead.
## Naming