Add more upgrade tasks according to phases
Update README
Introduce:
* heat.upgrade.upgrade.pre
* heat.upgrade.upgrade.post
* heat.upgrade.verify
Change-Id: If16ba94e4e3f3124211419f69ee42d9fbf185779
diff --git a/README.rst b/README.rst
index 6af9401..46a8fc6 100644
--- a/README.rst
+++ b/README.rst
@@ -272,6 +272,65 @@
You can read more about it here:
https://docs.openstack.org/security-guide/databases/database-access-control.html
+Upgrades
+========
+
+Each openstack formula provide set of phases (logical bloks) that will help to
+build flexible upgrade orchestration logic for particular components. The list
+of phases and theirs descriptions are listed in table below:
+
++-------------------------------+------------------------------------------------------+
+| State | Description |
++===============================+======================================================+
+| <app>.upgrade.service_running | Ensure that all services for particular application |
+| | are enabled for autostart and running |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.service_stopped | Ensure that all services for particular application |
+| | disabled for autostart and dead |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.pkgs_latest | Ensure that packages used by particular application |
+| | are installed to latest available version. |
+| | This will not upgrade data plane packages like qemu |
+| | and openvswitch as usually minimal required version |
+| | in openstack services is really old. The data plane |
+| | packages should be upgraded separately by `apt-get |
+| | upgrade` or `apt-get dist-upgrade` |
+| | Applying this state will not autostart service. |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.render_config | Ensure configuration is rendered actual version. +
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.pre | We assume this state is applied on all nodes in the |
+| | cloud before running upgrade. |
+| | Only non destructive actions will be applied during |
+| | this phase. Perform service built in service check |
+| | like (keystone-manage doctor and nova-status upgrade)|
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.upgrade.pre | Mostly applicable for data plane nodes. During this |
+| | phase resources will be gracefully removed from |
+| | current node if it is allowed. Services for upgraded |
+| | application will be set to admin disabled state to |
+| | make sure node will not participate in resources |
+| | scheduling. For example on gtw nodes this will set |
+| | all agents to admin disable state and will move all |
+| | routers to other agents. |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.upgrade | This state will basically upgrade application on |
+| | particular target. Stop services, render |
+| | configuration, install new packages, run offline |
+| | dbsync (for ctl), start services. Data plane should |
+| | not be affected, only OpenStack python services. |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.upgrade.post | Add services back to scheduling. |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.post | This phase should be launched only when upgrade of |
+| | the cloud is completed. Cleanup temporary files, |
+| | perform other post upgrade tasks. |
++-------------------------------+------------------------------------------------------+
+| <app>.upgrade.verify | Here we will do basic health checks (API CRUD |
+| | operations, verify do not have dead network |
+| | agents/compute services) |
++-------------------------------+------------------------------------------------------+
+
Documentation and Bugs
======================
diff --git a/heat/upgrade/post/init.sls b/heat/upgrade/post/init.sls
index a74a5fa..bba69e2 100644
--- a/heat/upgrade/post/init.sls
+++ b/heat/upgrade/post/init.sls
@@ -2,3 +2,7 @@
test.show_notification:
- name: "dump_post-upgrade_message_heat"
- text: "Running heat.upgrade.post"
+
+keystone_os_client_config_absent:
+ file.absent:
+ - name: /etc/openstack/clouds.yml
diff --git a/heat/upgrade/pre/init.sls b/heat/upgrade/pre/init.sls
index 675f796..eeaf6af 100644
--- a/heat/upgrade/pre/init.sls
+++ b/heat/upgrade/pre/init.sls
@@ -1,7 +1,15 @@
-include:
- - heat.upgrade.verify.api
-
heat_pre:
test.show_notification:
- name: "dump_message_pre-upgrade_heat"
- text: "Running heat.upgrade.pre"
+
+{%- set os_content = salt['mine.get']('I@keystone:client:os_client_config:enabled:true', 'keystone_os_client_config', 'compound').values()[0] %}
+keystone_os_client_config:
+ file.managed:
+ - name: /etc/openstack/clouds.yml
+ - contents: |
+ {{ os_content |yaml(False)|indent(8) }}
+ - user: 'root'
+ - group: 'root'
+ - makedirs: True
+ - unless: test -f /etc/openstack/clouds.yml
diff --git a/heat/upgrade/upgrade/init.sls b/heat/upgrade/upgrade/init.sls
index 0cd62a4..8a29dd6 100644
--- a/heat/upgrade/upgrade/init.sls
+++ b/heat/upgrade/upgrade/init.sls
@@ -6,8 +6,10 @@
- text: "Running heat.upgrade.upgrade"
include:
+ - heat.upgrade.upgrade.pre
- heat.upgrade.service_stopped
- heat.upgrade.pkgs_latest
- heat.upgrade.render_config
- heat.db.offline_sync
- heat.upgrade.service_running
+ - heat.upgrade.upgrade.post
diff --git a/heat/upgrade/upgrade/post.sls b/heat/upgrade/upgrade/post.sls
new file mode 100644
index 0000000..78de2f4
--- /dev/null
+++ b/heat/upgrade/upgrade/post.sls
@@ -0,0 +1,3 @@
+heat_upgrade_uprade_post:
+ test.show_notification:
+ - text: "Running heat.upgrade.upgrade.post"
diff --git a/heat/upgrade/upgrade/pre.sls b/heat/upgrade/upgrade/pre.sls
new file mode 100644
index 0000000..1c3fb2b
--- /dev/null
+++ b/heat/upgrade/upgrade/pre.sls
@@ -0,0 +1,3 @@
+heat_upgrade_upgrade_pre:
+ test.show_notification:
+ - text: "Running heat.upgrade.upgrade.pre"
diff --git a/heat/upgrade/verify/api.sls b/heat/upgrade/verify/_api.sls
similarity index 100%
rename from heat/upgrade/verify/api.sls
rename to heat/upgrade/verify/_api.sls
diff --git a/heat/upgrade/verify/init.sls b/heat/upgrade/verify/init.sls
new file mode 100644
index 0000000..697e7dc
--- /dev/null
+++ b/heat/upgrade/verify/init.sls
@@ -0,0 +1,2 @@
+include:
+ - heat.upgrade.verify._api