Skip to content

shield-agent job from shield/7.0.3

Github source: cf258d4 or master branch

Properties

autoprovision

Optional. Either ‘true’ to autoprovision via shield-daemon link; HTTP API of the SHIELD API to automatically retrieve the shield-daemon SSH Public Key from. You must at least specify this property, or the daemon_public_key property.

daemon_public_key

SSH Public Key used by the shield-daemon job to permit access to this agent. You must at least specify this property, or the autoprovision property.

env

http_proxy

The URL of an upstream HTTP proxy for proxying all unencrypted web communications (pursuant to env.no_proxy).

https_proxy

The URL of an upstream HTTP proxy for proxying all encrypted web communications (pursuant to env.no_proxy).

no_proxy

A list of domains, partial domains (i.e. “.example.com”), and IP addresses that should not be routed through env.http_proxy and env.https_proxy.

ip

IP address that the agent can be contacted at. Normally, this can be automatically detected, but for certain circumstances (i.e. bosh-init deployments), you must specify it.

jobs

A list of Jobs to autoprovision in SHIELD, keyed by name. You can optionally override the name of the job with a ‘name’ attribute. For example: jobs: my-backups: target: localdb store: amazon retention: longterm schedule: weekly

log_level

Log level for shield processes

Default
info

plugin_paths

Map of paths that the binary of the plugins can be found

Example
|+
  plugin_paths:
    atmos: /var/vcap/packages/atmos-plugin/bin

port

port to run agent

Default
5444

provisioning_key

API Key to use when provisioning jobs, or targets. Required if target or job have data

recovery

store_config

A map of key-values that will be converted to JSON, representing the store plugin configration

store_plugin

Store plugin to use in emergency-recovery-mode

target_config

A map of key-values that will be converted to JSON, representing the target plugin configration

target_plugin

Target plugin to use in emergency-recovery-mode

retention-policies

A list of Retention policies to autoprovision in SHIELD, keyed by name. For example: retention-policies: Short-term: 90d Long-term: 180d

schedules

A list of Schedules to autoprovision in SHIELD, keyed by name. For example: schedules: Daily: daily 4am Weekly: weekly on monday 3am

skip_ssl_verify

Boolean to determine if SSL certs will be ignored when provisioning SHIELD data

Default
true

stores

A list of Stores to autoprovision in SHIELD, keyed by name. You can optionally override the name of the store with a ‘name’ attribute. For example: stores: amazon: plugin: s3 config: secret_key: foo bucket: my-backups

targets

A list of Targets to autoprovision in SHIELD, keyed by name. You can optionally override the name of the target with a ‘name’ attribute. For example: targets: localdb: plugin: postgres config: pg_host: 10.0.0.6 pg_port: 5524 # etc.

Templates

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

  • bin/ctl (from bin/ctl)
  • bin/emergency-recovery (from bin/emergency-recovery)
  • bin/monit_debugger (from bin/monit_debugger)
  • bin/post-start (from bin/post-start)
  • config/shield-agent.conf (from config/shield-agent.conf)
  • helpers/ctl_setup.sh (from helpers/ctl_setup.sh)
  • helpers/ctl_utils.sh (from helpers/ctl_utils.sh)

Packages

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