EC2API configuration

EC2API configuration

Configuration options

The following options allow configuration that EC2API supports.

Description of OpenStack Clients configuration options
Configuration option = Default value Description
[DEFAULT]  
cinder_service_type = volumev2 (String) Service type of Volume API, registered in Keystone catalog.
ec2_timestamp_expiry = 300 (Integer) Time in seconds before ec2 timestamp expires
keystone_ec2_tokens_url = http://localhost:5000/v3/ec2tokens (String) URL to authenticate token from ec2 request.
nova_service_type = compute (String) Service type of Compute API, registered in Keystone catalog. Should be v2.1 with microversion support. If it is obsolete v2, a lot of useful EC2 compliant instance properties will be unavailable.
Description of additional Database Client configuration options
Configuration option = Default value Description
[database]  
use_tpool = False (Boolean) Enable the experimental use of thread pooling for all DB API calls
Description of EC2API Service configuration options
Configuration option = Default value Description
[DEFAULT]  
ec2api_listen = 0.0.0.0 (String) The IP address on which the EC2 API will listen.
ec2api_listen_port = 8788 (Integer) The port on which the EC2 API will listen.
ec2api_use_ssl = False (Boolean) Enable ssl connections or not for EC2 API
ec2api_workers = None (Integer) Number of workers for EC2 API service. The default will be equal to the number of CPUs available.
ssl_cert_file = None (String) SSL certificate of API server
ssl_key_file = None (String) SSL private key of API server
use_forwarded_for = False (Boolean) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.
Description of EC2API configuration options
Configuration option = Default value Description
[DEFAULT]  
default_flavor = m1.small (String) A flavor to use as a default instance type
disable_ec2_classic = None (Boolean) True if server does not support EC2 Classic mode in favor of default VPC
ec2_host = $my_ip (String) The IP address of the EC2 API server
ec2_path = / (String) The path prefix used to call the ec2 API server
ec2_port = 8788 (Integer) The port of the EC2 API server
ec2_private_dns_show_ip = False (Boolean) Return the IP address as private dns hostname in describe instances
ec2_scheme = http (String) The protocol to use when connecting to the EC2 API server (http, https)
external_network = None (String) Name of the external network, which is used to connectVPCs to Internet and to allocate Elastic IPs.
internal_service_availability_zone = internal (String) The availability_zone to show internal services under
my_ip = 10.0.0.1 (String) IP address of this host
network_device_mtu = 1500 (Integer) MTU size to set by DHCP for instances. Corresponds with the network_device_mtu in ec2api.conf.
region_list = (List) List of region=fqdn pairs separated by commas
Description of S3 Client configuration options
Configuration option = Default value Description
[DEFAULT]  
image_decryption_dir = /tmp (String) Parent directory for tempdir used for image decryption
s3_region = RegionOne (String) Region of S3 server
s3_url = http://$my_ip:3334 (String) URL to S3 server
x509_root_private_key = None (String) Path to ca private key file
Description of Common Service configuration options
Configuration option = Default value Description
[DEFAULT]  
api_paste_config = api-paste.ini (String) File name for the paste.deploy config for ec2api
max_header_line = 16384 (Integer) 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 (Integer) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
wsgi_default_pool_size = 1000 (Integer) Size of the pool of greenthreads used by wsgi
wsgi_log_format = %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f (String) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
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.