garden job from garden-runc/1.16.4

Github source: 5cf0a27 or master branch

Properties¶

`bpm`¶

enabled¶

Use bpm. NOTE: this requires a recreate when enabling for the first time, otherwise old containers may be left running
Default
false

`garden`¶

additional_bpm_volumes¶

An array of additional volumes which will be mounted into the BPM container. Note: Can only be used when deploying with BPM to mount in existing volumes.
Default
[]
additional_dns_servers¶

Additional DNS servers to be used in containers; extends those used on the host or those set by dns_servers property
Default
[]
additional_host_entries¶

Additional hosts file entries to be used in containers.
Default
[]
allow_host_access¶

A boolean stating whether or not containers started on this host should be able to reach this host. Changing the value on an existing deployment requires a recreate
Default
false
apparmor_profile¶

AppArmor profile to use for unprivileged container processes
Default
garden-default
cleanup_process_dirs_on_wait¶

A boolean stating whether or not to cleanup process state after waiting for it. If set a process can be waited for only once.
Default
false
cpu_quota_per_share_in_us¶

Maximum number of microseconds each cpu share assigned to a container allows per quota period. When set to zero cpu limit is disabled.
Default
0
debug_listen_address¶

tcp address on which to serve debug info

default_container_blockio_weight¶

default blkio.weight value for containers. Valid values are 0 (use system default), or 10 - 1000.
Default
0
default_container_grace_time¶

duration after which to reap idle containers
Default
0
default_container_rootfs¶

path to the rootfs to use when a container specifies no rootfs
Default
/var/vcap/packages/busybox/busybox-1.27.2.tar
deny_networks¶

List of CIDR blocks to which containers will be denied access.
Default
[]
deprecated_use_garden_shed¶

Use the deprecated garden-shed component for image management. The image_plugin property overrides this and if neither property is set, GrootFS will be used.
Default
false
destroy_containers_on_start¶

If true, all existing containers will be destroyed any time the garden server starts up
Default
false
disable_swap_limit¶

If true, container is not going to be limited in swap space. Should only be used if swap is disabled on the VM.
Default
false
dns_servers¶

Override DNS servers to be used in containers; defaults to the same as the host
Default
[]
docker_registry_endpoint¶

An URL pointing to the Docker registry to use to fetch Docker images. If unset, this will default to the Docker default.

dropsonde¶

destination¶

A URL that points at the Metron agent to which metrics are forwarded. By default, it matches with the default of Metron.

origin¶

A string identifier that will be used when reporting metrics to Dropsonde.

experimental_containerd_mode¶

(Under development) Use containerd for container lifecycle management. NOTE: cannot be used in combination with bpm or rootless
Default
false
experimental_rootless_mode¶

A boolean stating whether or not to run garden-server as a non-root user
Default
false
experimental_tcp_mem_limit_in_bytes¶

Hard limit for the tcp buffer memory in bytes. When set to zero tcp memory limit is disabled.
Default
0
experimental_use_containerd_mode_for_processes¶

(Under development) Use containerd for container process management. Must be used with experimental_containerd_mode also set to true. NOTE: cannot be used in combination with bpm or rootless
Default
false
graph_cleanup_threshold_in_mb¶

DEPRECATED in favour of grootfs.reserved_space_for_other_jobs_in_mb, unless also using deprecated_use_garden_shed property.
Default
-1
http_proxy¶

Http proxy that Garden process should use

https_proxy¶

Https proxy that Garden process should use

image_plugin¶

Path to an optional image plugin binary

image_plugin_extra_args¶

An array of additional arguments which will be passed to the image plugin binary
Default
[]
insecure_docker_registry_list¶

DEPRECATED in favour of grootfs property, unless also using deprecated_use_garden_shed property.
Default
[]
listen_address¶

Garden server listening address.
Default
/var/vcap/data/garden/garden.sock
listen_network¶

Garden server connection mode (tcp or unix).
Default
unix
log_level¶

log level for the Garden server - can be debug, info, error or fatal
Default
info
max_containers¶

Maximum container capacity to advertise. It is not recommended to set this larger than 250.
Default
250
network_mtu¶

Maximum network transmission unit length in bytes. Defaults to the mtu of the interface that the host uses for outbound connections. Max allowed value is 1500. Changed value applies only to newly created containers.
Default
0
network_plugin¶

Path to an optional network plugin binary

network_plugin_extra_args¶

An array of additional arguments which will be passed to the network plugin binary
Default
[]
network_pool¶

A CIDR subnet mask specifying the range of subnets available to be assigned to containers.
Default
10.254.0.0/22
no_proxy¶

List of comma-separated hosts that should skip connecting to the proxy

persistent_image_list¶

List of Rootfs Paths (directories or docker URLs) which will never be deleted during graph cleanup
Default
[]
port_pool¶

size¶

An integer used to denote how many ports are avaliable for Net In calls. Uses the Garden default if not set.

start¶

An integer port number used to denote where ports should start being allocated for Net In calls. Uses the Garden default if not set.

privileged_image_plugin¶

Path to an optional privileged image plugin binary

privileged_image_plugin_extra_args¶

An array of additional arguments which will be passed to the privileged image plugin binary when creating privileged containers - these will be passed instead of the contents of image_plugin_extra_args
Default
[]
runtime_plugin¶

Path to a runtime plugin binary
Default
/var/vcap/packages/runc/bin/runc

`grootfs`¶

driver¶

To be deprecated: Filesystem driver to use. Only supported option is overlay-xfs.
Default
overlay-xfs
dropsonde_port¶

Local metron agent’s port.
Default
3457
graph_cleanup_threshold_in_mb¶

DEPRECATED in favour of grootfs.reserved_space_for_other_jobs_in_mb. Total size of all container image filesystem layers before graph cleanup is activated. -1 disables graph cleanup.
Default
-1
insecure_docker_registry_list¶

A list of IP:PORT tuples that we allow pulling docker images from using self-signed certificates.
Default
[]
log_level¶

Log level for grootfs - can be debug, info, error or fatal.
Default
info
reserved_space_for_other_jobs_in_mb¶

Amount of space the GC algorithm should attempt to keep free for other jobs. GC will delete unneeded layers as needed to keep this space free (but it cannot guarantee this space remains free if more containers are created than disk space allows). -1 disables GC.
Default
15360
skip_mount¶

Do not mount image root filesystem automatically, just return the mount information.
Default
false
tls¶

ca_cert¶

PEM-encoded tls client CA certificate for asset upload/download

cert¶

PEM-encoded tls certificate that can be used for client or server auth

key¶

PEM-encoded tls client key

`logging`¶

format¶
timestamp¶

Format for timestamp in component logs. Valid values are ‘unix-epoch’ and ‘rfc3339’.
Default
unix-epoch

Templates¶

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/garden/ directory (learn more).

bin/auplink (from bin/auplink)
bin/bpm-pre-start (from bin/bpm-pre-start.erb)
bin/envs (from bin/envs.erb)
bin/garden_start (from bin/garden_start.erb)
bin/garden_stop (from bin/garden_stop)
bin/grootfs-utils (from bin/grootfs-utils.erb)
bin/overlay-xfs-setup (from bin/overlay-xfs-setup)
config/bpm.yml (from config/bpm.yml.erb)
config/config.ini (from config/config.ini.erb)
config/garden-default (from config/garden-default.erb)
config/grootfs_config.yml (from config/grootfs_config.yml.erb)
config/privileged_grootfs_config.yml (from config/privileged_grootfs_config.yml.erb)
certs/remote-layer.cert (from certs/remote-layer.cert.erb)
certs/remote-layer.crt (from certs/remote-layer.crt.erb)
certs/remote-layer.key (from certs/remote-layer.key.erb)

Packages¶

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.

garden job from garden-runc/1.16.4

Properties¶

bpm¶

enabled¶

garden¶

additional_bpm_volumes¶

additional_dns_servers¶

additional_host_entries¶

allow_host_access¶

apparmor_profile¶

cleanup_process_dirs_on_wait¶

cpu_quota_per_share_in_us¶

debug_listen_address¶

default_container_blockio_weight¶

default_container_grace_time¶

default_container_rootfs¶

deny_networks¶

deprecated_use_garden_shed¶

destroy_containers_on_start¶

disable_swap_limit¶

dns_servers¶

docker_registry_endpoint¶

dropsonde¶

destination¶

origin¶

experimental_containerd_mode¶

experimental_rootless_mode¶

experimental_tcp_mem_limit_in_bytes¶

experimental_use_containerd_mode_for_processes¶

graph_cleanup_threshold_in_mb¶

http_proxy¶

https_proxy¶

image_plugin¶

image_plugin_extra_args¶

insecure_docker_registry_list¶

listen_address¶

listen_network¶

log_level¶

max_containers¶

network_mtu¶

network_plugin¶

network_plugin_extra_args¶

network_pool¶

no_proxy¶

persistent_image_list¶

port_pool¶

size¶

start¶

privileged_image_plugin¶

privileged_image_plugin_extra_args¶

runtime_plugin¶

grootfs¶

driver¶

dropsonde_port¶

graph_cleanup_threshold_in_mb¶

insecure_docker_registry_list¶

log_level¶

reserved_space_for_other_jobs_in_mb¶

skip_mount¶

tls¶

ca_cert¶

cert¶

key¶

logging¶

format¶

timestamp¶

Templates¶

Packages¶

`bpm`¶

`enabled`¶

`garden`¶

`additional_bpm_volumes`¶

`additional_dns_servers`¶

`additional_host_entries`¶

`allow_host_access`¶

`apparmor_profile`¶

`cleanup_process_dirs_on_wait`¶

`cpu_quota_per_share_in_us`¶

`debug_listen_address`¶

`default_container_blockio_weight`¶

`default_container_grace_time`¶

`default_container_rootfs`¶

`deny_networks`¶

`deprecated_use_garden_shed`¶

`destroy_containers_on_start`¶

`disable_swap_limit`¶

`dns_servers`¶

`docker_registry_endpoint`¶

`dropsonde`¶

`destination`¶

`origin`¶

`experimental_containerd_mode`¶

`experimental_rootless_mode`¶

`experimental_tcp_mem_limit_in_bytes`¶

`experimental_use_containerd_mode_for_processes`¶

`graph_cleanup_threshold_in_mb`¶

`http_proxy`¶

`https_proxy`¶

`image_plugin`¶

`image_plugin_extra_args`¶

`insecure_docker_registry_list`¶

`listen_address`¶

`listen_network`¶

`log_level`¶

`max_containers`¶

`network_mtu`¶

`network_plugin`¶

`network_plugin_extra_args`¶

`network_pool`¶

`no_proxy`¶

`persistent_image_list`¶

`port_pool`¶

`size`¶

`start`¶

`privileged_image_plugin`¶

`privileged_image_plugin_extra_args`¶

`runtime_plugin`¶

`grootfs`¶

`driver`¶

`dropsonde_port`¶

`graph_cleanup_threshold_in_mb`¶

`insecure_docker_registry_list`¶

`log_level`¶

`reserved_space_for_other_jobs_in_mb`¶

`skip_mount`¶

`tls`¶

`ca_cert`¶

`cert`¶

`key`¶

`logging`¶

`format`¶

`timestamp`¶