starlingx/distcloud
Code Issues Proposed changes
Files
7d44c38c90483d7177ede9eaca0223ed98feea19
distcloud/distributedcloud/debian/deb_folder/rules
Salman Rana 7d44c38c90 Introduce dccertmon service 
This commit introduces dccertmon, a new managed service for DC
certificate auditing and management.

Currently, platform cert management, DC cert management, and subcloud
cert auditing are coupled into a single platform service (certmon). To
meet the requirements of DC scalability and portability, DC specific
functionality must be decoupled. These changes lay the groundwork
for the new service, by:
- Creating the necessary service files.
- Introducing configs for the service.
- Declaring high level methods (Skeleton - lifecycle and manager)

DC-specific functionality will be migrated to this dccertmon service and
optimized in subsequent changes. Non-DC cert management will continue to
be handled by certmon.

Overall, this commit introduces:
- The OCF file necessary for high availability management of the
  dccertmon service by SM.
- Package configurations to build the service (Package: distributedcloud-dccertmon).
- Lifecycle manager for a running DC cert monitor service.
- Skeleton/base service application logic - CertificateMonitorManager.
- RPC notification handlers for subcloud online/managed.
- Configuration for the log folders and log rotation. The logs
  will be available in /var/log/dccertmon/dccertmon.log.

These changes are part of a set of commits to introduce the dccertmon service:
  [1] https://review.opendev.org/c/starlingx/ha/+/941205
  [2] https://review.opendev.org/c/starlingx/stx-puppet/+/941208

Test Plan:
  - PASS: Build dccertmon package
  - PASS: Install and bootstrap system with custom ISO containing the
          newly created dccertmon package
  - PASS: Verify that the dccertmon.service is loaded
  - PASS: Verify dccertmon is being properly logged to the correct
          folder.
  - PASS: Check logged messages and verify execution of
           - Cert Watcher thread
           - Task Executor (Audit thread)
           - Periodic tasks running at expected intervals
  - PASS: Configure and provision the service using SM and verify
          it has correctly started and can be restarted with
          'sm-restart'.
  - PASS: Tox checks running on dccertmon

  Note: This commit has been tested alongside the related changes and
        their respective test plans. [1][2]

Story: 2011311
Task: 51663

Change-Id: Ic23d8d13e4b292cf0508d23eaae99b8e07f36d31
Signed-off-by: Salman Rana <salman.rana@windriver.com>
2025-03-14 15:48:19 -04:00

126 lines
5.3 KiB
Makefile
Executable File
Raw Blame History

#!/usr/bin/make -f
#export DH_VERBOSE = 1
export PYBUILD_NAME = distributedcloud
export PBR_VERSION = 1.0.0
ROOT = $(CURDIR)/debian/tmp
SYSTEMD_DIR = $(ROOT)/usr/lib/systemd/system
TMP_DIR = $(ROOT)/usr/lib/tmpfiles.d
OCF_DIR = $(ROOT)/usr/lib/ocf/resource.d/openstack
SYS_CONF_DIR = $(ROOT)/etc
BIN_DIR = $(ROOT)/usr/bin
%:
dh $@ --with python3 --buildsystem=pybuild
override_dh_usrlocal:
# skip running dh_usrlocal
override_dh_install:
python3 setup.py install -f --install-layout=deb \
--root=$(CURDIR)/debian/tmp
python3 setup.py bdist_wheel \
--universal\
-d $(CURDIR)/debian/distributedcloud-wheels/usr/share/python-wheels
# install systemd unit files
install -p -D -m 644 files/dcmanager-api.service $(SYSTEMD_DIR)/dcmanager-api.service
install -p -D -m 644 files/dcmanager-manager.service $(SYSTEMD_DIR)/dcmanager-manager.service
install -p -D -m 644 files/dcmanager-audit.service $(SYSTEMD_DIR)/dcmanager-audit.service
install -p -D -m 644 files/dcmanager-audit-worker.service $(SYSTEMD_DIR)/dcmanager-audit-worker.service
install -p -D -m 644 files/dcmanager-orchestrator.service $(SYSTEMD_DIR)/dcmanager-orchestrator.service
install -p -D -m 644 files/dcorch-api.service $(SYSTEMD_DIR)/dcorch-api.service
install -p -D -m 644 files/dcorch-engine.service $(SYSTEMD_DIR)/dcorch-engine.service
install -p -D -m 644 files/dcorch-engine-worker.service $(SYSTEMD_DIR)/dcorch-engine-worker.service
install -p -D -m 644 files/dcorch-sysinv-api-proxy.service $(SYSTEMD_DIR)/dcorch-sysinv-api-proxy.service
install -p -D -m 644 files/dcorch-identity-api-proxy.service $(SYSTEMD_DIR)/dcorch-identity-api-proxy.service
install -p -D -m 644 files/dcdbsync-api.service $(SYSTEMD_DIR)/dcdbsync-api.service
install -p -D -m 644 files/dcagent-api.service $(SYSTEMD_DIR)/dcagent-api.service
install -p -D -m 644 files/dcorch.conf $(TMP_DIR)/dcorch.conf
install -p -D -m 644 files/dcmanager.conf $(TMP_DIR)/dcmanager.conf
install -p -D -m 644 files/dcagent.conf $(TMP_DIR)/dcagent.conf
install -p -D -m 644 files/dccertmon.conf $(TMP_DIR)/dccertmon.conf
# install systemd unit files for optional second instance
install -p -D -m 644 files/dcdbsync-openstack-api.service $(SYSTEMD_DIR)/dcdbsync-openstack-api.service
install -p -D -m 644 files/dcdbsync.conf $(TMP_DIR)/dcdbsync.conf
install -p -D -m 644 files/distcloud-syslog.conf $(SYS_CONF_DIR)/syslog-ng/conf.d/distcloud.conf
install -p -D -m 644 files/distcloud-logrotate.conf $(SYS_CONF_DIR)/logrotate.d/distcloud.conf
# install ocf scripts
install -d -m 755 $(OCF_DIR)
install -p -D -m 755 ocf/* $(OCF_DIR)/
# install dcorch cleaner
install -m 755 -D -p files/clean-dcorch $(BIN_DIR)/clean-dcorch
# install ansible overrides dir
install -d -m 600 $(ROOT)/var/opt/dc/ansible
# Generate sample config and add the current directory to PYTHONPATH so
# oslo-config-generator doesn't skip heat's entry points.
PYTHONPATH=. oslo-config-generator --config-file=./dcmanager/config-generator.conf
PYTHONPATH=. oslo-config-generator --config-file=./dcorch/config-generator.conf
PYTHONPATH=. oslo-config-generator --config-file=./dcdbsync/config-generator.conf
PYTHONPATH=. oslo-config-generator --config-file=./dcagent/config-generator.conf
PYTHONPATH=. oslo-config-generator --config-file=./dccertmon/config-generator.conf
# install default config files
oslo-config-generator \
--config-file ./dcmanager/config-generator.conf \
--output-file ./dcmanager/dcmanager.conf.sample
install -p -D -m 640 ./dcmanager/dcmanager.conf.sample $(SYS_CONF_DIR)/dcmanager/dcmanager.conf
oslo-config-generator \
--config-file ./dcorch/config-generator.conf \
--output-file ./dcorch/dcorch.conf.sample
install -p -D -m 640 ./dcorch/dcorch.conf.sample $(SYS_CONF_DIR)/dcorch/dcorch.conf
oslo-config-generator \
--config-file ./dcdbsync/config-generator.conf \
--output-file ./dcdbsync/dcdbsync.conf.sample
install -p -D -m 640 ./dcdbsync/dcdbsync.conf.sample $(SYS_CONF_DIR)/dcdbsync/dcdbsync.conf
oslo-config-generator \
--config-file ./dcagent/config-generator.conf \
--output-file ./dcagent/dcagent.conf.sample
install -p -D -m 640 ./dcagent/dcagent.conf.sample $(SYS_CONF_DIR)/dcagent/dcagent.conf
oslo-config-generator \
--config-file ./dccertmon/config-generator.conf \
--output-file ./dccertmon/dccertmon.conf.sample
install -p -D -m 640 ./dccertmon/dccertmon.conf.sample $(SYS_CONF_DIR)/dccertmon/dccertmon.conf
# install rvmc_install.py script
install -d $(ROOT)/usr/local/bin/
install -p -D -m 700 scripts/rvmc_install.py $(ROOT)/usr/local/bin
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dcmanagerclient/tests
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dccommon/tests
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dcmanager/tests
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dcorch/tests
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dcagent/tests
rm -rf $(ROOT)/usr/lib/python3/dist-packages/dccertmon/tests
dh_install
override_dh_auto_test:
echo "do nothing..."
override_dh_fixperms:
dh_fixperms \
--exclude etc/dcdbsync/dcdbsync.conf \
--exclude etc/dcmanager/dcmanager.conf \
--exclude etc/dcorch/dcorch.conf \
--exclude etc/dcagent/dcagent.conf \
--exclude etc/dccertmon/dccertmon.conf
execute_after_dh_fixperms:
# forcing 600 for /var/opt/dc/ansible
chmod 600 debian/distributedcloud-dcmanager/var/opt/dc/ansible
View Git Blame Copy Permalink