added auto_upgrade flag #956

Cl0udius · 2022-06-21T15:23:12Z

Adds the possibility to set an auto_upgrade flag (true|false) to optionally prevent automatic AWX instance upgrades when the operator gets upgraded.

AWX will be upgraded if a deployment exists and the flag is set to true or no deployment exits.
With this we can set instances to "auto_upgrade: false" and recreate the deployment of multiple AWX instances step by step instead of doing it all at once.

Related issue: #936

fosterseth · 2022-06-21T16:33:02Z

roles/installer/tasks/main.yml

+    namespace: "{{ ansible_operator_meta.namespace }}"
+  register: tower_deployment
+
+- block:


instead of this block, might be best to split this out to another task. That is, move everything that is in your block into a install.yml and have the Check for presence of Deployment still in main.yml. then include and run the install.yml task if your auto_update condition is true.

moved to install.yml

fosterseth · 2022-06-21T16:47:08Z

@shanemcd @rooftopcellist how do we feel about this auto_upgrade boolean? I definitely see the use case. That is, not bumping the awx pods and leading to application downtime only because the operator changed.

auto_upgrade might not be the best term, maybe auto_redeploy? If the user hard-codes the AWX version to use, they aren't really upgrading per-se, rather just bumping the awx pods.

roles/installer/tasks/main.yml

shanemcd · 2022-06-21T16:50:11Z

I think I'm fine with both the idea and the naming of the variable. Even if you hardcode the version of the image, other stuff in the yaml might have changed too.

rooftopcellist · 2022-06-21T18:03:11Z

@Cl0udius With this PR, if you set auto_upgrade to false, what exactly would the "manual upgrade" steps be? Could we add that to the README.md?

My guess is that for each instance, you would need to modify the AWX spec to:

Temporarily change auto_upgrade to true, which will trigger the reconciliation loop for just that instance.
Allow the reconciliation loop to complete, which will run the install.yml, and update the deployment yaml to point at the new AWX image.
Containers will cycle picking up the new AWX version.
Change auto_upgrade back to true on the spec. The reconciliation loop should one one more time, but will be a no-op.

^^ Is that what you had in mind?

Cl0udius · 2022-06-22T06:28:20Z

@Cl0udius With this PR, if you set auto_upgrade to false, what exactly would the "manual upgrade" steps be? Could we add that to the README.md?

My guess is that for each instance, you would need to modify the AWX spec to:
1. Temporarily change auto_upgrade to `true`, which will trigger the reconciliation loop for just that instance.

2. Allow the reconciliation loop to complete, which will run the install.yml, and update the deployment yaml to point at the new AWX image.

3. Containers will cycle picking up the new AWX version.

4. Change auto_upgrade back to `true` on the spec.  The reconciliation loop should one one more time, but will be a no-op.
^^ Is that what you had in mind?

Hi,

that would be one way. Another thing we could do is to leave the flag on value false and just remove the deployment from K8S which will also trigger the loop and will rollout the new version.

I can add both ways if this would help.

BR

shanemcd · 2022-06-23T11:52:45Z

README.md

+With this parameter you can influence the behaviour during an operator upgrade.  
+If set to true the operator will upgrade the specific instance directly.  
+When the value is set to false and we have a running deployment the operator will not update the AWX instance.  
+This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.  


Suggested change

This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.

This can be useful when you have multiple AWX instances which you want to upgrade step by step instead all at once.

Suggested change

This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.

This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.

shanemcd · 2022-06-23T11:53:57Z

README.md

@@ -1034,6 +1036,23 @@ Example configuration of `no_log` parameter
    no_log: 'true'
 ```

+#### Auto upgrade
+With this parameter you can influence the behaviour during an operator upgrade.  
+If set to true the operator will upgrade the specific instance directly.  


Suggested change

If set to true the operator will upgrade the specific instance directly.

If set to `true`, the operator will upgrade the specific instance directly.

Suggested change

If set to true the operator will upgrade the specific instance directly.

If set to true the operator will upgrade the specific instance directly.

shanemcd · 2022-06-23T11:54:31Z

README.md

+#### Auto upgrade
+With this parameter you can influence the behaviour during an operator upgrade.  
+If set to true the operator will upgrade the specific instance directly.  
+When the value is set to false and we have a running deployment the operator will not update the AWX instance.  


Suggested change

When the value is set to false and we have a running deployment the operator will not update the AWX instance.

When the value is set to `false` and we have a running deployment, the operator will not update the AWX instance.

shanemcd · 2022-06-23T11:54:50Z

README.md

+With this parameter you can influence the behaviour during an operator upgrade.  
+If set to true the operator will upgrade the specific instance directly.  
+When the value is set to false and we have a running deployment the operator will not update the AWX instance.  
+This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.  


Suggested change

This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.

This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead of all at once.

shanemcd · 2022-06-23T11:56:22Z

roles/installer/tasks/main.yml

+# Just execute deployment steps when auto_upgrade is true or when no deployment exists
+- name: Start installation
+  include_tasks: install.yml
+  when: (tower_deployment['resources'] | length > 0 and auto_upgrade == true) or (tower_deployment['resources'] | length == 0)


You probably need to cast this to a boolean:

Suggested change

when: (tower_deployment['resources'] | length > 0 and auto_upgrade == true) or (tower_deployment['resources'] | length == 0)

when: (tower_deployment['resources'] | length > 0 and auto_upgrade | bool) or (tower_deployment['resources'] | length == 0)

shanemcd · 2022-06-23T11:57:01Z

README.md

+
+```yaml
+  spec:
+    auto_upgrade: 'true'


