openstack/ansible-collections-openstack
Code Issues Proposed changes

Refactored server_action module

Browse Source 
Co-Authored-By: Jakob Meng <code@jakobmeng.de>
Change-Id: Ib9b7e26889123443a67b35e094deb3cadeb615fe
This commit is contained in:
Rafael Castillo 2022-09-15 13:07:32 -07:00 committed by Jakob Meng
parent 1b38b7c500
commit 778cf14f1b
4 changed files with 329 additions and 338 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ci/roles/server/tasks/main.yml
View File

@ -607,5 +607,3 @@
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
state: absent state: absent
name: "{{ server_network }}" name: "{{ server_network }}"
- import_tasks: server_actions.yml

304
ci/roles/server/tasks/server_actions.yml → ci/roles/server_action/tasks/main.yml
View File

@ -1,8 +1,19 @@
--- ---
- name: List all images
openstack.cloud.image_info:
cloud: "{{ cloud }}"
register: images
- name: Identify CirrOS image name
set_fact:
image_name: "{{ images.images|community.general.json_query(query)|first }}"
vars:
query: "[?starts_with(name, 'cirros')].name"
- name: Create network for server - name: Create network for server
openstack.cloud.network: openstack.cloud.network:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
name: "{{ server_network }}" name: ansible_server_network
state: present state: present
register: network register: network
@ -10,8 +21,8 @@
openstack.cloud.subnet: openstack.cloud.subnet:
cidr: 192.168.0.0/24 cidr: 192.168.0.0/24
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
name: "{{ server_subnet }}" name: ansible_server_subnet
network_name: "{{ server_network }}" network_name: ansible_server_network
state: present state: present
register: subnet register: subnet
@ -19,10 +30,10 @@
openstack.cloud.server: openstack.cloud.server:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
state: present state: present
name: "{{ server_name }}" name: ansible_server
image: "{{ image_name }}" image: "{{ image_name }}"
flavor: "{{ flavor_name }}" flavor: m1.tiny
network: "{{ server_network }}" network: ansible_server_network
auto_floating_ip: false auto_floating_ip: false
wait: true wait: true
register: server register: server
@ -30,18 +41,18 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info1 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info1.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- name: Stop server - name: Stop server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: stop action: stop
wait: true wait: true
register: server register: server
@ -49,19 +60,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info2 register: servers
- name: Ensure status for server is SHUTOFF - name: Ensure status for server is SHUTOFF
assert: assert:
that: that:
- info2.servers.0.status == 'SHUTOFF' - servers.servers.0.status == 'SHUTOFF'
- server is changed - server is changed
- name: Stop server again - name: Stop server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: stop action: stop
wait: true wait: true
register: server register: server
@ -69,19 +80,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info3 register: servers
- name: Ensure status for server is SHUTOFF - name: Ensure status for server is SHUTOFF
assert: assert:
that: that:
- info3.servers.0.status == 'SHUTOFF' - servers.servers.0.status == 'SHUTOFF'
- server is not changed - server is not changed
- name: Start server - name: Start server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: start action: start
wait: true wait: true
register: server register: server
@ -89,19 +100,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info4 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info4.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is changed - server is changed
- name: Start server again - name: Start server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: start action: start
wait: true wait: true
register: server register: server
@ -109,19 +120,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info5 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info5.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Pause server - name: Pause server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: pause action: pause
wait: true wait: true
register: server register: server
@ -129,19 +140,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info6 register: servers
- name: Ensure status for server is PAUSED - name: Ensure status for server is PAUSED
assert: assert:
that: that:
- info6.servers.0.status == 'PAUSED' - servers.servers.0.status == 'PAUSED'
- server is changed - server is changed
- name: Pause server again - name: Pause server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: pause action: pause
wait: true wait: true
register: server register: server
@ -149,19 +160,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info7 register: servers
- name: Ensure status for server is PAUSED - name: Ensure status for server is PAUSED
assert: assert:
that: that:
- info7.servers.0.status == 'PAUSED' - servers.servers.0.status == 'PAUSED'
- server is not changed - server is not changed
- name: Unpause server - name: Unpause server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unpause action: unpause
wait: true wait: true
register: server register: server
@ -169,19 +180,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info8 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info8.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is changed - server is changed
- name: Unpause server again - name: Unpause server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unpause action: unpause
wait: true wait: true
register: server register: server
@ -189,19 +200,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info9 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info9.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Lock server - name: Lock server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: lock action: lock
wait: true wait: true
register: server register: server
@ -209,20 +220,20 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info10 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info10.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- info10.servers.0.is_locked - servers.servers.0.is_locked
- server is changed - server is changed
- name: Lock server again - name: Lock server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: lock action: lock
wait: true wait: true
register: server register: server
@ -230,20 +241,20 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info11 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info11.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- info11.servers.0.is_locked - servers.servers.0.is_locked
- server is changed # no support for lock idempotency - server is not changed
- name: Unock server - name: Unock server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unlock action: unlock
wait: true wait: true
register: server register: server
@ -251,20 +262,20 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info12 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info12.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- not info12.servers.0.is_locked - not servers.servers.0.is_locked
- server is changed - server is changed
- name: Unlock server again - name: Unlock server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unlock action: unlock
wait: true wait: true
register: server register: server
@ -272,20 +283,20 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info13 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info13.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is changed # no support for unlock idempotency - server is not changed
- not info13.servers.0.is_locked - not servers.servers.0.is_locked
- name: Suspend server - name: Suspend server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: suspend action: suspend
wait: true wait: true
register: server register: server
@ -293,19 +304,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info14 register: servers
- name: Ensure status for server is SUSPENDED - name: Ensure status for server is SUSPENDED
assert: assert:
that: that:
- info14.servers.0.status == 'SUSPENDED' - servers.servers.0.status == 'SUSPENDED'
- server is changed - server is changed
- name: Suspend server again - name: Suspend server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: suspend action: suspend
wait: true wait: true
register: server register: server
@ -313,19 +324,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info15 register: servers
- name: Ensure status for server is SUSPENDED - name: Ensure status for server is SUSPENDED
assert: assert:
that: that:
- info15.servers.0.status == 'SUSPENDED' - servers.servers.0.status == 'SUSPENDED'
- server is not changed - server is not changed
- name: Resume server - name: Resume server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: resume action: resume
wait: true wait: true
register: server register: server
@ -333,19 +344,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info16 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info16.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is changed - server is changed
- name: Resume server again - name: Resume server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: resume action: resume
wait: true wait: true
register: server register: server
@ -353,19 +364,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info17 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info17.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Rebuild server - error - name: Rebuild server - error
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: rebuild action: rebuild
wait: true wait: true
register: server register: server
@ -380,7 +391,7 @@
- name: Rebuild server - name: Rebuild server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
image: "{{ image_name }}" image: "{{ image_name }}"
action: rebuild action: rebuild
wait: true wait: true
@ -389,19 +400,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info18 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info18.servers.0.status in ('ACTIVE', 'REBUILD') - servers.servers.0.status in ('ACTIVE', 'REBUILD')
- server is changed - server is changed
- name: Rebuild server with admin password - name: Rebuild server with admin password
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
image: "{{ image_name }}" image: "{{ image_name }}"
action: rebuild action: rebuild
wait: true wait: true
@ -411,19 +422,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info19 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info19.servers.0.status in ('ACTIVE', 'REBUILD') - servers.servers.0.status in ('ACTIVE', 'REBUILD')
- server is changed - server is changed
- name: Shelve server - name: Shelve server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: shelve action: shelve
wait: true wait: true
register: server register: server
@ -431,39 +442,48 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info20 register: servers
- name: Ensure status for server is SHELVED or SHELVED_OFFLOADED - name: Ensure status for server is SHELVED or SHELVED_OFFLOADED
assert: assert:
that: that:
- info20.servers.0.status in ['SHELVED', 'SHELVED_OFFLOADED'] - servers.servers.0.status in ['SHELVED', 'SHELVED_OFFLOADED']
- server is changed - server is changed
- name: Shelve offload server - name: Shelve offload server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: shelve_offload action: shelve_offload
wait: true wait: true
register: server register: server
ignore_errors: true
- name: Assert shelve offload server
assert:
that:
- ((server is success)
or (server is not success
and "Cannot 'shelveOffload' instance" in server.msg
and "while it is in vm_state shelved_offloaded" in server.msg))
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info21 register: servers
- name: Ensure status for server is SHELVED_OFFLOADED - name: Ensure status for server is SHELVED_OFFLOADED
# no change if server has been offloaded automatically after first shelve command # no change if server has been offloaded automatically after first shelve command
assert: assert:
that: that:
- info21.servers.0.status == 'SHELVED_OFFLOADED' - servers.servers.0.status == 'SHELVED_OFFLOADED'
- name: Shelve offload server again - name: Shelve offload server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: shelve_offload action: shelve_offload
wait: true wait: true
register: server register: server
@ -471,19 +491,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info22 register: servers
- name: Ensure status for server is SHELVED_OFFLOADED - name: Ensure status for server is SHELVED_OFFLOADED
assert: assert:
that: that:
- info22.servers.0.status == 'SHELVED_OFFLOADED' - servers.servers.0.status == 'SHELVED_OFFLOADED'
- server is not changed - server is not changed
- name: Unshelve server - name: Unshelve server
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unshelve action: unshelve
wait: true wait: true
register: server register: server
@ -491,19 +511,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info23 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info23.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is changed - server is changed
- name: Unshelve server again - name: Unshelve server again
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: unshelve action: unshelve
wait: true wait: true
register: server register: server
@ -511,19 +531,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info24 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info24.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Reboot server (SOFT) - name: Reboot server (SOFT)
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: reboot_soft action: reboot_soft
wait: true wait: true
register: server register: server
@ -531,19 +551,19 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info25 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info25.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Reboot server (HARD) - name: Reboot server (HARD)
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
action: reboot_hard action: reboot_hard
wait: true wait: true
register: server register: server
@ -551,33 +571,33 @@
- name: Get info about server - name: Get info about server
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_name }}" server: ansible_server
register: info26 register: servers
- name: Ensure status for server is ACTIVE - name: Ensure status for server is ACTIVE
assert: assert:
that: that:
- info26.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- server is not changed - server is not changed
- name: Delete server - name: Delete server
openstack.cloud.server: openstack.cloud.server:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
name: "{{ server_name }}" name: ansible_server
state: absent state: absent
wait: true wait: true
- name: Create network for alternate server - name: Create network for alternate server
openstack.cloud.network: openstack.cloud.network:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
name: "{{ server_alt_network }}" name: ansible_server_network2
state: present state: present
- name: Create subnet for alternate server - name: Create subnet for alternate server
openstack.cloud.subnet: openstack.cloud.subnet:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
network_name: "{{ server_alt_network }}" network_name: ansible_server_network2
name: "{{ server_alt_subnet }}" name: ansible_server_subnet2
state: present state: present
cidr: 192.168.0.0/24 cidr: 192.168.0.0/24
@ -585,88 +605,88 @@
openstack.cloud.server: openstack.cloud.server:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
state: present state: present
name: "{{ server_alt_name }}" name: ansible_server2
image: "{{ image_name }}" image: "{{ image_name }}"
flavor: "{{ flavor_name }}" flavor: m1.tiny
network: "{{ server_alt_network }}" network: ansible_server_network2
auto_floating_ip: false auto_floating_ip: false
wait: true wait: true
register: server_alt register: server
- name: Get info about server in alternate project - name: Get info about server in alternate project
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
server: "{{ server_alt_name }}" server: ansible_server2
register: info27 register: servers
- name: Ensure status for server in alternate project is ACTIVE - name: Ensure status for server in alternate project is ACTIVE
assert: assert:
that: that:
- info27.servers.0.status == 'ACTIVE' - servers.servers.0.status == 'ACTIVE'
- name: Try to stop server in alternate project - name: Try to stop server in alternate project
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_alt_name }}" server: ansible_server2
action: stop action: stop
wait: true wait: true
ignore_errors: true ignore_errors: true
register: server_alt register: server
- name: Ensure server was not stopped - name: Ensure server was not stopped
assert: assert:
that: that:
- server_alt is failed - server is failed
- server_alt.msg == "Could not find server {{ server_alt_name }}" - server.msg == "No Server found for ansible_server2"
- name: Stop server in alternate project with all_projects=true - name: Stop server in alternate project with all_projects=true
openstack.cloud.server_action: openstack.cloud.server_action:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
server: "{{ server_alt_name }}" server: ansible_server2
action: stop action: stop
wait: true wait: true
all_projects: True all_projects: True
register: server_alt register: server
- name: Get info about server in alternate project - name: Get info about server in alternate project
openstack.cloud.server_info: openstack.cloud.server_info:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
server: "{{ server_alt_name }}" server: ansible_server2
register: info26 register: servers
- name: Ensure status for server is SHUTOFF - name: Ensure status for server is SHUTOFF
assert: assert:
that: that:
- info26.servers.0.status == 'SHUTOFF' - servers.servers.0.status == 'SHUTOFF'
- server_alt is changed - server is changed
- name: Delete server in alternate project - name: Delete server in alternate project
openstack.cloud.server: openstack.cloud.server:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
state: absent state: absent
name: "{{ server_alt_name }}" name: ansible_server2
wait: true wait: true
- name: Delete subnet for alternate server - name: Delete subnet for alternate server
openstack.cloud.subnet: openstack.cloud.subnet:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
name: "{{ server_alt_subnet }}" name: ansible_server_subnet2
state: absent state: absent
- name: Delete network for alternate server - name: Delete network for alternate server
openstack.cloud.network: openstack.cloud.network:
cloud: "{{ cloud_alt }}" cloud: "{{ cloud_alt }}"
name: "{{ server_alt_network }}" name: ansible_server_network2
state: absent state: absent
- name: Delete subnet for server - name: Delete subnet for server
openstack.cloud.subnet: openstack.cloud.subnet:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
state: absent state: absent
name: "{{ server_subnet }}" name: ansible_server_subnet
- name: Delete network for server - name: Delete network for server
openstack.cloud.network: openstack.cloud.network:
cloud: "{{ cloud }}" cloud: "{{ cloud }}"
state: absent state: absent
name: "{{ server_network }}" name: ansible_server_network

1
ci/run-collection.yml
View File

@ -47,6 +47,7 @@
- { role: security_group, tags: security_group } - { role: security_group, tags: security_group }
- { role: security_group_rule, tags: security_group_rule } - { role: security_group_rule, tags: security_group_rule }
- { role: server, tags: server } - { role: server, tags: server }
- { role: server_action, tags: server_action }
- { role: server_group, tags: server_group } - { role: server_group, tags: server_group }
- { role: server_metadata, tags: server_metadata } - { role: server_metadata, tags: server_metadata }
- { role: server_volume, tags: server_volume } - { role: server_volume, tags: server_volume }

360
plugins/modules/server_action.py
View File

@ -4,236 +4,208 @@
# Copyright (c) 2015, Jesse Keating <jlk@derpops.bike> # Copyright (c) 2015, Jesse Keating <jlk@derpops.bike>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = ''' DOCUMENTATION = r'''
--- ---
module: server_action module: server_action
short_description: Perform actions on Compute Instances from OpenStack short_description: Perform actions on OpenStack compute (Nova) instances
author: OpenStack Ansible SIG author: OpenStack Ansible SIG
description: description:
- Perform server actions on an existing compute instance from OpenStack. - Perform actions on OpenStack compute (Nova) instances aka servers.
This module does not return any data other than changed true/false.
When I(action) is 'rebuild', then I(image) parameter is required.
options: options:
server: action:
description: description:
- Name or ID of the instance - Action to perform.
required: true - By default, only server owners and administrators are allowed to
type: str perform actions C(pause), C(unpause), C(suspend), C(resume), C(lock),
wait: C(unlock) and C(shelve_offload).
description: choices: [lock, pause, reboot_hard, reboot_soft, rebuild, resume, shelve,
- If the module should wait for the instance action to be performed. shelve_offload, start, stop, suspend, unlock, unpause, unshelve]
type: bool type: str
default: 'yes' required: true
timeout: admin_password:
description: description:
- The amount of time the module should wait for the instance to perform - Admin password for server to rebuild.
the requested action. type: str
default: 180 all_projects:
type: int description:
action: - Whether to search for server in all projects or the current project
description: only.
- Perform the given action. The lock and unlock actions always return type: bool
changed as the servers API does not provide lock status. default: false
choices: [stop, start, pause, unpause, lock, unlock, suspend, image:
reboot_soft, reboot_hard, resume, rebuild, shelve, description:
shelve_offload, unshelve] - Image name or ID the server should be rebuilt with.
type: str type: str
required: true name:
image: description:
description: - Server name or ID.
- Image the server should be rebuilt with required: true
type: str type: str
admin_password: aliases: ['server']
description:
- Admin password for server to rebuild
type: str
all_projects:
description:
- Whether to search for server in all projects or just the current
auth scoped project.
type: bool
default: 'no'
extends_documentation_fragment: extends_documentation_fragment:
- openstack.cloud.openstack - openstack.cloud.openstack
''' '''
EXAMPLES = ''' EXAMPLES = r'''
# Pauses a compute instance - name: Pauses a compute instance
- openstack.cloud.server_action: openstack.cloud.server_action:
action: pause cloud: devstack-admin
auth: action: pause
auth_url: https://identity.example.com server: vm1
username: admin timeout: 200
password: admin
project_name: admin
server: vm1
timeout: 200
''' '''
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
# If I(action) is set to C(shelve) then according to OpenStack's Compute API, the shelved
# server is in one of two possible states:
#
# SHELVED: The server is in shelved state. Depends on the shelve offload time,
# the server will be automatically shelved off loaded.
# SHELVED_OFFLOADED: The shelved server is offloaded (removed from the compute host) and
# it needs unshelved action to be used again.
#
# But wait_for_server can only wait for a single server state. If a shelved server is offloaded
# immediately, then a exceptions.ResourceTimeout will be raised if I(action) is set to C(shelve).
# This is likely to happen because shelved_offload_time in Nova's config is set to 0 by default.
# This also applies if you boot the server from volumes.
#
# Calling C(shelve_offload) instead of C(shelve) will also fail most likely because the default
# policy does not allow C(shelve_offload) for non-admin users while C(shelve) is allowed for
# admin users and server owners.
#
# As we cannot retrieve shelved_offload_time from Nova's config, we fall back to waiting for
# one state and if that fails then we fetch the server's state and match it against the other
# valid states from _action_map.
#
# Ref.: https://docs.openstack.org/api-guide/compute/server_concepts.html
_action_map = {'stop': ['SHUTOFF'],
'start': ['ACTIVE'],
'pause': ['PAUSED'],
'unpause': ['ACTIVE'],
'lock': ['ACTIVE'], # API doesn't show lock/unlock status
'unlock': ['ACTIVE'],
'suspend': ['SUSPENDED'],
'reboot_soft': ['ACTIVE'],
'reboot_hard': ['ACTIVE'],
'resume': ['ACTIVE'],
'rebuild': ['ACTIVE'],
'shelve': ['SHELVED_OFFLOADED', 'SHELVED'],
'shelve_offload': ['SHELVED_OFFLOADED'],
'unshelve': ['ACTIVE']}
_admin_actions = ['pause', 'unpause', 'suspend', 'resume', 'lock', 'unlock', 'shelve_offload']
class ServerActionModule(OpenStackModule): class ServerActionModule(OpenStackModule):
argument_spec = dict( argument_spec = dict(
server=dict(required=True),
action=dict(required=True, action=dict(required=True,
choices=['stop', 'start', 'pause', 'unpause', choices=['stop', 'start', 'pause', 'unpause',
'lock', 'unlock', 'suspend', 'reboot_soft', 'reboot_hard', 'resume', 'lock', 'unlock', 'suspend', 'reboot_soft',
'rebuild', 'shelve', 'shelve_offload', 'unshelve']), 'reboot_hard', 'resume', 'rebuild', 'shelve',
image=dict(), 'shelve_offload', 'unshelve']),
admin_password=dict(no_log=True), admin_password=dict(no_log=True),
all_projects=dict(type='bool', default=False), all_projects=dict(type='bool', default=False),
image=dict(),
name=dict(required=True, aliases=['server']),
) )
module_kwargs = dict( module_kwargs = dict(
required_if=[('action', 'rebuild', ['image'])], required_if=[('action', 'rebuild', ['image'])],
supports_check_mode=True, supports_check_mode=True,
) )
# If I(action) is set to C(shelve) then according to OpenStack's Compute
# API, the shelved server is in one of two possible states:
#
# SHELVED: The server is in shelved state. Depends on the shelve
# offload time, the server will be automatically
# shelved offloaded.
# SHELVED_OFFLOADED: The shelved server is offloaded (removed from the
# compute host) and it needs unshelved action to be
# used again.
#
# But wait_for_server can only wait for a single server state. If a shelved
# server is offloaded immediately, then a exceptions.ResourceTimeout will
# be raised if I(action) is set to C(shelve). This is likely to happen
# because shelved_offload_time in Nova's config is set to 0 by default.
# This also applies if you boot the server from volumes.
#
# Calling C(shelve_offload) instead of C(shelve) will also fail most likely
# because the default policy does not allow C(shelve_offload) for non-admin
# users while C(shelve) is allowed for admin users and server owners.
#
# As we cannot retrieve shelved_offload_time from Nova's config, we fall
# back to waiting for one state and if that fails then we fetch the
# server's state and match it against the other valid states from
# _action_map.
#
# Ref.: https://docs.openstack.org/api-guide/compute/server_concepts.html
_action_map = {'stop': ['SHUTOFF'],
'start': ['ACTIVE'],
'pause': ['PAUSED'],
'unpause': ['ACTIVE'],
'lock': ['ACTIVE'],
'unlock': ['ACTIVE'],
'suspend': ['SUSPENDED'],
'reboot_soft': ['ACTIVE'],
'reboot_hard': ['ACTIVE'],
'resume': ['ACTIVE'],
'rebuild': ['ACTIVE'],
'shelve': ['SHELVED_OFFLOADED', 'SHELVED'],
'shelve_offload': ['SHELVED_OFFLOADED'],
'unshelve': ['ACTIVE']}
def run(self): def run(self):
os_server = self._preliminary_checks() # TODO: Replace with self.conn.compute.find_server(
self._execute_server_action(os_server) # self.params['name'], all_projects=self.params['all_projects'],
# for some reason we don't wait for lock and unlock before exit # ignore_missing=False) when [0] has been merged.
if self.params['action'] not in ('lock', 'unlock'): # [0] https://review.opendev.org/c/openstack/openstacksdk/+/857936/
if self.params['wait']: server = self.conn.get_server(
self._wait(os_server) name_or_id=self.params['name'],
self.exit_json(changed=True) detailed=True,
all_projects=self.params['all_projects'])
if not server:
self.fail_json(msg='No Server found for {0}'
.format(self.params['name']))
def _preliminary_checks(self): action = self.params['action']
# Using Munch object for getting information about a server
os_server = self.conn.get_server(
self.params['server'],
all_projects=self.params['all_projects'],
)
if not os_server:
self.fail_json(msg='Could not find server %s' % self.params['server'])
# check mode
if self.ansible.check_mode:
self.exit_json(changed=self.__system_state_change(os_server))
# examine special cases
# lock, unlock and rebuild don't depend on state, just do it
if self.params['action'] not in ('lock', 'unlock', 'rebuild'):
if not self.__system_state_change(os_server):
self.exit_json(changed=False)
return os_server
def _execute_server_action(self, os_server): # rebuild does not depend on state
if self.params['action'] == 'rebuild': will_change = (
return self._rebuild_server(os_server) (action == 'rebuild')
if self.params['action'] == 'shelve_offload': or (action == 'lock' and not server['is_locked'])
# shelve_offload is not supported in OpenstackSDK or (action == 'unlock' and server['is_locked'])
return self._action(os_server, json={'shelveOffload': None}) or server.status.lower() not in [a.lower()
action_name = self.params['action'] + "_server" for a
in self._action_map[action]])
# reboot_* actions are using reboot_server method with an extra param if not will_change:
if self.params['action'] == 'reboot_soft' or self.params['action'] == 'reboot_hard': self.exit_json(changed=False)
action_name = 'reboot_server' elif self.ansible.check_mode:
self.exit_json(changed=True)
# else perform action
if action == 'rebuild':
# rebuild should ensure images exists
image = self.conn.image.find_image(self.params['image'],
ignore_missing=False)
kwargs = dict(server=server,
name=server['name'],
image=image['id'])
admin_password = self.params['admin_password']
if admin_password is not None:
kwargs['admin_password'] = admin_password
self.conn.compute.rebuild_server(**kwargs)
elif action == 'shelve_offload':
# TODO: Replace with shelve_offload function call when [0] has been
# merged.
# [0] https://review.opendev.org/c/openstack/openstacksdk/+/857947
# shelve_offload is not supported in openstacksdk <= 0.103.0
response = self.conn.compute.post(
'/servers/{server_id}/action'.format(server_id=server['id']),
json={'shelveOffload': None})
self.sdk.exceptions.raise_from_response(response)
else: # action != 'rebuild' and action != 'shelve_offload'
action_name = action + "_server"
# reboot_* actions are using reboot_server method with an
# additional argument
if action in ['reboot_soft', 'reboot_hard']:
action_name = 'reboot_server'
# Try to grab method from OpenstackSDK
try:
func_name = getattr(self.conn.compute, action_name) func_name = getattr(self.conn.compute, action_name)
except AttributeError:
self.fail_json(
msg="Method %s wasn't found in OpenstackSDK compute" % action_name)
# Do the action # Do the action
if self.params['action'] == 'reboot_soft': if action == 'reboot_soft':
func_name(os_server, 'SOFT') func_name(server, 'SOFT')
elif self.params['action'] == 'reboot_hard': elif action == 'reboot_hard':
func_name(os_server, 'HARD') func_name(server, 'HARD')
else: else:
func_name(os_server) func_name(server)
def _rebuild_server(self, os_server): if self.params['wait']:
# rebuild should ensure images exists for count in self.sdk.utils.iterate_timeout(
try: timeout=self.params['timeout'],
image = self.conn.get_image(self.params['image']) message='Timeout waiting for action {0} to be completed.'
except Exception as e: .format(action)
self.fail_json( ):
msg="Can't find the image %s: %s" % (self.params['image'], e)) server = self.conn.compute.get_server(server['id'])
if not image:
self.fail_json(msg="Image %s was not found!" % self.params['image'])
# admin_password is required by SDK, but not required by Nova API
if self.params['admin_password']:
self.conn.compute.rebuild_server(
server=os_server,
name=os_server['name'],
image=image['id'],
admin_password=self.params['admin_password']
)
else:
self._action(os_server, json={'rebuild': {'imageRef': image['id']}})
def _action(self, os_server, json): if (action == 'lock' and server['is_locked']) \
response = self.conn.compute.post( or (action == 'unlock' and not server['is_locked']):
'/servers/{server_id}/action'.format(server_id=os_server['id']), break
json=json)
self.sdk.exceptions.raise_from_response(response)
return response
def _wait(self, os_server): states = [s.lower() for s in self._action_map[action]]
"""Wait for the server to reach the desired state for the given action.""" if server.status.lower() in states:
# The wait_for_server function needs a Server object instead of the break
# Munch object returned by self.conn.get_server
server = self.conn.compute.get_server(os_server['id'])
states = _action_map[self.params['action']]
try: self.exit_json(changed=True)
self.conn.compute.wait_for_server(
server,
status=states[0],
wait=self.params['timeout'])
except self.sdk.exceptions.ResourceTimeout:
# raise if there is only one valid state
if len(states) < 2:
raise
# fetch current server status and compare to other valid states
server = self.conn.compute.get_server(os_server['id'])
if server.status not in states:
raise
def __system_state_change(self, os_server):
"""Check if system state would change."""
return os_server.status not in _action_map[self.params['action']]
def main(): def main():