Skip to content

shield-agent job from shield/6.3.6

Github source: 299da624 or master branch

Properties

shield

agent

autoprovision

Optional HTTP API of the Shield installation to automatically provision authorized keys from

daemon_public_key

public key to permit access from a shield daemon

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
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

daemon

domain

Hostname/IP SHIELD is accessed with

port

port to run daemon (https requests)

Default
443

job

name

Job name

retention

Name of job retention

schedule

Name of job schedule

store

Name of job store

target

Name of job target

jobs

array of jobs to add

Example
|+
  localdb-weekly2amazon:
      target: localdb
      store: amazon
      retention: week
      schedule: weekly

log_level

Log level for shield processes

Default
info

provisioning_key

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

Default
""

skip_ssl_verify

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

Default
true

target

config

Hash of config information

name

Target name

plugin

Plugin type

targets

array of targets to add

Example
"localdb: \n  plugin: s3\n  config:\n    mysql_host: url \n"

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.erb)
  • bin/monit_debugger (from bin/monit_debugger)
  • bin/post-start (from bin/post-start.erb)
  • config/shield-agent.conf (from config/shield-agent.conf.erb)
  • data/properties.sh (from data/properties.sh.erb)
  • 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.