Updating the readme #3507
Open
Updating the readme #3507
+97
−74
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
February 5, 2025 09:08
xray-daemon xray 212 2025-02-05 18:38:36.754084717 +0000 UTC deployed aws-xray-4.0.8 3.3.12
ingress nginx 213 2025-02-05 18:38:37.365688245 +0000 UTC deployed nginx-ingress-1.1.2 3.4.2
Comparing release=notify-documentation, chart=charts/notify-documentation
Comparing release=notify-api, chart=charts/notify-api
Comparing release=notify-admin, chart=charts/notify-admin
Comparing release=notify-document-download, chart=charts/notify-document-download
Comparing release=notify-celery, chart=charts/notify-celery
Comparing release=k8s-event-logger, chart=/tmp/helmfile4128350631/amazon-cloudwatch/staging/k8s-event-logger/k8s-event-logger/1.1.8/k8s-event-logger
Comparing release=karpenter-crd, chart=/tmp/helmfile4128350631/karpenter/staging/karpenter-crd/karpenter-crd/0.36.1/karpenter-crd
Comparing release=karpenter, chart=/tmp/helmfile4128350631/karpenter/staging/karpenter/karpenter/0.36.1/karpenter
Comparing release=karpenter-nodepool, chart=charts/karpenter-nodepool
Comparing release=priority-classes, chart=deliveryhero/priority-class
Comparing release=secrets-store-csi-driver, chart=secrets-store-csi-driver/secrets-store-csi-driver
Comparing release=aws-secrets-provider, chart=aws-secrets-manager/secrets-store-csi-driver-provider-aws
Comparing release=kube-state-metrics, chart=prometheus-community/kube-state-metrics
Comparing release=blazer, chart=stakater/application
Comparing release=ingress, chart=charts/nginx-ingress
Comparing release=xray-daemon, chart=okgolove/aws-xray
Comparing release=ipv4-geolocate, chart=charts/ipv4-geolocate |
jzbahrai
reviewed
Feb 5, 2025
README.md
Outdated
|
|
||
| You can now reference the variable in you other manifest files using `$(FOO)`. | ||
| Since the API is run on both kubernetes and AWS Lambda, you will need to modify the Terraform parameter store configuration as well. Follow the steps in the preceeding section and then [update the terraform file as necessary.](https://github.com/cds-snc/notification-terraform/blob/main/aws/lambda-api/secrets_manager.tf) |
There was a problem hiding this comment.
because you say "as well" here, does that mean the above section if required for API + this section is required for API? If so we need to make that clear and change this heading for example:
https://github.com/cds-snc/notification-manifests/blob/cbe51b75bbd06ccb7df04b6c64f4b33277e9cd30/README.md#steps-for-everything-but-api
There was a problem hiding this comment.
Reworded to make it clear you need to both
README.md
Outdated
|
|
||
| ``` | ||
|
|
||
| under the `vars:` key. | ||
| ### Steps for API |
There was a problem hiding this comment.
Steps for API Lambda (always do this if you are updating an API secret)
There was a problem hiding this comment.
Changed this to Steps for API Lambda to make it clear this is required for Lambda. I left out the always do this part...hopefully it's good enough?
README.md
Outdated
|
|
||
| If the value you are adding is a secret, DO NOT USE THIS METHOD. [Instead follow the instructions in the adding a secret document.](https://github.com/cds-snc/notification-terraform/blob/main/docs/creatingSecrets.md) | ||
|
|
||
| ### Steps for everything but API |
README.md
Outdated
|
|
||
| ### Encrypting variables in staging/production | ||
| To add an environment variable for admin or celery, you will need to update up to 3 files. |
There was a problem hiding this comment.
To add an environment variable for admin , API, celery, you will need to update up to 3 files.
whabanks
reviewed
Feb 5, 2025
Co-authored-by: William B <[email protected]>
jimleroyer
reviewed
Feb 5, 2025
README.md
Outdated
| @@ -4,122 +4,145 @@ Kubernetes manifest files for [notification.canada.ca](https://notification.cana | |||
|
|
|||
| ## How does this repository work? | |||
|
|
|||
| This repository uses version 2.0.3 of [Kustomize](https://github.com/kubernetes-sigs/kustomize/tree/v2.0.3), which is baked into `kubectl` to apply different environment overlays (staging, production), on to an existing base configuration. As a result the `base` directory describes all the commonalities between all environments, while the [`env/staging`](env/staging) and [`env/production`](env/production) directories contain the environment specific configurations. These include: | |||
| Notify components are deployed to Kubernetes using [helm](https://helm.sh/) and [helmfile](https://github.com/helmfile/helmfile). This allows us to do "diffs" on our environments, and apply applications surgically using labeles. | |||
There was a problem hiding this comment.
Small typo and addition
Suggested change
| Notify components are deployed to Kubernetes using [helm](https://helm.sh/) and [helmfile](https://github.com/helmfile/helmfile). This allows us to do "diffs" on our environments, and apply applications surgically using labeles. | |
| Notify components are deployed to Kubernetes using [helm](https://helm.sh/) and [helmfile](https://github.com/helmfile/helmfile). This allows us to do "diffs" on our environments, leverage charts for reusable modules, and apply applications surgically using labels. |
There was a problem hiding this comment.
Fixed this manually - thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What happens when your PR merges?
Updating the readme to reflect the realities of helm/helmfile
Rendered File
After merging this PR