Merge ~mitchdz/ubuntu/+source/hibagent:mitch/mantic-imdsv2 into ubuntu/+source/hibagent:ubuntu/mantic-devel

[Mitchell Dzurick]

PPA - https://launchpad.net/~mitchdz/+archive/ubuntu/hibagent-imdsv2

diff --git a/debian/changelog b/debian/changelog
index 3c8851c..62608ce 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,12 @@
+hibagent (1.0.1+git20230216.9ac1209f7-0ubuntu1.23.10.1) mantic; urgency=medium
+
+  * d/p/do-nothing-if-ODH-is-configured.patch: do nothing if ODH is configured,
+    this fixes an issue when this package and ec2-hibinit-agent are installed
+    and configured at the same time (LP: #2043739).
+  * d/control: add python3-requests as Depends.
+
+ -- Mitchell Dzurick <[e-mail]>  Thu, 16 Nov 2023 15:35:33 -0700
+
 hibagent (1.0.1+git20230216.9ac1209f7-0ubuntu1) lunar; urgency=medium
 
   * New upstream snapshot from their `ubuntu` branch (LP: #1896638)
diff --git a/debian/control b/debian/control
index 60fac58..eb13a13 100644
--- a/debian/control
+++ b/debian/control
@@ -7,6 +7,7 @@ Build-Depends: debhelper (>= 9),
                dh-python,
                python3-all,
                python3-pytest,
+               python3-requests,
                python3-setuptools
 Standards-Version: 3.9.6
 
diff --git a/debian/patches/do-nothing-if-ODH-is-configured.patch b/debian/patches/do-nothing-if-ODH-is-configured.patch
 new file mode 100644
index 0000000..8be4ec2
--- /dev/null
+++ b/debian/patches/do-nothing-if-ODH-is-configured.patch
@@ -0,0 +1,77 @@
+Description: Update the Spot hibernate agent to do nothing if ODH is configured
+Author: Jeongin Cho <[e-mail]>
+Origin: upstream, https://github.com/aws/ec2-hibernate-linux-agent/commit/2ee4ae3fd1333fb3c9aab25bf02b109c3b7b8d9f
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/hibagent/+bug/2043739
+Last-Update: 2023-11-16
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- a/agent/hibagent
++++ b/agent/hibagent
+@@ -18,6 +18,7 @@
+ import struct
+ import sys
+ import syslog
++import requests
+ from subprocess import check_call, check_output
+ from threading import Thread
+ from math import ceil
+@@ -39,6 +40,9 @@
+ log_to_syslog = True
+ log_to_stderr = True
+ 
++IMDS_BASEURL = 'http://169.254.169.254'
++IMDS_API_TOKEN_PATH = 'latest/api/token'
++IMDS_SPOT_ACTION_PATH = 'latest/meta-data/hibernation/configured'
+ 
+ def log(message):
+     if log_to_syslog:
+@@ -511,6 +515,37 @@
+         log("Failed to adjust pm_freeze_timeout to %d. Error: %s" % (timeout, str(e)))
+         exit(1)
+ 
++def get_imds_token(seconds=21600):
++    """ Get a token to access instance metadata. """
++    log("Requesting new IMDSv2 token.")
++    request_header = {'X-aws-ec2-metadata-token-ttl-seconds': '{}'.format(seconds)}
++    token_url = '{}/{}'.format(IMDS_BASEURL, IMDS_API_TOKEN_PATH)
++    response = requests.put(token_url, headers=request_header)
++    response.close()
++    if response.status_code != requests.codes.ok:
++        return None
++
++    return response.text
++
++def hibernation_enabled():
++    """Returns a boolean indicating whether hibernation-option.configured is enabled or not."""
++
++    imds_token = get_imds_token()
++    if imds_token is None:
++        log("IMDS_V2 http endpoint is disabled")
++        # IMDS http endpoint is disabled
++        return False
++
++    request_header = {'X-aws-ec2-metadata-token': imds_token}
++    response = requests.get("{}/{}".format(IMDS_BASEURL, IMDS_SPOT_ACTION_PATH),
++                 headers=request_header)
++    response.close()
++    if response.status_code != requests.codes.ok or response.text.lower() == "false":
++        return False
++
++    log("Hibernation Configured Flag found")
++
++    return True
+ 
+ def main():
+     # Parse arguments
+@@ -550,6 +585,11 @@
+ 
+     log("Effective config: %s" % config)
+ 
++    # Let's first check if we need to kill the Spot Hibernate Agent
++    if hibernation_enabled():
++        log("Spot Instance Launch has enabled Hibernation Configured Flag. hibagent exiting!!")
++        exit(0)
++
+     target_swap_size = config.swap_mb * 1024 * 1024
+     ram_bytes = os.sysconf('SC_PAGE_SIZE') * os.sysconf('SC_PHYS_PAGES')
+     swap_percentage_size = ram_bytes * config.swap_percentage // 100
diff --git a/debian/patches/series b/debian/patches/series
index 5568008..0b9774f 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -9,3 +9,4 @@ fix-enable-ec2-spot-hibernation.patch
 0009-Use-Thread.is_alive-for-Python-3.9-compatibility.patch
 setuptools-fix-package-discovery.patch
 disable-hibernate-test.patch
+do-nothing-if-ODH-is-configured.patch