Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding AutoUpdate.UpdateToLatestVersion new flag support #3020

Merged
merged 8 commits into from
Feb 5, 2024
Merged

Adding AutoUpdate.UpdateToLatestVersion new flag support #3020

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4d3e7f6
support new flag
nagworld9 Jan 12, 2024
5f4753d
address comments
nagworld9 Jan 17, 2024
45f4d0e
added more info
nagworld9 Jan 18, 2024
04f5ee4
updated
nagworld9 Jan 19, 2024
b7288d4
address comments
nagworld9 Jan 30, 2024
f459a75
resolving comment
nagworld9 Feb 1, 2024
19bfb7e
updated
nagworld9 Feb 1, 2024
69096a4
Merge branch 'develop' into newflag-readme
nagworld9 Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,19 +273,38 @@ _Note_: setting up this parameter to more than a few minutes can make the state
the VM be reported as unresponsive/unavailable on the Azure portal. Also, this
setting affects how fast the agent starts executing extensions.

#### __AutoUpdate.Enabled__
#### __AutoUpdate.UpdateToLatestVersion__

_Type: Boolean_
_Type: Boolean_
_Default: y_

Enables auto-update of the Extension Handler. The Extension Handler is responsible
for managing extensions and reporting VM status. The core functionality of the agent
is contained in the Extension Handler, and we encourage users to enable this option
in order to maintain an up to date version.

On most distros the default value is 'y'.
_Note_:
1. This option becomes effective from version 2.10.0.8 onwards.
2. If AutoUpdate.UpdateToLatestVersion is present, it overrides any value set for AutoUpdate.Enabled (if present).
3. If AutoUpdate.Enabled is present and set to 'n', we adhere to AutoUpdate.Enabled flag's behavior. Refer to the definition of _AutoUpdate.Enabled_ for additional details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I read this it looks like #3 conflicts with #2
In 2 we say that AutoUpdate.Enabled will be ignored no matter its value if AutoUpdate.UpdateToLatestVersion is present.
In 3 we say that if AutoUpdate.Enabled=n we will ignore AutoUpdate.UpdateToLatestVersion.

These two seem to be conflicting

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 2, we already said if AutoUpdate.UpdateToLatestVersion is present. so, 3 is for if it not present. If that's not communicating, let make that clear.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, yes could we add that clarification to 3

4. If AutoUpdate.UpdateToLatestVersion is set to 'n', it will use the most recent version that has already been installed on the VM.
5. If AutoUpdate.Enabled is set to 'y', new VMs created from marketplace images(if they ship with lower version than 2.10.0.8) will promptly update to the latest Extension Handler version, irrespective of this option.
6. Waagent has a built-in mechanism; if the current version running is unstable, it will roll back to previous versions. If those rollback versions are lower than 2.10.0.8, then they _may_ not support this option, and they will not honor this setting
7. Changing config option requires a service restart to pick up the updated setting.

For more information on the agent version, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#what-does-goal-state-agent-mean-in-waagent---version-output). <br/>
For more information on the agent update, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#how-auto-update-works-for-extension-handler). <br/>
For more information on the AutoUpdate.UpdateToLatestVersion vs AutoUpdate.Enabled, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion). <br/>

#### __AutoUpdate.Enabled__

For more information on the agent version, see our [FAQ](https://github.com/Azure/WALinuxAgent/wiki/FAQ#what-does-goal-state-agent-mean-in-waagent---version-output).
_Type: Boolean_
_Default: y_

Enables auto-update of the Extension Handler. This flag is supported for legacy reasons and we strongly recommend using AutoUpdate.UpdateToLatestVersion instead.
The difference between these 2 flags is that, when set to 'n', AutoUpdate.Enabled will use the version of the Extension Handler that is pre-installed on the image, while AutoUpdate.UpdateToLatestVersion will use the most recent version that has already been installed on the VM (via auto-update).

On most distros the default value is 'y'.

#### __Provisioning.Agent__

Expand Down
Loading