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

Improve Kubernetes examples in docs and commands #551

Merged
merged 2 commits into from
Aug 19, 2021

Conversation

puerco
Copy link
Member

@puerco puerco commented Aug 19, 2021

This PR adds two commits to improve the examples of Kubernetes secrets in the cosign sign and verify commands, as well as the documentation:

Add Kubernetes KMS entry and fix README example

This commit adds a Kubernetes section to the KMS document explaining how
to generate a key pair and a general overview of how cosign interacts
with secrets in the cluster.

Add Kubernetes secrets examples to cosign sign|verify

This commit adds kubernetes examples to the help output of cosign verify and cosign sign.

In addition, square and angled brackets used as placeholders in examples are modified to match the output of both subcommands.

Signed-off-by: Adolfo García Veytia (Puerco) [email protected]

This commit adds a Kubernetes section to the KMS document explaining how
to generate a key pair and a general overview of how cosign interacts
with secrets in the cluster.

Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
This commit adds kubernetes examples to the help output
of `cosign verify` and `cosign sign`.

In addition, square and angled brackets used as placeholders
in examples are modified to match in the output of both subcommands.

Signed-off-by: Adolfo García Veytia (Puerco) <[email protected]>
@puerco puerco changed the title Improve Kubernetes exampels in docs and commands Improve Kubernetes examples in docs and commands Aug 19, 2021
@cpanato cpanato added this to the v1.1.0 milestone Aug 19, 2021
@dlorenc
Copy link
Member

dlorenc commented Aug 19, 2021

Welcome Puerco!

@dlorenc dlorenc merged commit 001d55f into sigstore:main Aug 19, 2021
@developer-guy
Copy link
Member

Thank you so much for this @puerco 🎊🥳🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants