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.

Sign up for GitHub

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

Jump to bottom

Document tags JenkinsID, description and jenkins-label list #203

Merged
merged 2 commits into from
Jul 19, 2023
Merged

Document tags JenkinsID, description and jenkins-label list #203

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e894ce6
Document tags JenkinsID, description and jenkins-label list
dzauzig Jul 18, 2023
01228a1
Apply suggestions from code review
timja Jul 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,8 +411,28 @@ az keyvault secret set --vault-name my-vault \
--tags username=testUserWithLabel type=username jenkins-label=myCustomLabel
```

Multiple label selectors can be specified as a comma separated list:

```bash
az keyvault secret set --vault-name my-vault \
--name testUserWithLabel \
--value example2 \
--tags jenkins-label=myCustomLabel1,myCustomLabel2
```

With the System Property or Environment variable being set in this example, only the usernamePassword `testUserWithLabel` will be present in your Jenkins instance.

#### Jenkins Credential ID and Description

The ID and description of credentials can be specified with tags on the Azure Key Vault secret. The ID is specified with the tag "jenkinsID" and appears in the Jenkins credentials UI in the "ID" column. This is the credentials ID parameter used in `withCredentials()` calls. The description is specified with the tag "description" and appears in Jenkins credentials UI in the "Name" column.

```bash
az keyvault secret set --vault-name my-vault \
--name testUserWithLabel \
--value example2 \
--tags jenkinsID=myCred description="This is my credential"
```

### SecretSource

The plugin allows the [Configuration as Code plugin](https://plugins.jenkins.io/configuration-as-code) to interpolate string secrets from Azure KeyVault.
Expand Down