From f011fe42b9575e38ffb131130825c544f40ec902 Mon Sep 17 00:00:00 2001 From: Matthew Montopoli Date: Wed, 30 Apr 2025 20:34:42 +0000 Subject: [PATCH] DOC: Add instructions for configuring rabbitmq credentials Added instructions for changing the default rabbitmq credentials in "install-ptp-notifications." Added a note in "integrate-application-with-notification-client-sidecar" recommending that the user edit four parameters to match after they modify the rabbitmq username and password. Story: 2011332 Task: 52123 Change-Id: Iaaa3963cc3e5f6ef099495add85e1bd8a25e94bc Signed-off by: Matthew Montopoli --- .../kubernetes/install-ptp-notifications.rst | 48 +++++++++++++++++-- ...ation-with-notification-client-sidecar.rst | 7 +++ 2 files changed, 52 insertions(+), 3 deletions(-) diff --git a/doc/source/admintasks/kubernetes/install-ptp-notifications.rst b/doc/source/admintasks/kubernetes/install-ptp-notifications.rst index cb3d9fcc7..a5fa29890 100644 --- a/doc/source/admintasks/kubernetes/install-ptp-notifications.rst +++ b/doc/source/admintasks/kubernetes/install-ptp-notifications.rst @@ -467,7 +467,51 @@ resulting from running the v1 and v2 API pods at the same time. .. code-block:: none - ~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification --values notification-override-2212.yaml + ~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification --values notification-override.yaml + +#. Apply ``ptp-notification``. + + .. code-block:: none + + ~(keystone_admin)]$ system application-apply ptp-notification + +----------------------------------- +Change default rabbitmq credentials +----------------------------------- + +PTP Notification deploys two separate rabbitmq instances with a default username and password. +These values can be changed using the Helm overrides below: + +.. rubric:: |proc| + +#. Remove the application if it is currently installed + + .. code-block:: none + + ~(keystone_admin)]$ system application-remove ptp-notification + +#. Create an override file with these entries: + + .. code-block:: none + + cat <> /home/sysadmin/notification-rabbitmq.yaml + registration: + endpoint: + port: 5672 + user: + pass: + notification: + endpoint: + port: 5672 + user: + pass: + EOF + +#. Apply the Helm overrides + + .. code-block:: none + + ~(keystone_admin)]$ system helm-override-update ptp-notification ptp-notification notification --values notification-rabbitmq.yaml #. Apply ``ptp-notification``. @@ -476,5 +520,3 @@ resulting from running the v1 and v2 API pods at the same time. ~(keystone_admin)]$ system application-apply ptp-notification - - diff --git a/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst index be651b2e5..f6420d50c 100644 --- a/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst +++ b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst @@ -72,6 +72,13 @@ configured to make API calls to the notificationclient-base container. with ``ptp-notification`` v1 API, change the image from ``starlingx/notificationclient-base:stx.9.0-v2.1.1`` to ``starlingx/notificationclient-base:stx.5.0-v1.0.4``. +.. note:: + + If the rabbitmq username and password values were modified as per "Change + default rabbitmq credentials", then the values for REGISTRATION_USER, + REGISTRATION_PASS, NOTIFICATIONSERVICE_USER and NOTIFICATIONSERVICE_PASS below + need to be changed to match when integrating with ``ptp-notification``. + .. parsed-literal:: apiVersion: apps/v1