Enable Shared File Systems notifications

You can enable notifications in the Shared File Systems service (manila) for various events that occur during the share lifecycle.

About this task
Copy link

These notifications provide telemetry data that you can use for the following:

  • Auditing, troubleshooting, and monitoring operations
  • Integrating with other services such as Ceilometer for metrics collection and processing

The Shared File Systems service uses the RabbitMQ message broker software for notification delivery to a configured message queue. Services inherit global notificationsBus settings configured at the control plane level. Use this procedure only when you need to configure a dedicated RabbitMQ cluster for this service that differs from the global configuration.

Procedure
Copy link

  1. Open your OpenStackControlPlane CR file, openstack_control_plane.yaml, and add the notificationsBus parameter to the manila template to specify the RabbitMQ cluster name to use for requesting a transport URL.
    Note

    The notificationsBusInstance parameter is deprecated. Existing deployments that use notificationsBusInstance are automatically migrated to use the notificationsBus interface.

     
    kind: OpenStackControlPlane
spec:
  ...
  manila:
    template:
      ...
      notificationsBus:
        cluster: rabbitmq
      customServiceConfig: |
...

    To turn off notifications, remove the notificationsBus parameter from the manila template and update the control plane.

  2. Update the control plane: 
    $ oc apply -f openstack_control_plane.yaml -n openstack
  3. Wait until Red Hat OpenShift Container Platform (RHOCP) creates the resources related to the OpenStackControlPlane CR. Run the following command to check the status: 
    $ oc get openstackcontrolplane -n openstack

    The OpenStackControlPlane resources are created when the status is "Setup complete".

    Tip
    Append the -w option to the end of the get command to track deployment progress.

Configure automatic database cleanup
Copy link

You can control how long the Shared File Systems (manila) service retains database records marked for deletion before purging them. The default retention period is 30 days, and purge jobs run daily at 00:01.

Procedure
Copy link

  1. Open your openstack_control_plane.yaml file to edit the OpenStackControlPlane CR.
  2. Add the dbPurge parameter to the manila template to configure database cleanup.

    The following is an example of using the dbPurge parameter to configure the Shared File Systems service:

    apiVersion: core.openstack.org/v1beta1
kind: OpenStackControlPlane
metadata:
  name: openstack
spec:
  manila:
    template:
      dbPurge:
        age: 20
        schedule: 1 0 * * 0
    • age: The number of days a record has been marked for deletion before it is purged. The default value is 30 days. The minimum value is 1 day.
    • schedule: When to run the job in a crontab format. The default value is 1 0 * * *. This default value is equivalent to 00:01 daily.
  3. Update the control plane: 
    $ oc apply -f openstack_control_plane.yaml