Skip to content

nfsbroker job from nfs-volume/1.4.1

Github source: ce5afe6 or master branch

Properties

nfsbroker

allowed_options

comma separated list of white-listed options that may be set during create or bind operations.

Default
uid,gid,auto_cache,username,password,version
Example
uid,gid,allow_root,allow_other,nfs_uid,nfs_gid,auto_cache,fsname,username,password

credhub

ca_cert

(optional) CA Cert to verify credhub SSL connection. If not included connection will not be encrypted

Default
""
uaa_ca_cert

(optional) CA Cert to verify UAA SSL connection when using CredHub to store broker state

uaa_client_id

(optional) UAA client ID when using CredHub to store broker state

Default
""
uaa_client_secret

(optional) UAA client secret when using CredHub to store broker state

Default
""
url

(optional) CredHub URL when using CredHub to store broker state

Default
""

data_dir

(optional) Directory on broker VM to persist instance and binding state

Default
/var/vcap/store/nfsbroker

db_ca_cert

(optional) CA Cert to verify database SSL connection. If not included connection will not be encrypted

Default
""

db_driver

(optional) database driver name when using SQL to store broker state

Default
""

db_hostname

(optional) database hostname when using SQL to store broker state

Default
""

db_name

(optional) database name when using SQL to store broker state

Default
""

db_password

(optional) database password when using SQL to store broker state

Default
""

db_port

(optional) database port when using SQL to store broker state

Default
""

db_username

(optional) database username when using SQL to store broker state

Default
""

default_options

comma separated list default values for options. If a default is specified but the option is not in the allowed-options, then the default value will be set and cannot be overridden.

Default
auto_cache:true
Example
uid:1000,gid:1000,allow_root:false,allow_other:false,nfs_uid:2000,nfs_gid:2000,auto_cache:false

listen_addr

(optional) address nfsbroker listens on

Default
0.0.0.0:8999

password

basic auth password to verify on incoming Service Broker requests

services

List of services and plans supported by broker

Default
  - bindable: true
    description: 'Existing NFSv3 volumes (see: https://code.cloudfoundry.org/nfs-volume-release/)'
    id: nfsbroker
    name: nfs
    plan_updatable: false
    plans:
    - description: A preexisting filesystem
      id: Existing
      name: Existing
    requires:
    - volume_mount
    tags:
    - nfs
  - bindable: true
    description: Experimental support for NFSv3 and v4
    id: 997f8f26-e10c-11e7-80c1-9a214cf093ae
    name: nfs-experimental
    plan_updatable: false
    plans:
    - description: A preexisting filesystem
      id: 09a09260-1df5-4445-9ed7-1ba56dadbbc8
      name: Existing
    requires:
    - volume_mount
    tags:
    - nfs
    - experimental

store_id

(optional) Store ID used to namespace instance details and bindings in store (CredHub only)

Default
nfsbroker

username

basic auth username to verify on incoming Service Broker requests

Default
admin

Templates

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

  • bin/nfsbroker_ctl (from ctl.erb)
  • config/services.json (from services.json.erb)
  • credhub_ca.crt (from credhub_ca.crt.erb)
  • db_ca.crt (from db_ca.crt.erb)
  • uaa_ca.crt (from uaa_ca.crt.erb)

Packages

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