Skip to content

Clean up documentation on secrets#12387

Merged
electrum merged 1 commit intotrinodb:masterfrom
colebow:colebow/secrets-docs
May 20, 2022
Merged

Clean up documentation on secrets#12387
electrum merged 1 commit intotrinodb:masterfrom
colebow:colebow/secrets-docs

Conversation

@colebow
Copy link
Copy Markdown
Member

@colebow colebow commented May 13, 2022

Description

Fixing a few minor issues in the secrets documentation, as well as adding a sentence to clarify that environment variables can be contained within a scope.

Is this change a fix, improvement, new feature, refactoring, or other?

Improvement

Is this a change to the core query engine, a connector, client library, or the SPI interfaces? (be specific)

Docs

How would you describe this change to a non-technical end user or system administrator?

We're improving documentation.

Related issues, pull requests, and links

Documentation

( ) No documentation is needed.
(x) Sufficient documentation is included in this PR.
( ) Documentation PR is available with #prnumber.
( ) Documentation issue #issuenumber is filed, and can be handled later.

Release notes

(x) No release notes entries required.
( ) Release notes entries required with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

@cla-bot cla-bot bot added the cla-signed label May 13, 2022
@colebow colebow requested review from electrum and mosabua May 13, 2022 18:54
@github-actions github-actions bot added the docs label May 13, 2022
@colebow colebow marked this pull request as ready for review May 13, 2022 19:06
@mosabua
Copy link
Copy Markdown
Member

mosabua commented May 13, 2022

I feel like we need to be even more explicit in the sense that the env variable value can be retrieved from a secret management system on the fly as part of the startup script or by the provisioning system..

and this enables a system where no secret is stored anywhere on the Trino cluster itself and everything is just in memory of the Trino startup scripts and JVM runtime..

Check with @jefflester on user facing wording that might help

@colebow colebow requested a review from jefflester May 16, 2022 19:41
@jefflester
Copy link
Copy Markdown

@mosabua I met with @colebow today to review this and I thought it looked good. Calling out the scope is the most important part to this which I think was achieved. Thumbs-up on my side 👍

@electrum electrum merged commit f2ab55b into trinodb:master May 20, 2022
@github-actions github-actions bot added this to the 382 milestone May 20, 2022
@colebow colebow deleted the colebow/secrets-docs branch May 31, 2022 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants