Skip to content

Commit

Permalink
Merge pull request #45 from pantheon-systems/CMSO-1352
Browse files Browse the repository at this point in the history
[ CMSO-1352 ] - Update Secrets Readme for EA
  • Loading branch information
stovak authored May 4, 2023
2 parents 94adc3b + 1dab410 commit 83ff183
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ vendor
.phpunit.result.cache
reports
/.idea
/.DS_Store
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 83ff183

Please sign in to comment.