Skip to content

Commit

Permalink
Document tags JenkinsID, description and jenkins-label list (#203)
Browse files Browse the repository at this point in the history
Co-authored-by: Tim Jacomb <21194782+timja@users.noreply.github.com>
  • Loading branch information
dzauzig and timja committed Jul 19, 2023
1 parent bed19fb commit c4e8b63
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
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

0 comments on commit c4e8b63

Please sign in to comment.