Advance Service Configuration
This page describes the steps to configure advance options for Private Cloud Director block storage service and steps to debug issues with the block storage service.
Block Storage Service Components
The Private Cloud Director block storage service has it's components deployed in the Private Cloud Director management plane as well as on each host that has persistent storage role assigned.
On each host with persistent storage role assigned, Private Cloud Director runs an instance of a service called pf9-cindervolume-base
Enable Advance Configuration
Pre-requisites
Root privileges on the host with persistent storage role assigned.
Make sure that no other users are currently using the block storage service as this operation will require a block storage service restart.
Step 1 - Identify Block Storage Configuration File
Identify the block storage configuration file located on the host with persistent storage role assigned, where you are looking to enable advance configuration options.
The file is typically located at the following path on the host:
/opt/pf9/etc/pf9-cindervolume-base/conf.d/cinder_override.confopen the file in a text editor to edit it
sudo vi /opt/pf9/etc/pf9-cindervolume-base/conf.d/cinder_override.confStep 2 - Make Required Changes
Make the desired changes to this file based on what configuration option you wish to edit. Follow Options You Can Configure to identify the specific configuration you wish to tweak.
Step 3 - Restart Block Storage Service
Once you've made the required changes to the config file, save the file and exit the text editor
Now you will need to restart the block storage service in order for the changes to take effect. Follow these steps to restart the service:
Options You Can Configure
To restrict the Persistent Storage Service so that a cluster's hosts fetch images only from that cluster's Image Library host, see Restrict the Image Library Service to a Specific Cluster.
To configure an external key manager (HashiCorp Vault) as the backend for volume encryption, see Volume Encryption with an External Key Manager.
Enable Debug Logging
Refer to Advance Service Configuration for the location of block storage service log files. To enable debug logging for the block storage service, edit the following property in the configuration file.
Enable JSON-Formatted Logs
To emit block storage service logs in JSON format instead of plain text, for example to feed a log aggregation pipeline that expects structured logs, edit the following property in the configuration file.
Configure Automatic Database Purging
The block storage service keeps soft-deleted rows, such as deleted volumes and snapshots, in its database rather than removing them immediately. To automatically purge these rows on a recurring schedule, edit the following property in the configuration file.
This option is disabled by default (db_purge_age_in_days = 0). When set to a positive value, the block storage service purges soft-deleted rows older than the configured number of days once every 24 hours. The purge also removes orphaned volume image-metadata rows left behind after their parent volume or snapshot has already been deleted.
To purge the database on demand instead of waiting for the scheduled purge, run the following command on the host with the persistent storage role assigned.
Last updated
Was this helpful?