python-chi 1.0.2__tar.gz → 1.0.4__tar.gz

python_chi-1.0.4/ChangeLog

@@ -0,0 +1,7 @@
+CHANGES
+=======
+
+v1.0.4
+------
+
+* Fix container download python version compatibility

{python_chi-1.0.2 → python_chi-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-chi
-Version: 1.0.2
+Version: 1.0.4
 Summary: Helper library for Chameleon Infrastructure (CHI) testbed
 Home-page: https://www.chameleoncloud.org
 Author: University of Chicago

{python_chi-1.0.2 → python_chi-1.0.4}/chi/container.py

@@ -515,7 +515,8 @@ def download(container_ref: "str", source: "str", dest: "str"):
     res = zun().containers.get_archive(container_ref, source)
     fd = io.BytesIO(res["data"])
     with tarfile.open(fileobj=fd, mode="r") as tar:
-        tar.extractall(dest, filter="fully_trusted")
+        tar.extraction_filter = (lambda member, path: member)
+        tar.extractall(dest)
 
 
 def wait_for_active(container_ref: "str", timeout: int = (60 * 2)) -> "Container":

{python_chi-1.0.2 → python_chi-1.0.4}/chi/hardware.py

@@ -53,7 +53,7 @@ class Node:
 
         def get_host_id(items, target_uid):
             for item in items:
-                if item.get("uid") == target_uid:
+                if item.get("uid") == target_uid or item.get("hypervisor_hostname") == target_uid:
                     return item["id"]
             return None
 
@@ -62,6 +62,8 @@ class Node:
         # Get allocation for this specific host
         host_id = get_host_id(blazarclient.host.list(), self.uid)
 
+        if not host_id:
+            raise exception.ServiceError(f"Host for {self.uid} not found in Blazar")
         allocation = blazarclient.host.get_allocation(host_id)
 
         now = datetime.now(timezone.utc)

{python_chi-1.0.2 → python_chi-1.0.4}/chi/network.py

@@ -187,6 +187,13 @@ def list_networks() -> "list[dict]":
     return neutron().list_networks()["networks"]
 
 
+def set_network_tag(network_id, value):
+    _neutron = neutron()
+    _neutron.replace_tag('networks', network_id, {
+        'tags': [value]
+    })
+
+
 ##########
 # Subnets
 ##########
@@ -638,6 +645,20 @@ def remove_subnet_from_router(router_id, subnet_id):
 # Floating IPs
 ###############
 
+def set_floating_ip_tag(address, value):
+    ip_addr = get_floating_ip(address)
+    _neutron = neutron()
+    _neutron.replace_tag('floatingips', ip_addr['id'], {
+        'tags': [value]
+    })
+
+
+def deallocate_floating_ip(address):
+    _neutron = neutron()
+    _neutron.delete_floatingip(
+        get_floating_ip(address)["id"]
+    )
+
 
 def get_free_floating_ip(allocate=True) -> dict:
     """Get the first unallocated floating IP available to your project.

{python_chi-1.0.2 → python_chi-1.0.4}/chi/server.py

@@ -155,6 +155,7 @@ class Server:
         wait_for_active: bool = True,
         show: str = "widget",
         idempotent: bool = False,
+        **kwargs,
     ) -> "Server":
         """
         Submits a server creation request to the Nova API.
@@ -187,6 +188,7 @@ class Server:
             flavor=self.flavor_name,
             key=self.keypair.name,
             net_ids=[get_network_id(DEFAULT_NETWORK)],
+            **kwargs,
         )
         try:
             nova_server = self.conn.compute.create_server(**server_args)
@@ -274,6 +276,8 @@ class Server:
         return server
 
     def delete(self) -> None:
+        """Deletes the server.
+        """
         delete_server(self.id)
 
     def refresh(self):
@@ -422,7 +426,7 @@ class Server:
 
     def associate_floating_ip(self, fip: Optional[str] = None) -> None:
         """
-        Associates a floating IP with the server. (BROKEN)
+        Associates a floating IP with the server.
 
         Args:
             fip (str, optional): The floating IP to associate with the server. If not provided, a new floating IP will be allocated.
@@ -435,7 +439,7 @@ class Server:
 
     def detach_floating_ip(self, fip: str) -> None:
         """
-        Detaches a floating IP from the server. (BROKEN)
+        Detaches a floating IP from the server.
 
         Args:
             fip (str): The floating IP to detach.
@@ -562,6 +566,11 @@ class Server:
         with self.ssh_connection(**kwargs) as conn:
             return conn.run(command)
 
+    def get_metadata(self):
+        return nova().servers.list_meta(self.id)["metadata"]
+
+    def set_metadata_item(self, key, value):
+        return nova().servers.set_meta_item(self.id, key, value)
 
 ##########
 # Flavors

{python_chi-1.0.2 → python_chi-1.0.4}/chi/util.py

@@ -36,6 +36,17 @@ def utcnow():
     return datetime.now(tz=tz.tzutc())
 
 
