Skip to content

deploy-notifications job from notifications/73.0.0

Github source: 42e9d3a or master branch

Properties

domain

Cloud Foundry System Domain

notifications

app_domain

Domain used to host application

app_go_package_name

Go package name used to enable native vendoring in the Go Buildpack

Default
github.com/cloudfoundry-incubator/notifications

app_go_version

Targeted Go version used to run the application

Default
go>=1.20.0

buildpack_url

Optional parameter that specifies the url of the buildpack to use. Helpful if your environment does not have the latest Go buildpack.

cf

dial_timeout

CF CLI connection dial timeout

Default
5

database

ca_cert

CA certificate for authenticating the database connection

common_name

CA common name for authenticating the database connection

database

Database name for the database connection

host

Host (IP or domain) for the database connection

max_open_connections

Maximum number of open connections to the database

password

Password for the database connection

port

Port for the database connection

tls
enable_identity_verification

Whether to verify the identity of the database host when connecting with TLS. Set this to false to allow TLS connections to database providers that do not configure the database’s TLS certificate to include its hostname or IP, such as Google Cloud SQL or Azure SQL Database.

Default
true
url

URL pointing to database. When present, overrides database adapter, username, password, host, port, and database properties.

username

Username for the database connection

default_template

default template to use for the service

enable_diego

Enable deployment to diego

encryption_key

key used to encrypt unsubscribe IDs

error_on_misconfiguration

Throw error on service misconfiguration during deployment

Default
true

instance_count

number of instances of service to run

max_queue_length

Maximum number of jobs to have at a time

Default
5000

max_retries

Maximum number of retries.

Default
5

network

Network used to host application

organization

Organization that hosts the app

sender

Sender of the notification

smtp

auth_mechanism

SMTP Authentication mechanism, should be one of [none plain cram-md5]

crammd5_secret

Secret to use with CRAMMD5 auth mechanism

host

SMTP Host name

pass

Password of the SMTP user

port

SMTP port number

tls

Uses SMTP TLS

user

Username for the SMTP host

space

Space that hosts the app

syslog_url

External log service URL

uaa

admin_client_id

Admin client id of the UAA

admin_client_secret

Admin client secret of the UAA

client_id

Client id of the UAA

client_secret

Client secret of the UAA

ssl

skip_cert_verify

Whether to verify SSL certs when making HTTP and SMTP requests

Templates

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

  • bin/deploy.sh (from deploy.sh.erb)
  • bin/run (from run.sh.erb)
  • config/bpm.yml (from bpm.yml.erb)
  • database.crt (from database.crt.erb)
  • manifest.yml (from manifest.yml.erb)

Packages

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