Skip to content

Commit

Permalink
- apply suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielcocenza committed Mar 21, 2024
1 parent 35696ed commit 51dccc4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 25 deletions.
21 changes: 13 additions & 8 deletions docs/how-to/plan-upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ printed on STDOUT.
Plan for the whole cloud
------------------------

To generate a plan for **control-plane** and **data-plane** use:
To generate a plan for the entire OpenStack cloud, including both the **control-plane** and the
**data-plane**, use:

.. code:: bash
Expand Down Expand Up @@ -87,8 +88,11 @@ To generate a plan targeting the **data-plane** applications use:
cou plan data-plane
**Note:** It's essential to complete the upgrade of the **control-plane** components before
being able to generate the plan for **data-plane**.
**Note:**
- It's essential to complete the upgrade of the **control-plane** components before being able to
generate a plan for the **data-plane**.
- By default, this command will skip hypervisors from the planning that have VMs running. See the
`Plan for non-empty hypervisors`_ section to include them.


Plan for the hypervisors
Expand All @@ -100,7 +104,7 @@ To generate a plan targeting just the **hypervisors** use:
cou plan hypervisors
It's also possible to target for specific **availability-zones** or **machines**:
It's also possible to target for specific Juju **availability-zones** or **machines**:

.. code:: bash
Expand All @@ -112,17 +116,18 @@ It's also possible to target for specific **availability-zones** or **machines**
**Note:**:
- Those specific filters are mutually exclusive, meaning that it's not possible
to use then together.
to use them together.
- Since **hypervisors** comprise a subset of **data-plane** components, it is
also necessary to complete the upgrade of the **control-plane** components before
being able to generate **hypervisors** plan.
being able to generate a plan for the **hypervisors**.
- By default, this command will skip hypervisors from the planning that have VMs running. See the
`Plan for non-empty hypervisors`_ section to include them.


Plan for non-empty hypervisors
------------------------------

By default, COU will skip from the planning hypervisors that have VMs running. If it's
necessary to also include then, use the `--force` command. For example:
If it's necessary to plan for non-empty hypervisors, use the `--force` command. For example:

.. code:: bash
Expand Down
33 changes: 16 additions & 17 deletions docs/how-to/upgrade-cloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ Recommendations for upgrading production clouds
1. Be sure to upgrade in a maintenance window
2. Start with the upgrade on control-plane applications
3. Don't force the upgrade on non-empty hypervisors
4. After upgrading the control-plane, choose one empty hypervisor to be a `canary node`.
4. After upgrading the **control-plane**, choose one empty hypervisor to be a `canary node`.
After upgrading it, test if it's behaving as expected.
5. If no issues are found after upgrading the `canary node`, proceed with the upgrade.

Run upgrade for the whole cloud
-------------------------------

To upgrade the whole cloud in a single command.
To upgrade the entire OpenStack cloud, including both the **control-plane** and the
**data-plane**, use:

.. code:: bash
Expand All @@ -25,30 +26,27 @@ To upgrade the whole cloud in a single command.
Run upgrade for the control-plane
---------------------------------

To upgrade a plan targeting the **control-plane** applications use:
To run an upgrade targeting the **control-plane** applications use:

.. code:: bash
cou upgrade control-plane
**Note:** Control-plane applications will be upgraded using the `all-in-one`_ method,
meaning that all units will be upgraded at once.

Run upgrade for the data-plane
------------------------------

To upgrade the **data-plane** applications use:
To run an upgrade targeting the **data-plane** applications use:

.. code:: bash
cou plan data-plane
cou upgrade data-plane
**Note:**
- It's essential to complete the upgrade of the **control-plane** components before
being able to upgrade for **data-plane**.
- Nova-compute and services colocated on the same machines will be upgraded using the
`paused-single-unit`_ method, meaning that it will upgrade unit by unit.
being able to upgrade the **data-plane**.
- By default, this command will not upgrade hypervisors that have VMs running. See the
`Upgrade non-empty hypervisors`_ section to include them.


Run upgrade for the hypervisors
Expand All @@ -60,7 +58,7 @@ To upgrade just the **hypervisors** use:
cou upgrade hypervisors
It's also possible to target for specific **availability-zones** or **machines**:
It's also possible to target for specific Juju **availability-zones** or **machines**:

.. code:: bash
Expand All @@ -72,15 +70,16 @@ It's also possible to target for specific **availability-zones** or **machines**
**Note:**
- Those specific filters are mutually exclusive, meaning that it's not possible
to use then together.
to use them together.
- Since **hypervisors** comprise a subset of **data-plane** components, it is
also necessary to complete the upgrade of the **control-plane** components before
being able to upgrade the **hypervisors**.
the **hypervisors** can be upgraded.
- By default, this command will not upgrade hypervisors that have VMs running. See the
`Upgrade non-empty hypervisors`_ section to include them.

Upgrade non-empty hypervisors
-----------------------------
By default, COU will skip the upgrade on hypervisors that have VMs running. If it's
necessary to also include then, use the `--force` command. For example:
If it's necessary to upgrade non-empty hypervisors, use the `--force` command. For example:

.. code:: bash
Expand All @@ -97,7 +96,7 @@ necessary to also include then, use the `--force` command. For example:
cou upgrade hypervisors --availability-zone=zone-1 --force
**Note:** This is not safe and might cause problems in the running VMs. The recommendation
is to migrate the VMs and upgrade machines that are empty
is to migrate the VMs and upgrade hypervisors machines that are empty.

Run interactive upgrades
------------------------
Expand Down

0 comments on commit 51dccc4

Please sign in to comment.