Merge remote-tracking branch 'origin/main' into tests/test-purge-openstack-resources

Author: JohnGarbutt

.github/dependabot.yml

@@ -23,6 +23,12 @@ updates:
     schedule:
       # Check for new versions daily
       interval: daily
+    groups:
+      pip-updates:
+        patterns: ["*"]
     labels:
       - automation
       - pip-update
+    commit-message:
+    # Prefix all commit messages with "pip: "
+      prefix: "pip"

.github/workflows/test-pr.yaml

@@ -73,11 +73,11 @@ jobs:
       - name: Provision Azimuth
         uses: azimuth-cloud/azimuth-config/.github/actions/provision@devel
 
-      # # Run the tests
+      # Run the tests
       - name: Run Azimuth tests
         uses: azimuth-cloud/azimuth-config/.github/actions/test@devel
 
-      # Tear down the environment
+      # Tear down the environment
       - name: Destroy Azimuth
         uses: azimuth-cloud/azimuth-config/.github/actions/destroy@devel
         if: ${{ always() }}

Dockerfile

@@ -8,10 +8,10 @@ RUN python3 -m venv /venv && \
     /venv/bin/pip install -U pip setuptools
 
 COPY requirements.txt /app/requirements.txt
-RUN  /venv/bin/pip install --no-deps --requirement /app/requirements.txt
+RUN  /venv/bin/pip install --requirement /app/requirements.txt
 
 COPY . /app
-RUN /venv/bin/pip install --no-deps /app
+RUN /venv/bin/pip install /app
 
 
 FROM ubuntu:jammy

README.md

@@ -56,6 +56,21 @@ metadata:
 
 > **NOTE**: Any value other than `delete` means volumes will be kept.
 
+### User-configurable behaviour
+
+Annotations on the Kubernetes resources are only available to administrators with
+access to the Cluster API management cluster's Kubernetes API; therefore, the Janitor
+also provides an alternative user-facing mechanism for marking volumes which should
+not be deleted during cluster clean up. This is done by adding a property to the
+OpenStack volume using:
+
+```
+openstack volume set --property janitor.capi.azimuth-cloud.com/keep='true' <volume-name-or-id>
+```
+
+Any value other than 'true' will result in the volume being deleted when the workload
+cluster is deleted.
+
 ## How it works
 
 `cluster-api-janitor-openstack` watches for `OpenStackCluster`s being created and adds its
@@ -66,7 +81,7 @@ Cluster API `Cluster`, from being removed until the finalizer is removed.
 (specifically, it waits for the `deletionTimestamp` to be set, indicating that a deletion
 has been requested), at which point it uses the credential from
 `OpenStackCluster.spec.identityRef` to remove any dangling resources that were created by
-the OCCM or Cinder CSI with the same cluster name as the cluster being deleted. 
+the OCCM or Cinder CSI with the same cluster name as the cluster being deleted.
 The cluster name is determined by the `cluster.x-k8s.io/cluster-name` label on the
 OpenStackCluster resource, if present.
 If the label is not set, the name of the OpenStackCluster resource (`metadata.name`) is

capi_janitor/__init__.py

@@ -9,36 +9,28 @@
 
 
 class UnsupportedAuthenticationError(Exception):
-    """
-    Raised when an unsupported authentication method is used.
-    """
+    """Raised when an unsupported authentication method is used."""
 
     def __init__(self, auth_type):
         super().__init__(f"unsupported authentication type: {auth_type}")
 
 
 class AuthenticationError(Exception):
-    """
-    Raised when an unknown authentication error is encountered.
-    """
+    """Raised when an unknown authentication error is encountered."""
 
     def __init__(self, user):
         super().__init__(f"failed to authenticate as user: {user}")
 
 
 class CatalogError(Exception):
-    """
-    Raised when an unknown catalog service type is requested.
-    """
+    """Raised when an unknown catalog service type is requested."""
 
     def __init__(self, name):
         super().__init__(f"service type {name} not found in OpenStack service catalog")
 
 
 class Auth(httpx.Auth):
-    """
-    Authenticator class for OpenStack connections.
-    """
+    """Authenticator class for OpenStack connections."""
 
     def __init__(
         self, auth_url, application_credential_id, application_credential_secret
@@ -52,8 +44,9 @@ def __init__(
 
     @contextlib.asynccontextmanager
     async def _refresh_token(self):
-        """
-        Context manager to ensure only one request at a time triggers a token refresh.
+        """Context manager to ensure only one request at a time
+
+        triggers a token refresh.
         """
         token = self._token
         async with self._lock:
@@ -95,9 +88,7 @@ async def async_auth_flow(self, request):
 
 
 class Resource(rest.Resource):
-    """
-    Base resource for OpenStack APIs.
-    """
+    """Base resource for OpenStack APIs."""
 
     def __init__(self, client, name, prefix=None, plural_name=None, singular_name=None):
         super().__init__(client, name, prefix)
@@ -140,9 +131,7 @@ def _extract_one(self, response):
 
 
 class Client(rest.AsyncClient):
-    """
-    Client for OpenStack APIs.
-    """
+    """Client for OpenStack APIs."""
 
     def __init__(self, /, base_url, prefix=None, **kwargs):
         # Extract the path part of the base_url
@@ -173,9 +162,7 @@ def resource(self, name, prefix=None, plural_name=None, singular_name=None):
 
 
 class Cloud:
-    """
-    Object for interacting with OpenStack clouds.
-    """
+    """Object for interacting with OpenStack clouds."""
 
     def __init__(self, auth, transport, interface, region=None):
         self._auth = auth
@@ -219,29 +206,21 @@ async def __aexit__(self, exc_type, exc_value, traceback):
 
     @property
     def is_authenticated(self):
-        """
-        Returns True if the cloud is authenticated, False otherwise.
-        """
+        """Returns True if the cloud is authenticated, False otherwise."""
         return bool(self._endpoints)
 
     @property
     def current_user_id(self):
-        """
-        The ID of the current user.
-        """
+        """The ID of the current user."""
         return self._auth._user_id
 
     @property
     def apis(self):
-        """
-        The APIs supported by the cloud.
-        """
+        """The APIs supported by the cloud."""
         return list(self._endpoints.keys())
 
     def api_client(self, name, prefix=None):
-        """
-        Returns a client for the named API.
-        """
+        """Returns a client for the named API."""
         if name not in self._clients:
             self._clients[name] = Client(
                 base_url=self._endpoints[name],