This is documentation for Apprenda 7 and 8.
Documentation for older versions are also available.

Docker Configuration Custom Properties

The following Custom Properties must be created if you plan to use the Platform's management and deployment configurations for Docker workloads. Platform Operators will need to add all related Customer Properties before a feature can be used for Docker deployments.

The Custom Property definitions below are written as they should be added to the Platform through the SOC Configuration>Custom Properties page.

Deploying with Docker

The following Custom Property is required to deployment using Docker.

Docker Deploy
General Settings  
     Name DockerDeploy
     Display Name Docker Deploy
     Description Tag that denotes an application should be deployed with Docker.
     Allowed Values No, Registry
     Applies to: Applications
Default Value(s) No
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment Yes
          Editable by Developers Yes

Optionally, you can also use this Custom Property to distinguish Linux servers that should be used for Docker deployments if only a subset of your Linux servers will be configured for Docker. You can set up server tagging by creating an Application Deployment Policy. If you wish to use this Custom Property for tagging Linux servers for Docker deployments, also make sure Docker Deploy Applies to: Compute Servers (allow multi-select).

Volume Management

The following Custom Properties can be used to bind mount file systems for your container deployments. Read more on using volumes.

  • Docker Bind Host
  • Docker Bind Host Approved Directories
  • Docker Bind Shared
  • Docker Bind Shared Root Directory
  • Docker Bind Local
  • Docker Bind Directory Permissions
Docker Bind Host
General Settings  
     Name DockerBindHost
     Display Name Docker Bind Host
     Description Absolute path of the host directory to mount
     Allowed Values allow custom values
     Applies to:

Applications (allow multi select)

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Bind Host Approved Directories
General Settings  
     Name DockerBindHostApprovedDirs
     Display Name Docker Bind Host Approved Directories
     Description Colon-separated whitelist of absolute path directories approved for host bind mounting. Set by Platform Operators for the Platform and values provided by Developers for Docker Bind Host Custom Property for a deployment must match paths on this list to be valid.
     Allowed Values allow custom values
     Applies to:

Applications (allow multi select)

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers No
          Required for Deployment No
          Editable by Developers No

 

Docker Bind Shared
General Settings  
     Name DockerBindShared
     Display Name Docker Bind Shared
     Description Sub-directory path to mount outside the container file system. Mount will be placed in the Docker Bind Shard Directory set by Platform Operators for all containers using this type of mount. Files placed here will be persisted after the life of a single container.
     Allowed Values allow custom values
     Applies to:

Applications (allow multi select)

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Bind Shared Root Directory
General Settings  
     Name DockerBindSharedRootDir
     Display Name Docker Bind Shared Root Directory
     Description Root path used to place mounts given for Docker Bind Shared for all deployments using shared bind mounting. Set by Platform Operators for all servers.
     Allowed Values /apprenda/docker-binds, allow custom values
     Applies to:

Applications (allow multi select)

Default Value(s) /apprenda/docker-binds
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers No
          Required for Deployment No
          Editable by Developers No

 

Docker Bind Local
General Settings  
     Name DockerBindLocal
     Display Name Docker Bind Local
     Description Directory path to mount inside a container file system. Data placed here will only remain throughout the lifecycle of the container.
     Allowed Values allow custom values
     Applies to:

Applications (allow multi select)

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Bind Directory Permissions
General Settings  
     Name DockerBindDirPermissions
     Display Name Docker Bind Directory Permissions
     Description Permissions to be used on bind directories created during deployments. Default: 0777
     Allowed Values 0777, allow custom values
     Applies to:

Applications (allow multi select)

Default Value(s): 0777
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers No
          Required for Deployment No
          Editable by Developers No

 

Readiness Check Management

These Custom Properties configure the Platform to perform Readiness Checks on newly deployed containers to test for the container's readiness to fulfill routed requests. Read more information on container readiness checks.

  • Docker Readiness Check
  • Docker Readiness Check Path
  • Docker Readiness Check Schema
  • Docker Readiness Check Timeout Seconds
Docker Readiness Check
General Settings  
     Name DockerReadinessCheck
     Display Name Docker ReadinessCheck
     Description Determines if the Platform should perform a readiness check for deployed containers. If yes, requests will not be routed to a newly deployed container until the readiness check passes. A passing check means the URL path used for Docker Readiness Check Path returns HTTP response longer than 300 characters. Default: No
     Allowed Values Yes, No
     Applies to:

Applications

Default Value(s): No
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Readiness Check Path
General Settings  
     Name DockerReadinessCheckPath
     Display Name Docker Readiness Check Path
     Description If Docker Readiness Check is enabled, this sets the path the Platform sends requests to in order to test for readiness.
     Allowed Values  /, allow custom values
     Applies to:

Applications

Default Value(s):  /
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Readiness Check Scheme
General Settings  
     Name DockerReadinessCheckScheme
     Display Name Docker Readiness Check Scheme
     Description URL scheme to use for checks
     Allowed Values  http, https
     Applies to:

Applications

Default Value(s):  http
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Readiness Check Timeout Seconds
General Settings  
     Name DockerReadinessCheckTimeoutSecs
     Display Name Docker Readiness Check Timeout Seconds
     Description The length of time (in seconds) the Platform will wait for a readiness check to finish before timing out
     Allowed Values 300, allow custom values
     Applies to:

Applications

Default Value(s):  300
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Networking Management

The following Custom Properties can be used to configure the networking requirements for contain deployments. Read more on overlay networking.

  • Docker Network
  • Docker Network Scope
Docker Network
General Settings  
     Name DockerNetwork
     Display Name Docker Network
     Description The network name to use for the container
     Allowed Values allow custom values
     Applies to:

Applications

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Network Scope
General Settings  
     Name DockerNetworkScope
     Display Name Docker Network Scope
     Description Defines the scope of the overlay network of the application participates in
     Allowed Values App, Tenant, Global
     Applies to:

Applications

Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Image Management

These Custom Properties configure how Docker images are handled during container deployment.

  • Docker Image Name
  • Docker Image Tag
  • Docker Force Pull
  • Docker Remove Image
Docker Image Name
General Settings  
     Name DockerImageName
     Display Name Docker Image Name
     Description Name of the image to deploy container and its  repository. Value must include registry and image name, formatted asregistry/imageName
     Allowed Values Allow custom values
     Applies to: Applications
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment Yes
          Editable by Developers Yes

 

Docker Image Tag
General Settings  
     Name DockerImageTag
     Display Name Docker Image Tag
     Description Specific tag to use when pulling an image to use in a deployment
     Allowed Values Allow custom values
     Applies to: Applications
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Force Pull
General Settings  
     Name DockerForcePull
     Display Name Docker Force Pull
     Description Set by Platform Operators to force a new image to be pulled from the repository for every deployment
     Allowed Values Yes, No
     Applies to: Applications
Default Value(s) No
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers No
          Required for Deployment No
          Editable by Developers No

 

Docker Remove Image
General Settings  
     Name DockerRemoveImage
     Display Name Docker Remove Image
     Description Set by Platform Operators to remove a cached image from a server if no container is using it.
     Allowed Values Yes, No
     Applies to: Applications
Default Value(s) No
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers No
          Required for Deployment No
          Editable by Developers No

 

Container Defaults

The follow Custom Properties should be used to override some container defaults.

  • Docker Command
  • Docker Entrypoint
Docker Command
General Settings  
     Name DockerCmd
     Display Name Docker Command
     Description Overrides the default command that runs on container start-up
     Allowed Values allow custom values
     Applies to: Applications
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

 

Docker Entrypoint
General Settings  
     Name DockerEntrypoint
     Display Name Docker Entrypoint
     Description Overrides the default entrypoint for the container
     Allowed Values Yes, No
     Applies to: Applications
Default Value(s) No
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes

Container Ports

Use the following property to manage ports assigned to containers.

  • Docker Port Mapping (valid for Docker Deployer 1.7 and later)
Docker Port Mapping
General Settings  
     Name DockerPortMapping
     Display Name Docker Port Mapping
     Description Defines the ports the Platform should assign at container start up.
     Allowed Values allow custom values
     Applies to: Applications
Application Settings  
     Scope Application Component Level: Linux Services
     Developer Visibility  
          Visible to Developers Yes
          Required for Deployment No
          Editable by Developers Yes