diff --git a/.gitignore b/.gitignore index f6a8e1c..811d0d9 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ vendor .phpunit.result.cache reports /.idea +/.DS_Store diff --git a/README.md b/README.md index 96fa218..887e6f1 100644 --- a/README.md +++ b/README.md @@ -104,9 +104,35 @@ In some cases it will be necessary to have different values for the secret when **Note**: If the secret does not exist, there is no secret environment to override, and you will get an error. +```mermaid +classDiagram +OrgzaniationSecretAPIPassword --> SiteSecretAPIPassword +SiteSecretAPIPassword --> IntegratedComposerAPIPassword : no overrides +OrgzaniationSecretAPIPassword : string name apipassword +OrgzaniationSecretAPIPassword : string value ball00n +SiteSecretAPIPassword : Inherits value from Org +SiteSecretAPIPassword : No Overrides +IntegratedComposerAPIPassword: value ball00n + +OrgzaniationSecretOverrideExample --> SiteSecretOverrideExample +SiteSecretOverrideExample --> SiteSecretOverrideExampleDev : default value +SiteSecretOverrideExample --> SiteSecretOverrideExampleTest : env override value +SiteSecretOverrideExample --> SiteSecretOverrideExampleLive : env override value +OrgzaniationSecretOverrideExample : string name apipassword +OrgzaniationSecretOverrideExample : string value ball00n +SiteSecretOverrideExample : Inherits value from Org +SiteSecretOverrideExample : No Site Overrides +SiteSecretOverrideExampleDev: value ball00n +SiteSecretOverrideExampleDev: defaultValue() +SiteSecretOverrideExampleTest: value ball00n2 +SiteSecretOverrideExampleTest: overridden() +SiteSecretOverrideExampleLive: value ball00n3 +SiteSecretOverrideExampleLive: overridden() +``` + ## The life of a secret -When a given runtime (e.g. Integrated Composer runtime or the application runtime) fetches secrets for a given site (and env), the process will be as follows: +When a given runtime (e.g. Integrated Composer or an environment php runtime) fetches secrets for a given site (and env), the process will be as follows: - Fetch secrets for site (of the given type and scopes). @@ -149,7 +175,7 @@ Secrets Manager requires the following: - A Pantheon account - A site that uses [Integrated Composer](https://docs.pantheon.io/guides/integrated-composer) and runs PHP >= 8.0 -- Terminus 3 +- Terminus 3.0+ ### Installation