Skip to main content

OpenStack notifications

To improve the realtime experience from the OSIE customer dashboard, we recommend to install the oise-notifier container near to your OpenStack's rabbitmq.
OSIE notifier will listen to openstack notifications and forward them to the main OSIE server via HTTP.

Prerequisites​

  • OpenStack to be configured to emit notifications via the RabbitMQ
  • the RabbitMQ to be accessible by the osie-notifier container
  • osie-notifier to have sufficient network permissions forward notifications to the OSIE installation via HTTP.

1. Enable notifications in OpenStack​

OpenStack has to have the notifications enabled in order for this to work. How to do that depends on your installation method, but in general it resides under this section:

[oslo_messaging_notifications]
transport_url = rabbit://openstack:<password>@<rabbitmq-hostname>:5672//
driver = messagingv2
topics = notifications

Kolla ansible​

If you are using kolla-ansible the notifications are automatically enabled if you enable ceilometer

enable_ceilometer: "yes"

Otherwise, you'd have to manually add the [oslo_messaging_notifications] section to the services.

2. Install osie-notifier​

  1. Find out the DSN (data source name) from OSIE Admin panel. Navigate to Settings > Cloud providers > <provider> and check the Notifier URI section.
    The DNS URI should look like this:
https://cloud.mydomain.com/api-v1/os-notification/647724f1ec3c45627b0d3272/RegionOne
  1. Deploy osie-notifier that connects to your OpenStack's RabbitMQ in that region.
mkdir ./osie-notifier
cd ./osie-notifier

cat <<EOF > application.yml
osie:
dsn:
- https://cloud.mydomain.com/api-v1/os-notification/647724f1ec3c45627b0d3272/RegionOne
spring:
rabbitmq:
username: openstack
password: securepassword
addresses: rabbitmq1:5672,rabbitmq2:5672,rabbitmq3:5672
notifications:
queue: osie-notifier
openstack:
topic: notifications.*
services:
# adapt this depending on the enabled services
- exchange: nova
- exchange: neutron
- exchange: openstack
- exchange: heat
server:
port: 7476
EOF

cat <<EOF > docker-compose.yml
version: '3'

services:
osie-notifier:
image: ghcr.io/osie-io/osie-notifier:23.9.5
container_name: osie-notifier
restart: always
network_mode: host
volumes:
- ./application.yml:/srv/config/application.yml
EOF

Now start the osie-notifier container.

docker-compose up -d
# or
docker compose up -d