Container integration configuration exposes multiple integration options to users.
To navigate to a container integration settings go to any container and select the Config navigation option. From there select Integrations from the sub menu.
There are four options when setting up container integrations:
Files
The files integration is a great way to add larger files to a container. The files are pulled by a given nodes compute service and can be cashed if query parameters are passed.
Field | Type | Description |
|---|---|---|
| string | Endpoint serving the file(s) to provision into the container. Supports the query parameters below. |
| string | File path the files are downloaded to on the container instance(s). |
Query parameters applied to source endpoint.
Parameter | Type | Description |
|---|---|---|
| duration string | How long Cycle may serve its cached copy of the file before re-fetching from the origin. Accepts a duration such as |
| string | An opaque version identifier for the file. Changing it invalidates the cached copy. |
Shared Directories
Shared directories allow for a shared directory between containers running on the same host.
These directories are defined as identifiers in the server configuration.
This integration has three parts:
Field | Description |
|---|---|
Identifier | A special identifier, used to associate with the underlying directory. |
Writable | A boolean where true means the given container can write to the directory. |
Mount Point | Where in the container to mount the shared directory. |
The mount point can be a directory that does not yet exist on the container. For example /app/shared can be used and if that directory does not exist on the host it will be added.
Let's Encrypt
Allows the user to control where TLS certificates are installed for a container. Using this option on a container means reserving a specific inbound port as the load balancer will have no information other than port to route the traffic if the connection is still encrypted.
TLS Certificates that use this integration must be generated through the DNS tooling.
Choosing the checkbox under enable will install all four options to the default location /var/run/cycle/tls/* where * represents the specific asset path. Click the customize checkbox next to the files and supply a path if a custom path is desired.
Webhooks
The integration webhooks represent the 4 different types of events that can be hooked into for this container.
Field | Description |
|---|---|
Start | An endpoint to hit when the container starts. |
Stop | An endpoint to hit when the container stops. |
Deploy | An endpoint to hit when a deploy event happens (tied to stack deployments). |
Config | An endpoint that hosts a container config object to be used for granular configuration changes at runtime. |