Advanced 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.

Image Library Service Components

The Private Cloud Director image library service has it's components deployed in the Private Cloud Director management plane as well as on each host that has image library role assigned.

On each host with persistent storage role assigned, Private Cloud Director runs an instance of the following services:

pf9-glance-api.service
pf9-imagelibrary

Enable Advance Configuration

Pre-requisites

• Root privileges on the host with image library role assigned.
• Make sure that no other users are currently using the image library service as this operation will require a service restart.

Step 1 - Identify Configuration File

• Identify the image library service configuration file located on the host with image library role assigned, where you are looking to enable advance configuration options.
• The file is typically located at the following path on the host:

/etc/glance/glance-api.conf

• open the file in a text editor to edit it

sudo vi /etc/glance/glance-api.conf

Step 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 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:

sudo service pf9-glance-api.service restart

Options You Can Configure

Enable Debug Logging

Refer to Log Filesfor the location of image library service log files. To enable debug logging for the image library service, edit the following property in the configuration file.

[DEFAULT]
debug = true  # Enable debug logging 

Enable Verbose Database Logging

The image library service logs database connectivity messages at WARNING level by default. For deep database connectivity troubleshooting, such as diagnosing a failed connection to the database backend, bump this logger to DEBUG.

For the image library API service, edit /etc/glance/api-logging.conf:

[logger_oslo_db]
level = DEBUG

For the image scrubber service, edit /etc/glance-scrubber/scrubber-logging.conf:

[logger_oslo_db]
level = DEBUG

Restart pf9-glance-api.service for the API service change to take effect. The scrubber service picks up its logging configuration on its next scheduled run.

Enable JSON-Formatted Logs

By default, the image library service logs in plain text. To emit logs in JSON format instead, for example to feed a log aggregation pipeline that expects structured logs, change the formatter class used by each service.

For the image library API service, edit /etc/glance/api-logging.conf:

[formatter_context]
class = oslo_log.formatters.JSONFormatter

For the image scrubber service, edit /etc/glance-scrubber/scrubber-logging.conf:

[formatter_context]
class = oslo_log.formatters.JSONFormatter

Restart pf9-glance-api.service for the API service change to take effect. The scrubber service picks up its logging configuration on its next scheduled run.