+def date_string_in_future(days=1):
+    return (utcnow() + timedelta(days=days)).isoformat()
+
+
+def should_delete(delete_at):
+    try:
+        return datetime.fromisoformat(delete_at) < utcnow()
+    except ValueError:
+        return False
+
+
 class TimerProgressBar:
     def __init__(self):
         self.progress = widgets.IntProgress(

python_chi-1.0.4/docs/examples.rst

@@ -0,0 +1,92 @@
+===================
+Python-chi Examples
+===================
+
+.. _examples:
+
+Cleanup Non-leased Resources
+============================
+
+
+Opt-in Cleanup using tags
+-------------------------
+
+While baremetal nodes on Chameleon require leases, other resources like networks, and KVM instances
+are persistent, and require manual cleanup. For large projects (e.g. for educational courses), it
+may be useful to have some automatic process to clean up resources after a certain time. Below is
+a suggested method for managing this. First, when creating the resource, or to prolong the resource,
+you can set a "delete_at" tag. This is simply an date string in the future, which can be checked.
+
+.. code-block:: python
+
+  # Set a Server metadata item, which will be read leader
+  my_server.set_metadata_item("delete_at", util.date_string_in_future(days=3))
+
+  # Similarly, use "tag" for network or floating ip
+  network.set_floating_ip_tag(MY_FIP_ADDRESS, f"delete_at={util.date_string_in_future(days=3)}")
+  network.set_network_tag(MY_NETWORK_ID, f"delete_at={util.date_string_in_future(days=3)}")
+
+Then run the following script. You'll need to set authentication variables (e.g. source an openrc file),
+and set the site/project at the beginning. This script iterates over the resources in your project, and
+deletes them if the "delete_at" tag is in the past, if the user manually enters "yes" to confirm.
+You can remove this confirmation in order to automatically run periodically with e.g. cron. 
+
+.. code-block:: python
+
+  from chi import util, server, network
+
+  # Find servers with "delete_at" metadata
+  for s in server.list_servers():
+    if util.should_delete(my_servers.get_metadata().get("delete_at", "")):
+      confirm = input(f"Delete server {s.name}? (yes/no): ").strip().lower()
+      if confirm == "yes":
+        s.delete()
+
+  # Networks, FIP tags set via tags as a string
+  for net in network.list_networks():
+    try:
+      delete_tag = next(s for s in net["tags"] if s.startswith("delete_at="))
+      if util.should_delete(delete_tag.split("=")[1]):
+        confirm = input(f"Delete the network {net['name']}? (yes/no): ").strip().lower()
+        if confirm == "yes":
+          # nuke_network deletes subnets, routers, and the network itself
+          network.nuke_network(net_id)
+    except StopIteration:
+      pass
+
+  for fip in network.list_floating_ips():
+    try:
+      delete_tag = next(s for s in fip["tags"] if s.startswith("delete_at="))
+      if util.should_delete(delete_tag.split("=")[1]):
+        confirm = input(f"Delete the floating ip {fip['floating_ip_address']}? (yes/no): ").strip().lower()
+        if confirm == "yes":
+          network.deallocate_floating_ip(fip["floating_ip_address"])
+    except StopIteration:
+      pass
+
+Opt-in Cleanup using `created_at`
+---------------------------------
+
+The above examples are explicitly opt-in, requring the user to set the "delete_at" tag to ensure that
+nothing is deleted unknowlingly. Alternatively, you can monitor the "created_at" field of resources to
+check for long-running resources such as in the following example.
+
+.. code-block:: python
+
+  from datetime import datetime, timedelta
+  from chi import util, server, network
+
+  MAX_AGE = 3  # days
+  for s in server.list_servers():
+      age = util.utcnow() - datetime.fromisoformat(s.created_at)
+      if age > timedelta(days=MAX_AGE):
+        confirm = input(f"Delete server {s.name}? Age is {age}. (yes/no): ").strip().lower()
+        if confirm == "yes":
+          s.delete()
+  for net in network.list_networks():
+      age = util.utcnow() - datetime.fromisoformat(net["created_at"])
+      if age > timedelta(days=MAX_AGE):
+        confirm = input(f"Delete the network {net['name']}? Age is {age}. (yes/no): ").strip().lower()
+        if confirm == "yes":
+          # nuke_network deletes subnets, routers, and the network itself
+          network.nuke_network(net_id)

{python_chi-1.0.2 → python_chi-1.0.4}/docs/index.rst

@@ -61,6 +61,9 @@ For more details about the modules available refer to their respective pages.
   chi.lease.create_lease(
       lease_name, reservations, start_date=start_date, end_date=end_date)
 
+For further examples, see the `examples <examples>`_ section.
+
+
 Versions
 ========
 In python-chi version 1.0, we've deprecated older versions of functions that return
@@ -103,7 +106,8 @@ version of python-chi, this will no longer be needed.
 .. toctree::
    :caption: Examples
    :glob:
-
+   
+   examples
    notebooks/*
 
 

{python_chi-1.0.2 → python_chi-1.0.4}/python_chi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-chi
-Version: 1.0.2
+Version: 1.0.4
 Summary: Helper library for Chameleon Infrastructure (CHI) testbed
 Home-page: https://www.chameleoncloud.org
 Author: University of Chicago

{python_chi-1.0.2 → python_chi-1.0.4}/python_chi.egg-info/SOURCES.txt

@@ -33,6 +33,7 @@ chi/storage.py
 chi/util.py
 docs/__init__.py
 docs/conf.py
+docs/examples.rst
 docs/generate_notebook.py
 docs/index.rst
 docs/requirements.txt

python_chi-1.0.4/python_chi.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "fa6238a", "is_release": false}

{python_chi-1.0.2 → python_chi-1.0.4}/setup.py

@@ -5,5 +5,5 @@ from setuptools import setup
 setup(
     setup_requires=["pbr"],
     pbr=True,
-    version='v1.0.2'
+    version='v1.0.4'
 )

python_chi-1.0.2/ChangeLog

@@ -1,7 +0,0 @@
-CHANGES
-=======
-
-v1.0.2
-------
-
-* Add check for amount when using node\_type

python_chi-1.0.2/python_chi.egg-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "b0c1918", "is_release": false}