-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Secrets Import documentation #25594
Secrets Import documentation #25594
Conversation
CI Results: |
Build Results: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good foundation! I'd be curious to see if @yhyakuna or Shailee have thoughts or someone that could help us organize some of this since this is a rather big chunk of new functionality.
An external perspective would be useful to complement our more detail-oriented perspective since we worked on the actual implementation.
## Configuration | ||
|
||
The `operator import` command uses a dedicated configuration file to specify the source, | ||
destination, and mapping rules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we explain what are these and what are the types & fields available in the HCL schema?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like instead of explaining here, it should just link to the main docs pages explaining the feature. What do you think?
## Configuration | ||
|
||
The `operator import` command uses a dedicated configuration file to specify the source, | ||
destination, and mapping rules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will finish reviewing the last three docs tomorrow
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
Co-authored-by: Sarah Chavis <[email protected]>
…plied, fix some typos/etc
<Warning title="Experimental"> | ||
|
||
Experimental features are features in an alpha state or available early in development to | ||
provide as a tech demo experience and are subject to change. | ||
**We strongly discourage using experimental features in production deployments of Vault.** | ||
Experimental features are tested but unproved. Until the feature is verified | ||
through heavy production use, proceed with caution. | ||
|
||
</Note> No newline at end of file | ||
</Warning> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By pure chance someone created a file with this exact same name yesterday before me. I changed the tags in my PR to alpha instead now because this description of experimental does not sound like it fits well with what we're aiming to provide here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was me, sorry about that! I agree that "alpha" is a better fit 👍🏽
{ | ||
"title": "<code>import</code>", | ||
"path": "commands/operator/import" | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I missed this comment in the original review. We don't currently separate docs based on experimental / alpha / beta status because it'll eventually reach GA and moving the docs around creates a subpar reader experience :)
Co-authored-by: Sarah Chavis <[email protected]>
Documentation, API documentation, and CLI documentation for secrets importing.