Skip to content

Commit 7fd5938

Browse files
authored
docs: moved test tip (#57)
1 parent bf2383a commit 7fd5938

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

examples/all-combined/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,3 @@ The example is split into separated templates related with their specific scope:
7878
The test is currently using the existing SecretManager region to deploy the VPC and the cluster if this value is not null. Instead if null it follows what set through `var.region`
7979

8080
This logic is achieved through the local `sm_region` variable that is then used to create resources.
81-
82-
### Note for the example maintainers
83-
84-
The test leverages on a set of secrets existing on IBM Cloud Secrets Manager instance to pull the secrets values and to configure them through External Secrets operator: the secrets for the imported certificate (public certificate stored in `geretain-eso-test-importedcert-public-certificate`, intermediate certificate store in `geretain-eso-test-importedcert-intermediate-certificate` and private key stored in `geretain-eso-test-importedcert-private-key`) expire periodically, in the case these secrets expire the new values can be retrieved from the secret named `geretain-eso-public-certificate-for-imported-ones` which contains the three different components (it is a public certificate generated for a test CN) and it is configured to be automatically rotated by Secrets Manager.

tests/pr_test.go

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,16 @@ func TestMain(m *testing.M) {
117117
os.Exit(m.Run())
118118
}
119119

120+
// Note for the test maintainers
121+
// The test leverages on a set of secrets existing on IBM Cloud Secrets Manager instance to pull
122+
// the secrets values and to configure them through External Secrets operator: the secrets for the imported certificate whose
123+
// - public certificate component is stored in `geretain-eso-test-importedcert-public-certificate`
124+
// - intermediate certificate component is stored in `geretain-eso-test-importedcert-intermediate-certificate`
125+
// - private key is stored in `geretain-eso-test-importedcert-private-key`
126+
// expire periodically: in such a case the new values to populate these secrets can be retrieved from the secret named `geretain-eso-public-certificate-for-imported-ones`
127+
// which is a public certificate generated for a test CN and contains the three different components whose value can be used to rotate the expired certificates
128+
// mentioned above. It is configured to be automatically rotated by Secrets Manager so its values are always up to date.
129+
120130
var ignoreUpdates = []string{
121131
"module.es_kubernetes_secret_usr_pass.helm_release.external_secrets_operator[0]",
122132
"module.es_kubernetes_secret_arbitrary_cloudant.helm_release.external_secrets_operator[0]",

0 commit comments

Comments
 (0)