Skip to content

A BOSH release that contains the notifications application and an errand to push it

License

Notifications You must be signed in to change notification settings

cloudfoundry/notifications-release

Folders and files

NameName
Last commit message
Last commit date
Mar 4, 2025
Nov 25, 2024
Oct 3, 2017
Nov 7, 2022
Jan 16, 2025
Apr 12, 2024
Oct 7, 2024
Feb 21, 2018
Mar 4, 2025
Jan 17, 2025
Mar 18, 2025
Oct 3, 2017
Jun 1, 2015
Sep 27, 2014
Jun 22, 2017
Oct 26, 2017
Jun 12, 2023
Jul 17, 2014
Jul 25, 2014

Repository files navigation

Notifications Release

This release deploys the notification service as an application onto the CloudFoundry platform. A running CF is required to deploy. The application will be deployed into the system org, and the notifications-service space. The service registers itself at the address matching http://notifications.$CF_APP_DOMAIN.

Prerequisites

  1. Running UAA. This requirement is typically satisfied by having CloudFoundry deployed.
  2. Running MySQL instance. One option is to deploy the CloudFoundry MySQL release.

UAA Client

Notifications requires a UAA client to boot. The client can be created with the following properties:

scope: uaa.none
client_id: notifications
authorized_grant_types: client_credentials
authorities: scim.read,cloud_controller.admin

Bosh-lite

Tips

  • Use the latest notifications final release available, it generally contains bug-fixes.
  • Do not cut a release yourself unless you are very familiar wth bosh.

Steps

  1. Add SMTP properties to ./bosh-lite/notifications-smtp-stub.yml file as follows:
properties:
  notifications:
    smtp:
      host: stmp.example.com
      port: 587
      user: my-user-name
      pass: my-password
      auth_mechanism: plain
  1. Add DB properties to ./bosh-lite/notifications-db-stub.yml file for your running MySQL instance as follows:
properties:
  notifications:
    database:
      url: tcp://user:password@example.com:3306/dbname
  1. Generate manifest:
./bosh-lite/make_manifest
  1. Update the sub-modules of the release
./update
  1. Upload latest final release from the /releases dir:
bosh upload release releases/notifications/notifications-X.yml
  1. Deploy
bosh deploy
bosh run errand deploy-notifications

AWS

In addition to the stub file properties specified in the BOSH-Lite manifest, an AWS manifest stub file will require some extra infrastructure specific fields. Included below is an example:

infrastructure_properties:
  availability_zone: us-east-1a