Skip to content

Commit f1f9055

Browse files
committed
Update README
[Ticket: CATDE-4664]
1 parent efecce0 commit f1f9055

File tree

5 files changed

+10
-43
lines changed

5 files changed

+10
-43
lines changed

README.md

+7-12
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,13 @@ Dockerfiles are included for building both the parent image and application.
1414
## Environment Variables
1515
The environment variables below are required:
1616

17-
```
18-
FIRESTORE_PROJECT # Name of the GCP project containing the Firestore project
19-
MONITORING_PROJECT # Name of the GCP project containing the Cloud Pub/Sub topic to post alerts to
20-
SLACK_PUBSUB_TOPIC # Name of the Cloud Pub/Sub topic to post alerts to
21-
STATUS_ALERTS_SLACK_CHANNEL # Name of the Slack channel to post alerts to
22-
```
23-
24-
The environment variable below is optional:
25-
26-
```
27-
FIRESTORE_CREDENTIALS # Path to the GCP service account JSON key (used when running locally)
28-
```
17+
| Variable | Purpose |
18+
|-------------------------------|---------------------------------------------------------------------------------|
19+
| `ENVIRONMENT` | Name of the environment i.e. development or production. |
20+
| `FIRESTORE_PROJECT` | Name of the Google Cloud project containing the Firestore project |
21+
| `MONITORING_PROJECT` | Name of the Google Cloud project containing the Pub/Sub topic to post alerts to |
22+
| `SLACK_PUBSUB_TOPIC` | Name of the Pub/Sub topic to post alerts to |
23+
| `STATUS_ALERTS_SLACK_CHANNEL` | Name of the Slack channel to post alerts to |
2924

3025
## Providers
3126
Updates from a status feed source are implemented by providers, which are simply classes within the `providers` directory that conform to these rules:

app/Dockerfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
FROM europe-west2-docker.pkg.dev/ons-ci/ons-ci/cloud-status-alerter-parent-image:latest
1+
# FROM europe-west2-docker.pkg.dev/ons-ci/ons-ci/cloud-status-alerter-parent-image:latest
2+
FROM eu.gcr.io/ons-catd-apps/cloud-status-alerter-parent-image
23

34
WORKDIR /usr/src/app
45
COPY Gemfile Gemfile.lock ./

app/cloud_status_alerter.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
require 'google/cloud/firestore'
99
require 'google/cloud/pubsub'
1010

11-
require_relative 'message_formatter'
11+
require_relative 'lib/message_formatter'
1212

1313
# Class that asks providers for their status updates and posts corresponding alerts to a specified Slack channel.
1414
class CloudStatusAlerter
File renamed without changes.

app/providers/notify.rb

-29
This file was deleted.

0 commit comments

Comments
 (0)