Skip to content

Move Handling Secrets to a separate page, add docs for CredentialsProvider and encrypted strings #1143

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

Merged
merged 5 commits into from
Oct 11, 2019

Conversation

oleg-nenashev
Copy link
Member

@oleg-nenashev oleg-nenashev commented Oct 10, 2019

This is an attempt to improve documentation of the current state before submitting a pull request for #1141 . It should help guide users towards using Credential Providers when feasible, and it also documents current limitations of credentials.

I also used Asciidoc for the new page to have Table of Contents.

Preview: https://github.com/oleg-nenashev/configuration-as-code-plugin/blob/creds-documentation/docs/features/secrets.adoc

Your checklist for this pull request

🚨 Please review the guidelines for contributing to this repository.

  • Make sure you are requesting to pull a topic/feature/bugfix branch (right side) and not your master branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or in Jenkins JIRA
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Did you provide a test-case? That demonstrates feature works or fixes the issue.

@oleg-nenashev oleg-nenashev added the documentation A PR that adds to documentation - used by Release Drafter label Oct 10, 2019
@jetersen
Copy link
Member

Perhaps a good time to move run locally sometime noise in the main readme

@oleg-nenashev
Copy link
Member Author

@Casz Yes, I was about creating newbiew-friendly tickets for the rest of the documentation. Our front page is too loaded with details

@jetersen
Copy link
Member

Sounds reasonable for a good README that isn't too loaded I suggest looking at https://github.com/GitTools/GitVersion

@oleg-nenashev
Copy link
Member Author

Created few issues. If you have other ideas, please create tickets. One issue got implemented in less than 15 minutes. Power of Hacktoberfest 🎉

@oleg-nenashev
Copy link
Member Author

I am going to merge it without waiting for ci.jenkins.io.

@oleg-nenashev oleg-nenashev merged commit f8a502c into jenkinsci:master Oct 11, 2019
@oleg-nenashev oleg-nenashev deleted the creds-documentation branch October 11, 2019 10:50
Examples of available plugins:

* link:https://plugins.jenkins.io/kubernetes-credentials-provider[Kubernetes Credentials Provider]
* link:https://plugins.jenkins.io/aws-secrets-manager-credentials-provider[AWS Secrets Manager Credentials Provider]
Copy link
Member

Choose a reason for hiding this comment

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

@gavinfish it would be good if there was an azure plugin for this as well or the azure-credentials plugin supported it

Copy link
Member

Choose a reason for hiding this comment

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

@timja Thanks for your information. I have little bandwidth recently and I will put this in backlog temporarily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A PR that adds to documentation - used by Release Drafter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants