Skip to content
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

Merged
merged 24 commits into from
Mar 27, 2024
Merged

Secrets Import documentation #25594

merged 24 commits into from
Mar 27, 2024

Conversation

robmonte
Copy link
Member

@robmonte robmonte commented Feb 22, 2024

Documentation, API documentation, and CLI documentation for secrets importing.

@robmonte robmonte added this to the 1.16.0 milestone Feb 22, 2024
@robmonte robmonte requested a review from a team as a code owner February 22, 2024 22:02
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Feb 22, 2024
Copy link

github-actions bot commented Feb 22, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@maxcoulombe maxcoulombe left a 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.

website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
## Configuration

The `operator import` command uses a dedicated configuration file to specify the source,
destination, and mapping rules.
Copy link
Contributor

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Member Author

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?

website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
## Configuration

The `operator import` command uses a dedicated configuration file to specify the source,
destination, and mapping rules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/operator/import.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@schavis schavis left a 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

website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/index.mdx Show resolved Hide resolved
website/content/docs/import/index.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
website/content/docs/import/mappings.mdx Outdated Show resolved Hide resolved
@digivava digivava added the docs label Mar 22, 2024
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
robmonte and others added 3 commits March 25, 2024 04:54
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Comment on lines 1 to 6
<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>
Copy link
Member Author

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.

Copy link
Contributor

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 👍🏽

website/content/docs/import/gcpsm.mdx Outdated Show resolved Hide resolved
website/content/docs/import/gcpsm.mdx Show resolved Hide resolved
website/content/docs/import/gcpsm.mdx Show resolved Hide resolved
website/content/docs/import/gcpsm.mdx Outdated Show resolved Hide resolved
website/content/docs/import/gcpsm.mdx Outdated Show resolved Hide resolved
website/content/docs/import/gcpsm.mdx Outdated Show resolved Hide resolved
{
"title": "<code>import</code>",
"path": "commands/operator/import"
},
Copy link
Contributor

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 <62406755+schavis@users.noreply.github.com>
@robmonte robmonte merged commit 5fac327 into main Mar 27, 2024
32 checks passed
@robmonte robmonte deleted the docs/secrets-import branch March 27, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/1.16.x Backport changes to `release/1.16.x` docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants