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

Implementation of new conf flag AutoUpdate.UpdateToLatestVersion support #3027

Merged
merged 11 commits into from
Feb 6, 2024
Merged

Implementation of new conf flag AutoUpdate.UpdateToLatestVersion support #3027

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
adb897c
GA update to latest version flag
nagworld9 Jan 17, 2024
d214aa5
address comments
nagworld9 Jan 23, 2024
8982384
resloving comments
nagworld9 Jan 30, 2024
fd34c0c
added TODO
nagworld9 Jan 30, 2024
68ac618
ignore warning
nagworld9 Jan 31, 2024
4b94769
resolving comment
nagworld9 Feb 1, 2024
5c0f4d2
address comments
nagworld9 Feb 2, 2024
5261a63
config present check
nagworld9 Feb 2, 2024
6d6ccd5
added a comment
nagworld9 Feb 2, 2024
41fbdc3
Merge branch 'develop' into updateflag
nagworld9 Feb 5, 2024
b526bda
Merge branch 'develop' into updateflag
nagworld9 Feb 6, 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
4 changes: 2 additions & 2 deletions azurelinuxagent/common/agent_supported_feature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,15 @@ def __init__(self):

class _GAVersioningGovernanceFeature(AgentSupportedFeature):
"""
CRP would drive the RSM upgrade version if agent reports that it does support RSM upgrades with this flag otherwise CRP fallback to largest version.
CRP would drive the RSM update if agent reports that it does support RSM upgrades with this flag otherwise CRP fallback to largest version.
Agent doesn't report supported feature flag if auto update is disabled or old version of agent running that doesn't understand GA versioning.

Note: Especially Windows need this flag to report to CRP that GA doesn't support the updates. So linux adopted same flag to have a common solution.
"""

__NAME = SupportedFeatureNames.GAVersioningGovernance
__VERSION = "1.0"
__SUPPORTED = conf.get_autoupdate_enabled()
__SUPPORTED = conf.get_auto_update_to_latest_version()

def __init__(self):
super(_GAVersioningGovernanceFeature, self).__init__(name=self.__NAME,
Expand Down
25 changes: 17 additions & 8 deletions azurelinuxagent/common/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ def load_conf_from_file(conf_file_path, conf=__conf__):
"ResourceDisk.EnableSwap": False,
"ResourceDisk.EnableSwapEncryption": False,
"AutoUpdate.Enabled": True,
"AutoUpdate.UpdateToLatestVersion": True,
"EnableOverProvisioning": True,
#
# "Debug" options are experimental and may be removed in later
Expand All @@ -136,7 +137,6 @@ def load_conf_from_file(conf_file_path, conf=__conf__):
"Debug.CgroupLogMetrics": False,
"Debug.CgroupDisableOnProcessCheckFailure": True,
"Debug.CgroupDisableOnQuotaCheckFailure": True,
"Debug.DownloadNewAgents": True,
"Debug.EnableAgentMemoryUsageCheck": False,
"Debug.EnableFastTrack": True,
"Debug.EnableGAVersioning": True
Expand Down Expand Up @@ -228,6 +228,11 @@ def get_switch_default_value(option):
raise ValueError("{0} is not a valid configuration parameter.".format(option))


def get_switch_no_default_value(key, conf=__conf__):
# If specified, return the value else return None
return conf.get_switch(key, None)

Copy link
Member

Choose a reason for hiding this comment

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

this function feels a little weird, doesn't it?

Maybe

    def is_present(self, key):
        """
        Returns True if the given flag is present in the config file.
        """
        return self.values.get(key) is not None

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated


def enable_firewall(conf=__conf__):
return conf.get_switch("OS.EnableFirewall", False)

Expand Down Expand Up @@ -503,15 +508,19 @@ def get_monitor_network_configuration_changes(conf=__conf__):
return conf.get_switch("Monitor.NetworkConfigurationChanges", False)


def get_download_new_agents(conf=__conf__):
def get_auto_update_to_latest_version(conf=__conf__):
"""
If True, the agent go through update logic to look for new agents to download otherwise it will stop agent updates.
NOTE: AutoUpdate.Enabled controls whether the Agent downloads new update and also whether any downloaded updates are started or not, while DownloadNewAgents controls only the former.
AutoUpdate.Enabled == false -> Agent preinstalled on the image will process extensions and will not update (regardless of DownloadNewAgents flag)
AutoUpdate.Enabled == true and DownloadNewAgents == true, any update already downloaded will be started, and agent look for future updates
AutoUpdate.Enabled == true and DownloadNewAgents == false, any update already downloaded will be started, but the agent will not look for future updates
If set to True, agent will update to the latest version
Copy link
Member

Choose a reason for hiding this comment

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

we should add unit tests that codify these rules: use all combinations of y/n/absent for both flags and check the return value of UpdateToLatestVersion

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

NOTE:
when both turned on, both AutoUpdate.Enabled and AutoUpdate.UpdateToLatestVersion same meaning: update to latest version
when turned off, AutoUpdate.Enabled: reverts to pre-installed agent, AutoUpdate.UpdateToLatestVersion: uses latest version already installed on the vm and does not download new agents
Even we are deprecating AutoUpdate.Enabled, we still need to support if users explicitly setting it instead new flag.
If AutoUpdate.UpdateToLatestVersion is present, it overrides any value set for AutoUpdate.Enabled (if present).
If AutoUpdate.UpdateToLatestVersion is not present but AutoUpdate.Enabled is present and set to 'n', we adhere to AutoUpdate.Enabled flag's behavior
if both not present, we default to True.
"""
return conf.get_switch("Debug.DownloadNewAgents", True)
default = get_autoupdate_enabled(conf=conf)
return conf.get_switch("AutoUpdate.UpdateToLatestVersion", default)


def get_cgroup_check_period(conf=__conf__):
Expand Down
4 changes: 2 additions & 2 deletions azurelinuxagent/ga/agent_update_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ def _get_agent_family_manifest(self, goal_state):
def run(self, goal_state, ext_gs_updated):

try:
# Ignore new agents if update is disabled. The latter flag only used in e2e tests.
if not conf.get_autoupdate_enabled() or not conf.get_download_new_agents():
# If auto update is disabled, we don't proceed with update
if not conf.get_auto_update_to_latest_version():
return

# Update the state only on new goal state
Expand Down
7 changes: 7 additions & 0 deletions azurelinuxagent/ga/update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,13 @@ def log_if_agent_versioning_feature_disabled():
log_if_op_disabled("OS.EnableFirewall", conf.enable_firewall())
log_if_op_disabled("Extensions.Enabled", conf.get_extensions_enabled())
log_if_op_disabled("AutoUpdate.Enabled", conf.get_autoupdate_enabled())
log_if_op_disabled("AutoUpdate.UpdateToLatestVersion", conf.get_auto_update_to_latest_version())

auto_update_enabled = conf.get_switch_no_default_value("AutoUpdate.Enabled")
if auto_update_enabled is not None and auto_update_enabled != conf.get_auto_update_to_latest_version():
msg = "AutoUpdate.Enabled property is **Deprecated** now but it's set to different value from AutoUpdate.UpdateToLatestVersion. Please consider removing it if added by mistake"
logger.warn(msg)
add_event(AGENT_NAME, op=WALAEventOperation.ConfigurationChange, message=msg)

if conf.enable_firewall():
log_if_int_changed_from_default("OS.EnableFirewallPeriod", conf.get_enable_firewall_period())
Expand Down
6 changes: 5 additions & 1 deletion config/alpine/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,11 @@ OS.OpensslPath=None
OS.SshDir=/etc/ssh

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# TODO: Update the wiki link and point to readme page or public facing doc
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ideally, I want to point to readme link for flag definition but those changes not there in master yet

# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/arch/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ OS.SshDir=/etc/ssh
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/bigip/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,10 @@ OS.SshdConfigPath=/config/ssh/sshd_config
OS.EnableRDMA=n

# Enable or disable goal state processing auto-update, default is enabled
AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
8 changes: 6 additions & 2 deletions config/clearlinux/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,12 @@ OS.OpensslPath=None
# Set the path to SSH keys and configuration files
OS.SshDir=/etc/ssh

# Enable or disable self-update, default is enabled
AutoUpdate.Enabled=y
# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

AutoUpdate.GAFamily=Prod

# Determine if the overprovisioning feature is enabled. If yes, hold extension
Expand Down
5 changes: 4 additions & 1 deletion config/coreos/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,10 @@ OS.OpensslPath=None
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/debian/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,10 @@ OS.SshDir=/etc/ssh
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/devuan/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,10 @@ OS.SshDir=/etc/ssh
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/freebsd/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,10 @@ OS.SudoersDir=/usr/local/etc/sudoers.d
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
7 changes: 7 additions & 0 deletions config/gaia/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,15 @@ OS.SshDir=/etc/ssh
OS.EnableRDMA=n

# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it reverts to the pre-installed agent that comes with image
# AutoUpdate.Enabled is a legacy parameter used only for backwards compatibility. We encourage users to transition to new option AutoUpdate.UpdateToLatestVersion
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
AutoUpdate.Enabled=n

# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it remains on latest version installed on the vm
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod

Expand Down
5 changes: 4 additions & 1 deletion config/iosxe/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ OS.SshDir=/etc/ssh
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
8 changes: 6 additions & 2 deletions config/mariner/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,12 @@ OS.OpensslPath=None
# Set the path to SSH keys and configuration files
OS.SshDir=/etc/ssh

# Enable or disable self-update, default is enabled
AutoUpdate.Enabled=y
# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

AutoUpdate.GAFamily=Prod

# Determine if the overprovisioning feature is enabled. If yes, hold extension
Expand Down
7 changes: 7 additions & 0 deletions config/nsbsd/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,15 @@ Extension.LogDir=/log/azure
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it reverts to the pre-installed agent that comes with image
# AutoUpdate.Enabled is a legacy parameter used only for backwards compatibility. We encourage users to transition to new option AutoUpdate.UpdateToLatestVersion
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
AutoUpdate.Enabled=n

# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it remains on latest version installed on the vm
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod

Expand Down
5 changes: 4 additions & 1 deletion config/openbsd/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,10 @@ OS.PasswordPath=/etc/master.passwd
# OS.EnableRDMA=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
8 changes: 6 additions & 2 deletions config/photonos/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,12 @@ OS.OpensslPath=None
# Set the path to SSH keys and configuration files
OS.SshDir=/etc/ssh

# Enable or disable self-update, default is enabled
AutoUpdate.Enabled=y
# Enable or disable goal state processing auto-update, default is enabled
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

AutoUpdate.GAFamily=Prod

# Determine if the overprovisioning feature is enabled. If yes, hold extension
Expand Down
5 changes: 4 additions & 1 deletion config/suse/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,10 @@ OS.SshDir=/etc/ssh
# OS.CheckRdmaDriver=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/ubuntu/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,10 @@ OS.SshDir=/etc/ssh
# OS.CheckRdmaDriver=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
5 changes: 4 additions & 1 deletion config/waagent.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,10 @@ OS.SshDir=/etc/ssh
# OS.CheckRdmaDriver=y

# Enable or disable goal state processing auto-update, default is enabled
# AutoUpdate.Enabled=y
# When turned off, it remains on latest version installed on the vm
# Added this new option AutoUpdate.UpdateToLatestVersion in place of AutoUpdate.Enabled, and encourage users to transition to this new option
# See wiki[https://github.com/Azure/WALinuxAgent/wiki/FAQ#autoupdateenabled-vs-autoupdateupdatetolatestversion] for more details
# AutoUpdate.UpdateToLatestVersion=y

# Determine the update family, this should not be changed
# AutoUpdate.GAFamily=Prod
Expand Down
Loading
Loading