# octavia.cmd.house_keeping

# Source code for octavia.cmd.house_keeping

    # Copyright 2015 Hewlett-Packard Development Company, L.P.
    #
    # Licensed under the Apache License, Version 2.0 (the "License"); you may
    # not use this file except in compliance with the License. You may obtain
    # a copy of the License at
    #
    # http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
    # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
    # License for the specific language governing permissions and limitations
    # under the License.
    #

    import signal
    import sys
    import threading

    from oslo_config import cfg
    from oslo_log import log as logging
    from oslo_reports import guru_meditation_report as gmr
    from oslo_reports import opts as gmr_opts
    from oslo_utils import timeutils

    from octavia.common import service
    from octavia.controller.housekeeping import house_keeping
    from octavia import version

    LOG = logging.getLogger(__name__)
    CONF = cfg.CONF

    db_cleanup_thread_event = threading.Event()
    cert_rotate_thread_event = threading.Event()

    def db_cleanup():
        """Perform db cleanup for old resources."""
        # Read the interval from CONF
        interval = CONF.house_keeping.cleanup_interval
        LOG.info("DB cleanup interval is set to %d sec", interval)
        LOG.info('Amphora expiry age is %s seconds',
                 CONF.house_keeping.amphora_expiry_age)
        LOG.info('Load balancer expiry age is %s seconds',
                 CONF.house_keeping.load_balancer_expiry_age)

        db_cleanup = house_keeping.DatabaseCleanup()
        while not db_cleanup_thread_event.is_set():
            LOG.debug("Initiating the cleanup of old resources...")
            try:
                db_cleanup.delete_old_amphorae()
                db_cleanup.cleanup_load_balancers()
            except Exception as e:
                LOG.debug('db_cleanup caught the following exception and '
                          'is restarting: %s', str(e))
            db_cleanup_thread_event.wait(interval)

    def cert_rotation():
        """Perform certificate rotation."""
        interval = CONF.house_keeping.cert_interval
        LOG.info(
            "Expiring certificate check interval is set to %d sec", interval)
        cert_rotate = house_keeping.CertRotation()
        while not cert_rotate_thread_event.is_set():
            LOG.debug("Initiating certification rotation ...")
            try:
                cert_rotate.rotate()
            except Exception as e:
                LOG.debug('cert_rotation caught the following exception and '
                          'is restarting: %s', str(e))
            cert_rotate_thread_event.wait(interval)

    def _mutate_config(*args, **kwargs):
        LOG.info("Housekeeping received HUP signal, mutating config.")
        CONF.mutate_config_files()

    def main():
        service.prepare_service(sys.argv)
        LOG.debug('Full set of CONF:')
        CONF.log_opt_values(LOG, logging.DEBUG)

        gmr_opts.set_defaults(CONF)
        gmr.TextGuruMeditation.setup_autorun(version, conf=CONF)

        timestamp = str(timeutils.utcnow())
        LOG.info("Starting house keeping at %s", timestamp)

        threads = []

        # Thread to perform db cleanup
        db_cleanup_thread = threading.Thread(target=db_cleanup)
        db_cleanup_thread.daemon = True
        db_cleanup_thread.start()
        threads.append(db_cleanup_thread)

        # Thread to perform certificate rotation
        cert_rotate_thread = threading.Thread(target=cert_rotation)
        cert_rotate_thread.daemon = True
        cert_rotate_thread.start()
        threads.append(cert_rotate_thread)

        def process_cleanup(*args, **kwargs):
            LOG.info("Attempting to gracefully terminate House-Keeping")
            db_cleanup_thread_event.set()
            cert_rotate_thread_event.set()
            db_cleanup_thread.join()
            cert_rotate_thread.join()
            LOG.info("House-Keeping process terminated")

        signal.signal(signal.SIGTERM, process_cleanup)
        signal.signal(signal.SIGHUP, _mutate_config)

        try:
            for thread in threads:
                thread.join()
        except KeyboardInterrupt:
            process_cleanup()

this page last updated: 2026-03-10 18:02:42

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug