Liberty -  Liberty -  Liberty -  Liberty -  Liberty -  Liberty -  Liberty -  Liberty - 

 Configure APIs

The following options allow configuration of the APIs that Orchestration supports. Currently this includes compatibility APIs for CloudFormation and CloudWatch and a native API.

Table 12.12. Description of API configuration options
Configuration option = Default value Description
[DEFAULT]
action_retry_limit = 5 (IntOpt) Number of times to retry to bring a resource to a non-error state. Set to 0 to disable retries.
enable_stack_abandon = False (BoolOpt) Enable the preview Stack Abandon feature.
enable_stack_adopt = False (BoolOpt) Enable the preview Stack Adopt feature.
encrypt_parameters_and_properties = False (BoolOpt) Encrypt template parameters that were marked as hidden and also all the resource properties before storing them in database.
heat_metadata_server_url = (StrOpt) URL of the Heat metadata server.
heat_stack_user_role = heat_stack_user (StrOpt) Keystone role for heat template-defined users.
heat_waitcondition_server_url = None (StrOpt) URL of the Heat waitcondition server.
heat_watch_server_url = (StrOpt) URL of the Heat CloudWatch server.
hidden_stack_tags = data-processing-cluster (ListOpt) Stacks containing these tag names will be hidden. Multiple tags should be given in a comma-delimited list (eg. hidden_stack_tags=hide_me,me_too).
max_json_body_size = 1048576 (IntOpt) Maximum raw byte size of JSON request body. Should be larger than max_template_size.
num_engine_workers = 4 (IntOpt) Number of heat-engine processes to fork and run.
secure_proxy_ssl_header = X-Forwarded-Proto (StrOpt) The HTTP Header that will be used to determine which the original request protocol scheme was, even if it was removed by an SSL terminator proxy.
stack_action_timeout = 3600 (IntOpt) Timeout in seconds for stack action (ie. create or update).
stack_domain_admin = None (StrOpt) Keystone username, a user with roles sufficient to manage users and projects in the stack_user_domain.
stack_domain_admin_password = None (StrOpt) Keystone password for stack_domain_admin user.
stack_scheduler_hints = False (BoolOpt) When this feature is enabled, scheduler hints identifying the heat stack context of a server or volume resource are passed to the configured schedulers in nova and cinder, for creates done using heat resource types OS::Cinder::Volume, OS::Nova::Server, and AWS::EC2::Instance. heat_root_stack_id will be set to the id of the root stack of the resource, heat_stack_id will be set to the id of the resource's parent stack, heat_stack_name will be set to the name of the resource's parent stack, heat_path_in_stack will be set to a list of tuples, (stackresourcename, stackname) with list[0] being (None, rootstackname), heat_resource_name will be set to the resource's name, and heat_resource_uuid will be set to the resource's orchestration id.
stack_user_domain_id = None (StrOpt) Keystone domain ID which contains heat template-defined users. If this option is set, stack_user_domain_name option will be ignored.
stack_user_domain_name = None (StrOpt) Keystone domain name which contains heat template-defined users. If `stack_user_domain_id` option is set, this option is ignored.
trusts_delegated_roles = (ListOpt) Subset of trustor roles to be delegated to heat. If left unset, all roles of a user will be delegated to heat when creating a stack.
[auth_password]
allowed_auth_uris = (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
multi_cloud = False (BoolOpt) Allow orchestration of multiple clouds.
[ec2authtoken]
allowed_auth_uris = (ListOpt) Allowed keystone endpoints for auth_uri when multi_cloud is enabled. At least one endpoint needs to be specified.
auth_uri = None (StrOpt) Authentication Endpoint URI.
ca_file = None (StrOpt) Optional CA cert file to use in SSL connections.
cert_file = None (StrOpt) Optional PEM-formatted certificate chain file.
insecure = False (BoolOpt) If set, then the server's certificate will not be verified.
key_file = None (StrOpt) Optional PEM-formatted file that contains the private key.
multi_cloud = False (BoolOpt) Allow orchestration of multiple clouds.
[eventlet_opts]
client_socket_timeout = 900 (IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.
wsgi_keep_alive = True (BoolOpt) If False, closes the client socket connection explicitly.
[heat_api]
backlog = 4096 (IntOpt) Number of backlog requests to configure the socket with.
bind_host = 0.0.0.0 (StrOpt) Address to bind the server. Useful when selecting a particular network interface.
bind_port = 8004 (IntOpt) The port on which the server will listen.
cert_file = None (StrOpt) Location of the SSL certificate file to use for SSL mode.
key_file = None (StrOpt) Location of the SSL key file to use for enabling SSL mode.
max_header_line = 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
tcp_keepidle = 600 (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
workers = 4 (IntOpt) Number of workers for Heat service.
[oslo_middleware]
max_request_body_size = 114688 (IntOpt) The maximum body size for each request, in bytes.
secure_proxy_ssl_header = X-Forwarded-Proto (StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
[oslo_policy]
policy_default_rule = default (StrOpt) Default rule. Enforced when a requested rule is not found.
policy_dirs = ['policy.d'] (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
policy_file = policy.json (StrOpt) The JSON file that defines policies.
[oslo_versionedobjects]
fatal_exception_format_errors = False (BoolOpt) Make exception message format errors fatal
[paste_deploy]
api_paste_config = api-paste.ini (StrOpt) The API paste config file to use.
flavor = None (StrOpt) The flavor to use.

Table 12.13. Description of Cloudformation-compatible API configuration options
Configuration option = Default value Description
[DEFAULT]
instance_connection_https_validate_certificates = 1 (StrOpt) Instance connection to CFN/CW API validate certs if SSL is used.
instance_connection_is_secure = 0 (StrOpt) Instance connection to CFN/CW API via https.
[heat_api_cfn]
backlog = 4096 (IntOpt) Number of backlog requests to configure the socket with.
bind_host = 0.0.0.0 (StrOpt) Address to bind the server. Useful when selecting a particular network interface.
bind_port = 8000 (IntOpt) The port on which the server will listen.
cert_file = None (StrOpt) Location of the SSL certificate file to use for SSL mode.
key_file = None (StrOpt) Location of the SSL key file to use for enabling SSL mode.
max_header_line = 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).
tcp_keepidle = 600 (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
workers = 0 (IntOpt) Number of workers for Heat service.

Table 12.14. Description of CloudWatch API configuration options
Configuration option = Default value Description
[DEFAULT]
enable_cloud_watch_lite = False (BoolOpt) Enable the legacy OS::Heat::CWLiteAlarm resource.
heat_watch_server_url = (StrOpt) URL of the Heat CloudWatch server.
[heat_api_cloudwatch]
backlog = 4096 (IntOpt) Number of backlog requests to configure the socket with.
bind_host = 0.0.0.0 (StrOpt) Address to bind the server. Useful when selecting a particular network interface.
bind_port = 8003 (IntOpt) The port on which the server will listen.
cert_file = None (StrOpt) Location of the SSL certificate file to use for SSL mode.
key_file = None (StrOpt) Location of the SSL key file to use for enabling SSL mode.
max_header_line = 16384 (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs.)
tcp_keepidle = 600 (IntOpt) The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
workers = 0 (IntOpt) Number of workers for Heat service.

Table 12.15. Description of metadata API configuration options
Configuration option = Default value Description
[DEFAULT]
heat_metadata_server_url = (StrOpt) URL of the Heat metadata server.

Table 12.16. Description of waitcondition API configuration options
Configuration option = Default value Description
[DEFAULT]
heat_waitcondition_server_url = None (StrOpt) URL of the Heat waitcondition server.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...