Bare Metal API configuration

Bare Metal API configuration

Configuration options

The following options allow configuration of the APIs that Bare Metal service supports.

Description of API configuration options
Configuration option = Default value Description
[api]  
api_workers = None (Integer) Number of workers for OpenStack Ironic API service. The default is equal to the number of CPUs available if that can be determined, else a default worker count of 1 is returned.
enable_ssl_api = False (Boolean) Enable the integrated stand-alone API to service requests via HTTPS instead of HTTP. If there is a front-end service performing HTTPS offloading from the service, this option should be False; note, you will want to change public API endpoint to represent SSL termination URL with ‘public_endpoint’ option.
host_ip = 0.0.0.0 (String) The IP address on which ironic-api listens.
max_limit = 1000 (Integer) The maximum number of items returned in a single response from a collection resource.
port = 6385 (Port number) The TCP port on which ironic-api listens.
public_endpoint = None (String) Public URL to use when building the links to the API resources (for example, “https://ironic.rocks:6384”). If None the links will be built using the request’s host URL. If the API is operating behind a proxy, you will want to change this to represent the proxy’s URL. Defaults to None.
ramdisk_heartbeat_timeout = 300 (Integer) Maximum interval (in seconds) for agent heartbeats.
restrict_lookup = True (Boolean) Whether to restrict the lookup API to only nodes in certain states.
[oslo_middleware]  
enable_proxy_headers_parsing = False (Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
max_request_body_size = 114688 (Integer) The maximum body size for each request, in bytes.
secure_proxy_ssl_header = X-Forwarded-Proto (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.
[oslo_versionedobjects]  
fatal_exception_format_errors = False (Boolean) Make exception message format errors fatal
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.