Merge pull request #499 from rackerlabs/nova-flavor-monitor

feat: configure flavors in Nova automatically

.github/workflows/containers.yaml

@@ -116,6 +116,7 @@ jobs:
       matrix:
         container:
           - name: ironic-nautobot-client
+          - name: nova-flavors
 
     steps:
       - name: setup docker buildx

components/keystone/aio-values.yaml

@@ -19,6 +19,11 @@ bootstrap:
     # give 'argoworkflow' 'admin' over the 'baremetal' project
     openstack role add --user-domain infra --project-domain infra --user argoworkflow --project baremetal admin
 
+    # create 'flavorsync' user to allow synchronization of the flavors to nova
+    openstack user create --or-show --domain service --password abcd1234 flavorsync
+    openstack role create --or-show flavorsync
+    openstack role add --user flavorsync --user-domain service --domain default --inherited  flavorsync
+
     # create 'monitoring' user for monitoring usage
     openstack user create --or-show --domain infra --password monitoring_demo monitoring
     # give 'monitoring' the 'admin' over the 'baremetal' project

containers/nova-flavors/Dockerfile.nova-flavors

@@ -0,0 +1,35 @@
+FROM ghcr.io/rackerlabs/understack/argo-python3.12.2-alpine3.19 AS builder
+
+RUN --mount=type=cache,target=/var/cache/apk apk add --virtual build-deps gcc python3-dev musl-dev linux-headers
+RUN --mount=type=cache,target=/root/.cache/.pip pip install 'wheel==0.43.0'
+RUN --mount=type=cache,target=/root/.cache/.pip \
+    python -m venv /opt/poetry && \
+    /opt/poetry/bin/pip install 'poetry==1.7.1' && \
+    /opt/poetry/bin/poetry self add 'poetry-dynamic-versioning[plugin]==1.3.0'
+
+# copy in the code
+COPY --chown=appuser:appgroup operators/nova-flavors /app
+COPY --chown=appuser:appgroup python/understack-flavor-matcher /understack-flavor-matcher
+# need watchdog and psutil built AS a wheel
+RUN --mount=type=cache,target=/root/.cache/.pip pip wheel --wheel-dir /app/dist watchdog psutil
+CMD ["nova-flavors-sync"]
+
+WORKDIR /app
+RUN cd /app && /opt/poetry/bin/poetry build -f wheel && /opt/poetry/bin/poetry export --without-hashes -f requirements.txt -o dist/requirements.txt
+
+######################## PROD  ########################
+FROM ghcr.io/rackerlabs/understack/argo-python3.12.2-alpine3.19 AS prod
+
+ENV FLAVORS_DIR="/flavors"
+ENV NOVA_FLAVOR_MONITOR_LOGLEVEL="info"
+
+LABEL org.opencontainers.image.description="Nova-Flavors synchronizer"
+
+RUN mkdir -p /opt/venv/wheels/
+COPY --from=builder /app/dist/*.whl /app/dist/requirements.txt /opt/venv/wheels/
+COPY --chown=appuser:appgroup python/understack-flavor-matcher /python/understack-flavor-matcher
+
+RUN --mount=type=cache,target=/root/.cache/.pip cd /app && /opt/venv/bin/pip install --find-links /opt/venv/wheels/ --only-binary watchdog psutil -r /opt/venv/wheels/requirements.txt nova-flavors
+
+USER appuser
+CMD ["nova-flavors-sync"]

operators/nova-flavors/.env-example

@@ -0,0 +1,8 @@
+OS_USERNAME=flavorsync
+OS_PASSWORD=abcd1234
+OS_AUTH_URL=https://keystone.environment.undercloud.rackspace.net/v3
+OS_USER_DOMAIN_NAME=service
+OS_PROJECT_NAME=admin
+OS_PROJECT_DOMAIN_NAME=default
+FLAVORS_DIR=/home/someuser/flavors/
+FLAVORS_ENV=nonprod

operators/nova-flavors/nova_flavors/flavor_synchronizer.py

@@ -0,0 +1,101 @@
+from functools import cached_property
+
+from flavor_matcher.flavor_spec import FlavorSpec
+from novaclient import client as novaclient
+
+from nova_flavors.logger import setup_logger
+
+logger = setup_logger(__name__)
+
+
+class FlavorSynchronizer:
+    def __init__(
+        self,
+        username: str | None = "",
+        password: str = "",
+        project_name: str | None = "admin",
+        project_domain_name: str = "default",
+        user_domain_name="service",
+        auth_url: str | None = None,
+    ) -> None:
+        self.username = username
+        self.password = password
+        self.project_name = str(project_name)
+        self.project_domain_name = str(project_domain_name)
+        self.user_domain_name = user_domain_name
+        self.auth_url = auth_url
+
+    @cached_property
+    def _nova(self):
+        return novaclient.Client(
+            "2",
+            username=self.username,
+            password=self.password,
+            project_name=self.project_name,
+            project_domain_name=self.project_domain_name,
+            user_domain_name=self.user_domain_name,
+            auth_url=self.auth_url,
+        )
+
+    def reconcile(self, desired_flavors: list[FlavorSpec]):
+        if len(desired_flavors) < 1:
+            raise Exception(f"Empty desired_flavors list.")
+
+        existing_flavors = self._nova.flavors.list()
+        for flavor in desired_flavors:
+            nova_flavor = next(
+                (flv for flv in existing_flavors if flv.name == flavor.stripped_name),
+                None,
+            )
+
+            update_needed = False
+            if nova_flavor:
+                logger.info(
+                    f"Flavor: {flavor.stripped_name} already exists. Syncing values"
+                )
+                if nova_flavor.ram != flavor.memory_mib:
+                    logger.info(
+                        f"{flavor.name} RAM mismatch - {nova_flavor.ram=} {flavor.memory_mib=}"
+                    )
+                    update_needed = True
+
+                if nova_flavor.disk != max(flavor.drives):
+                    logger.info(
+                        f"{flavor.name} Disk mismatch - {nova_flavor.disk=} {flavor.drives=}"
+                    )
+                    update_needed = True
+
+                if nova_flavor.vcpus != flavor.cpu_cores:
+                    logger.info(
+                        f"{flavor.name} CPU mismatch - {nova_flavor.vcpus=} {flavor.cpu_cores=}"
+                    )
+                    update_needed = True
+
+                if update_needed:
+                    logger.debug(
+                        f"{flavor.name} is outdated. Deleting so it can be recreated."
+                    )
+                    nova_flavor.delete()
+
+            else:
+                update_needed = True
+
+            if update_needed:
+                logger.info(f"Creating {flavor.name}")
+                self._create(flavor)
+
+    def _create(self, flavor: FlavorSpec):
+        nova_flavor = self._nova.flavors.create(
+            flavor.stripped_name,
+            flavor.memory_mib,
+            flavor.cpu_cores,
+            min(flavor.drives),
+        )
+        nova_flavor.set_keys(
+            {
+                "resources:DISK_GB": 0,
+                "resources:MEMORY_MB": 0,
+                "resources:VCPU": 0,
+                flavor.baremetal_nova_resource_class: 1,
+            }
+        )

operators/nova-flavors/nova_flavors/logger.py

@@ -0,0 +1,19 @@
+import logging
+
+
+def setup_logger(name: str | None = None, level: int = logging.DEBUG):
+    """Standardize our logging.
+
+    Configures the root logger to prefix messages with a timestamp
+    and to output the log level we want to see by default.
+
+    params:
+    name: logger hierarchy or root logger
+    level: default log level (DEBUG)
+    """
+    logging.basicConfig(
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S %z",
+        level=level,
+    )
+    return logging.getLogger(name)

operators/nova-flavors/nova_flavors/reconcile.py

@@ -0,0 +1,48 @@
+import logging
+import os
+import time
+
+from flavor_matcher.flavor_spec import FlavorSpec
+from watchdog.observers import Observer
+
+from nova_flavors.flavor_synchronizer import FlavorSynchronizer
+from nova_flavors.logger import setup_logger
+from nova_flavors.spec_changed_handler import SpecChangedHandler
+
+loglevel = getattr(logging, os.getenv("NOVA_FLAVOR_MONITOR_LOGLEVEL", "info").upper())
+logging.getLogger().setLevel(loglevel)
+logger = setup_logger(__name__, level=loglevel)
+
+
+def main():
+    # nonprod vs prod
+    flavors_dir = os.getenv("FLAVORS_DIR", "")
+    if not os.path.isdir(flavors_dir):
+        raise ValueError(f"flavors_dir '{flavors_dir}' is not a directory")
+    synchronizer = FlavorSynchronizer(
+        username=os.getenv("OS_USERNAME", ""),
+        password=os.getenv("OS_PASSWORD", ""),
+        project_name=os.getenv("OS_PROJECT_NAME", "admin"),
+        project_domain_name=os.getenv("OS_PROJECT_DOMAIN_NAME", "default"),
+        user_domain_name=os.getenv("OS_USER_DOMAIN_NAME", "service"),
+        auth_url=os.getenv("OS_AUTH_URL"),
+    )
+
+    handler = SpecChangedHandler(
+        synchronizer, lambda: FlavorSpec.from_directory(flavors_dir)
+    )
+    observer = Observer()
+    observer.schedule(handler, flavors_dir, recursive=True)
+    logger.info(f"Watching for changes in {flavors_dir}")
+    observer.start()
+
+    try:
+        while True:
+            time.sleep(1)
+    finally:
+        observer.stop()
+        observer.join()
+
+
+if __name__ == "__main__":
+    main()

operators/nova-flavors/nova_flavors/spec_changed_handler.py

@@ -0,0 +1,38 @@
+import time
+from typing import Callable
+
+from watchdog.events import DirModifiedEvent
+from watchdog.events import FileModifiedEvent
+from watchdog.events import FileSystemEventHandler
+
+from nova_flavors.flavor_synchronizer import FlavorSynchronizer
+from nova_flavors.logger import setup_logger
+
+logger = setup_logger(__name__)
+
+
+class SpecChangedHandler(FileSystemEventHandler):
+    COOLDOWN_SECONDS = 30
+
+    def __init__(
+        self, synchronizer: FlavorSynchronizer, flavors_cback: Callable
+    ) -> None:
+        self.last_call = None
+        self.synchronizer = synchronizer
+        self.flavors_cback = flavors_cback
+
+    def on_modified(self, event: DirModifiedEvent | FileModifiedEvent) -> None:
+        if isinstance(event, DirModifiedEvent):
+            self._run(event)
+
+    def _run(self, event):
+        now = time.time()
+        if not self.last_call:
+            self.last_call = now
+        else:
+            if self.last_call + self.COOLDOWN_SECONDS > now:
+                logger.debug("Cooldown period.")
+                return
+        self.last_call = now
+        logger.info(f"Flavors directory {event.src_path} has changed.")
+        self.synchronizer.reconcile(self.flavors_cback())