Skip to content

Commit b8ef5df

Browse files
authored
fix: Pin the aws provider version for now due to a regression in newer versions, small docs fixes (#228)
1 parent 2a42ffd commit b8ef5df

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

doc-site/docs/components/kubernetes/external-secrets.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 3
55
---
66

77
## Overview
8-
Kubernetes External Secrets allows you to use external secret management systems, like AWS Secrets Manager or HashiCorp Vault, to securely add secrets in Kubernetes.
8+
Kubernetes External Secrets allows you to use external secret management systems, like AWS Secrets Manager or HashiCorp Vault, to securely add secrets in Kubernetes.
99

1010
## How it works
1111
The project extends the Kubernetes API by adding an ExternalSecrets object using Custom Resource Definition and a controller to implement the behavior of the object itself.
@@ -16,7 +16,7 @@ An ExternalSecret declares how to fetch the secret data, while the controller co
1616
Along with the database credentials, any other secrets that need to be provided to the application can be managed in AWS Secrets Manager.
1717
Secrets have been created for each environment called `<project-name>/kubernetes/<environment>/<project-name>` which contain a list of environment variables that will be synced with the kubernetes secret in your namespace via a tool called [external-secrets](https://github.com/external-secrets/kubernetes-external-secrets)
1818
Any secrets managed by `external-secrets` will be synced to kubernetes every 15 seconds. Keep in mind that any changes must be made in Secrets Manager, as any that are made to the secret on the kubernetes side will be overwritten.
19-
You can see the `external-secrets` configuration in [kubernetes/overlays/staging/external-secret.yml](https://github.com/commitdev/zero-deployable-backend/blob/main/templates/kubernetes/overlays/staging/external-secret.yml) (this is the one for staging)
19+
You can see the `external-secrets` configuration in [kubernetes/overlays/staging/external-secret.yml](https://github.com/commitdev/zero-backend-go/blob/main/templates/kubernetes/overlays/staging/external-secret.yml) (this is the one for staging)
2020

2121
To work with the secret in AWS you can use the web interface or the cli tool:
2222
```
@@ -28,4 +28,4 @@ The intent is that the last part of the secret name is the component of your app
2828
## Documentation
2929
Checkout [External secrets's documentation][docs] for more information.
3030

31-
[docs]: https://github.com/external-secrets/kubernetes-external-secrets#how-to-use-it
31+
[docs]: https://github.com/external-secrets/kubernetes-external-secrets#how-to-use-it

templates/kubernetes/terraform/modules/kubernetes/cache_service.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ locals {
1717
resource "kubernetes_service" "app_cache" {
1818
count = local.endpoint_address == "" ? 0 : 1
1919

20-
## this should match the deployable backend's name/namespace
20+
## this should match the backend service's name/namespace
2121
metadata {
2222
namespace = kubernetes_namespace.app_namespace.metadata[0].name
2323
name = "cache-${var.cache_store}"

templates/kubernetes/terraform/modules/kubernetes/database_service.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ data "aws_db_instance" "database" {
55

66
resource "kubernetes_service" "app_db" {
77
count = var.create_database_service ? 1 : 0
8-
## this should match the deployable backend's name/namespace
8+
## this should match the backend service's name/namespace
99
## it uses this service to connect and create application user
10-
## https://github.com/commitdev/zero-deployable-backend/blob/b2cee21982b1e6a0ac9996e2a1bf214e5bf10ab5/db-ops/create-db-user.sh#L6
10+
## https://github.com/commitdev/zero-backend-go/blob/b2cee21982b1e6a0ac9996e2a1bf214e5bf10ab5/db-ops/create-db-user.sh#L6
1111
metadata {
1212
namespace = kubernetes_namespace.app_namespace.metadata[0].name
1313
name = "database"

templates/terraform/environments/prod/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ terraform {
1111
required_providers {
1212
aws = {
1313
source = "hashicorp/aws"
14-
version = "~> 3.7"
14+
version = "3.50" # Temporarily pinning the version here until this issue is resolved: https://github.com/hashicorp/terraform-provider-aws/issues/20787
1515
}
1616
}
1717
}

templates/terraform/environments/stage/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ terraform {
1111
required_providers {
1212
aws = {
1313
source = "hashicorp/aws"
14-
version = "~> 3.7"
14+
version = "3.50" # Temporarily pinning the version here until this issue is resolved: https://github.com/hashicorp/terraform-provider-aws/issues/20787
1515
}
1616
}
1717
}

0 commit comments

Comments
 (0)