Skip to content

nfsv3driver job from nfs-volume/2.1.0

Github source: 22e8ca4 or master branch

Properties

bpm

enabled

Experimental: use the BOSH Process Manager to manage the nfsv3driver process.

Default
false

nfsv3driver

admin_addr

address nfsv3driver listens on for admin requests

Default
127.0.0.1:7590

allowed-in-mount

Comma separated list of white-listed options that may be accepted in the mount_config options. Note a specific ‘sloppy_mount:true’ volume option tells the driver to ignore non-white-listed options, while a ‘sloppy_mount:false’ tells the driver to fail fast instead when receiving a non-white-listed option.

Default
auto_cache,version
Example
allow_root,allow_other,nfs_uid,nfs_gid,auto_cache,sloppy_mount,fsname,version

allowed-in-source

Comma separated list of white-listed options that may be configured in supported in the mount_config.source URL query params

Default
uid,gid
Example
uid,gid,auto-traverse-mounts,dircache

cell_mount_path

path to mount volumes into on the cell

Default
/var/vcap/data/volumes/nfs

debug_addr

address nfsv3driver will serve debug info

Default
127.0.0.1:7689

default-in-mount

Comma separated list default values for options that may be configured in the mount_config options, formatted as ‘option:default’. If an option is not specified in the volume mount, or the option is not white-listed, then the specified default value will be used instead.

Default
auto_cache:true
Example
allow_root:false,nfs_uid:2000,nfs_gid:2000,auto_cache:true,sloppy_mount:true,version:4.1

default-in-source

Comma separated list of default values for options in the source URL query params, formatted as ‘option:default’. If an option is not specified in the volume mount, or the option is not white-listed, then the specified default value will be applied.

Default
""
Example
uid:1000,gid=1000,auto-traverse-mounts=1

disable

disable nfsv3driver

Default
false

driver_path

path to place driver spec/json file for volman to discover

Default
/var/vcap/data/voldrivers

enable_unique_volume_ids

opt-in to unique volume IDs

Default
true

ldap_ca_cert

ldap server CA certificate. If not provided driver will be connecting to LDAP server without TLS

Default
""
Example
'| -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'

ldap_host

ldap server host name or ip address (required for LDAP integration only)

Default
""

ldap_port

ldap server port (required for LDAP integration only)

Default
389

ldap_proto

ldap server protocol (required for LDAP integration only)

Default
tcp

ldap_svc_password

ldap service account password (required for LDAP integration only)

Default
""

ldap_svc_user

ldap service account user name (required for LDAP integration only)

Default
""

ldap_user_fqdn

ldap fqdn for user records we will search against when looking up user uids (required for LDAP integration only)

Default
""
Example
cn=Users,dc=corp,dc=test,dc=com

listen_addr

address nfsv3driver listens on

Default
127.0.0.1:7589

log_level

nfsv3driver log level

Default
info

log_time_format

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

Default
rfc3339

ssl

insecure_skip_verify

When connecting over SSL, skip verification of server IP addresses in the certificate

Default
false

tls

ca_cert

PEM encoded CA certificate. If not provided, driver will not accept TLS connections

Default
""
Example
'| -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'
client_cert

PEM encoded client certificate

Default
""
Example
'| -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'
client_key

PEM encoded client private key

Default
""
Example
'| -----BEGIN RSA PRIVATE KEY----- // EXAMPLE ... -----END RSA PRIVATE KEY-----'
server_cert

PEM encoded server certificate

Default
""
Example
'| -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'
server_key

PEM encoded server private key

Default
""
Example
'| -----BEGIN RSA PRIVATE KEY----- // EXAMPLE ... -----END RSA PRIVATE KEY-----'

Templates

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

  • bin/drain (from drain.erb)
  • bin/nfsv3driver_ctl (from ctl.erb)
  • bin/pre-start (from install.erb)
  • bin/start.sh (from start.sh.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • config/certs/ca.crt (from ca.crt.erb)
  • config/certs/client.crt (from client.crt.erb)
  • config/certs/client.key (from client.key.erb)
  • config/certs/server.crt (from server.crt.erb)
  • config/certs/server.key (from server.key.erb)

Packages

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