Update Helm Chart and README (#8)

README.md

@@ -35,11 +35,11 @@ alerting:                 receivers:
 - Liveness and Readiness probes, at `/liveness` and `/readiness`.
 - Unit and Integration tests, approx 90% coverage.
 - Structured Logging.
+- Prometheus metrics at `/metrics`.
 
 ### Roadmap
 
 - Template Discord messages
-- Prometheus metrics at `/metrics`.
 - REST API documented with OpenAPI (Swagger) specification.
 
 ## Example alertmanager config
@@ -72,6 +72,22 @@ receivers:
 
 ## Deployment
 
+### Running binary
+
+```shell
+go run . --discord_webhook_url=https://discord.com/api/webhooks/123456789123456789/abc
+```
+
+You may instead provide the Discord webhook url by environment variable, `DISCORD_WEBHOOK_URL`, or via a configuration file:
+
+```yaml
+discord_webhook_url: https://discord.com/api/webhooks/123456789123456789/abc
+```
+
+```shell
+go run . --configuration_file_path=/path/to/your/config.yaml
+```
+
 ### Docker
 
 If you wish to deploy this to docker infra, you can find the docker hub repo here: https://hub.docker.com/r/speckle/alertmanager-discord/
@@ -80,6 +96,18 @@ If you wish to deploy this to docker infra, you can find the docker hub repo her
 
 If you wish to deploy this to Kubernetes, this repository contains a Helm Chart.
 
+Firstly, please deploy a Secret with your configuration information, the discord webhook url is required.:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: discord-config
+data:
+  "config.yaml": |
+    discord_webhook_url: https://discord.com/api/webhooks/123456789123456789/abc
+```
+
 ```shell
 helm upgrade --install \
 --create-namespace \

deploy/helm/README.md

@@ -30,7 +30,7 @@ A Helm chart to deploy alertmanager-discord to Kubernetes
 | securityContext.runAsNonRoot | bool | `true` |  |
 | securityContext.runAsUser | int | `1000` |  |
 | server.configuration.key | string | `"config.yaml"` |  |
-| server.configuration.name | string | `"discord-webhook"` | name of the Kubernetes Secret containing the configuration file, will be mounted to the container. Must be in the same namespace as this helm chart is deployed. |
+| server.configuration.name | string | `"discord-config"` | name of the Kubernetes Secret containing the configuration file, will be mounted to the container. Must be in the same namespace as this helm chart is deployed. |
 | service.port | int | `9094` | The port to which alertmanager should push alerts |
 | service.type | string | `"ClusterIP"` |  |
 | serviceAccount.annotations | object | `{}` | Annotations to add to the service account |

deploy/helm/values.schema.json

@@ -182,7 +182,7 @@
         "server": {
             "type": "object",
             "properties": {
-                "discordWebhookSecret": {
+                "configuration": {
                     "type": "object",
                     "properties": {
                         "name": {

deploy/helm/values.yaml

@@ -54,7 +54,7 @@ affinity: {}
 server:
   configuration:
     # -- name of the Kubernetes Secret containing the configuration file, will be mounted to the container. Must be in the same namespace as this helm chart is deployed.
-    name: discord-webhook
+    name: discord-config
     key: config.yaml
     # within the config.yaml data, it should be yaml formatted with the key `discord_webhook_url`, and optionally keys `listen_address` & `max_backoff_time_seconds`. An example of the data expected can be found at ./test/test-config.yaml