Manifest settings for web components
Overview
This reference doc details all the Manifest settings for webserver, proxy and framework components. If you’re unfamiliar with Manifest files and how they work, please follow our getting started guide and detailed how-to guide.
If you’re looking for the Manifest settings for data, caching & storage components or load balancers, please see our respective reference documents for those components.
Key to table headings
- Option - the name of the setting as used in the YAML of your Manifest file
- Applied on - the type of deployment required to update this setting. In many cases settings only apply when an application is first built, or when new servers are created or it is cloned. Hover over the names of each condition to see more info.
- Clouds - the cloud providers on which a setting can be used.
Docker
| Option | Applied on | Description | Clouds |
|---|---|---|---|
docker_version |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
Specify the version of Docker you want to install. | All |
iam_instance_profile_name |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
The name of the IAM instance profile that should be used when provisioning this server. Read our guide. | AWS |
image_keep_count |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
Set the number of old images to save on your servers (besides the running image). Defaults to 2. |
All |
nameservers |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
Set DNS servers for your application. Note that if you specify empty array i.e [ ], it won't add any nameserver to your servers. Default is [ 8.8.8.8, 8.8.4.4 ]
|
All |
operating_system |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
The version of Ubuntu to install on the server that hosts your Rails app. Accepted values: ubuntu1604 or ubuntu1804 |
All |
root_disk_size |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
Default size of root disk (in GB) for servers used by application. Default value is 50. | AWS, Azure, GCE |
root_disk_type |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
Disk type, accepted values being ssd and magnetic. Default is ssd. |
AWS, GCE |
vn_name |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
The name of the Virtual Network in which you would like to create your servers. | Azure |
vpc_id |
Build-only ⓘThis setting only applies when the app is first built (or cloned) or when new servers are added. |
ID of the AWS VPC in which you would like to create your servers. Note that you must provide subnet_id for all servers in your application. | AWS |
weave_version (Maestro V1 only) |
Deploy-with-upgrades ⓘChanges to this setting will only be applied if you choose the "Deploy with upgrades" option |
Specify the version of Weave you want to install. Maestro V1 only. | All |
Examples YAML for Docker
docker:
configuration:
iam_instance_profile_name: docker-perms
docker_version: 1.7.0
weave_version: 1.0.3
vpc_id: vpc-64872001
root_disk_size: 100
root_disk_type: ssd
image_keep_count: 5
nameservers: ['8.8.8.8', '8.8.4.4']
docker:
configuration:
docker_version: 1.12.0
weave_version: 1.0.3
vn_name: your_vn_name
root_disk_size: 100
root_disk_type: ssd
image_keep_count: 15
Gateway
Note
The gateway should be defined and open before you can use it in manifest.
The following settings are available via the Manifest file:
| Option | Applied on | Description | Clouds |
|---|---|---|---|
name |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Specify the name of gateway you want to use for your application. | All |
username |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Specify the username which should be used to connect to Bastion server. | All |
Example YAML for gateway
gateway:
name: aws_bastion
username: ec2-user
Nginx
Nginx is the default webserver & reverse proxy for applications managed by Cloud 66.
The following settings are available via the Manifest file:
| Option | Applied on | Description | Clouds |
|---|---|---|---|
cors |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Enable Cross Origin Resource Sharing | All |
perfect_forward_secrecy (deprecated) |
Redeploy ⓘChanges to this setting will be applied when you next deploy your application |
Enable Perfect Forward Secrecy | All |
Example YAML for Nginx
rails:
configuration:
nginx:
perfect_forward_secrecy: true # deprecated
CORS configuration
If required, you can also specify the allowed origin (as ‘*’ or a single origin) and methods. You can also specify a comma-separated list of origins, headers, and whether to allow credentials for CORS.
rails:
configuration:
nginx:
cors:
origin: '*'
methods: 'GET, OPTIONS'
headers: 'Custom-Header, Another-Header'
credentials: true