Is this intentionally represented as a string here?

Nope. Changed now.

shanemcd · 2022-06-23T11:57:46Z

README.md

@@ -1095,6 +1114,25 @@ Then install the new AWX Operator by following the instructions in [Basic Instal

 Once the new AWX Operator is up and running, your AWX deployment will also be upgraded.

+##### Upgrade of instances with auto upgrade


I would move this up under the #### Auto upgrade section.

Moved like suggested

shanemcd

I think people will like this feature. Thank you! ⭐

Cl0udius changed the title ~~added auto_update flag~~ added auto_upgrade flag Jun 21, 2022

fosterseth reviewed Jun 21, 2022

View reviewed changes

shanemcd reviewed Jun 21, 2022

View reviewed changes

roles/installer/tasks/main.yml Outdated Show resolved Hide resolved

Cl0udius force-pushed the add_auto_upgrade_parameter branch from b20eb22 to aa311b1 Compare June 22, 2022 09:47

shanemcd reviewed Jun 23, 2022

View reviewed changes

added auto_update flag

35d4954

Cl0udius force-pushed the add_auto_upgrade_parameter branch from aa311b1 to 35d4954 Compare June 23, 2022 13:05

shanemcd approved these changes Jun 27, 2022

View reviewed changes

shanemcd merged commit 34b6354 into ansible:devel Jun 27, 2022

fosterseth mentioned this pull request Jun 29, 2022

Upgrading AWX operator disrupts the previous AWX deployments #968

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added auto_upgrade flag #956

added auto_upgrade flag #956

Cl0udius commented Jun 21, 2022

fosterseth Jun 21, 2022

Cl0udius Jun 22, 2022

fosterseth commented Jun 21, 2022 •

edited

Loading

shanemcd commented Jun 21, 2022

rooftopcellist commented Jun 21, 2022

Cl0udius commented Jun 22, 2022

shanemcd Jun 23, 2022

shanemcd Jun 23, 2022

shanemcd Jun 23, 2022

shanemcd Jun 23, 2022

shanemcd Jun 23, 2022

shanemcd Jun 23, 2022

Cl0udius Jun 23, 2022 •

edited

Loading

shanemcd Jun 23, 2022

Cl0udius Jun 23, 2022

shanemcd left a comment

	This can be usefull when you have multiple AWX instances which you want to upgrade step by step instead all at once.
	This can be useful when you have multiple AWX instances which you want to upgrade step by step instead all at once.

	If set to true the operator will upgrade the specific instance directly.
	If set to `true`, the operator will upgrade the specific instance directly.

	When the value is set to false and we have a running deployment the operator will not update the AWX instance.
	When the value is set to `false` and we have a running deployment, the operator will not update the AWX instance.

	when: (tower_deployment['resources'] \| length > 0 and auto_upgrade == true) or (tower_deployment['resources'] \| length == 0)
	when: (tower_deployment['resources'] \| length > 0 and auto_upgrade \| bool) or (tower_deployment['resources'] \| length == 0)

		@@ -1095,6 +1114,25 @@ Then install the new AWX Operator by following the instructions in [Basic Instal

		Once the new AWX Operator is up and running, your AWX deployment will also be upgraded.

		##### Upgrade of instances with auto upgrade

added auto_upgrade flag #956

added auto_upgrade flag #956

Conversation

Cl0udius commented Jun 21, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fosterseth commented Jun 21, 2022 • edited Loading

shanemcd commented Jun 21, 2022

rooftopcellist commented Jun 21, 2022

Cl0udius commented Jun 22, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cl0udius Jun 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shanemcd left a comment

Choose a reason for hiding this comment

fosterseth commented Jun 21, 2022 •

edited

Loading

Cl0udius Jun 23, 2022 •

edited

Loading