Skip to content

#23 Add support for Azure Key Vault #24

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

Open
matthewdevenny wants to merge 2 commits into
base: master
Choose a base branch
from
Open

#23 Add support for Azure Key Vault #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ba429b
#23 Add support for Azure Key Vault
matthewdevenny Oct 31, 2019
34a506c
#23 Fix bad merge
matthewdevenny Nov 1, 2019
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
7 changes: 7 additions & 0 deletions resources/com/boxboat/jenkins/config.example.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ awsProfileMap:
region: us-east-1
accessKeyIdCredential: aws-access-key-id
secretAccessKeyCredential: aws-secret-access-key
azureProfileMap:
default:
keyVaultName: your-keyvault-name
tenantIdCredential: azure-tenant-id
clientIdCredential: azure-client-id
clientSecretKeyCredential: azure-client-secret-key
deployTargetMap:
dev01: !!com.boxboat.jenkins.library.deployTarget.KubernetesDeployTarget
contextName: boxboat
Expand Down Expand Up @@ -61,6 +67,7 @@ vaultMap:
secretIdCredential: vault-secret-id
tokenCredential: vault-token
url: http://localhost:8200

repo:
common:
defaultBranch: master
Expand Down
31 changes: 31 additions & 0 deletions src/com/boxboat/jenkins/library/azure/AzureProfile.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package com.boxboat.jenkins.library.azure

import com.boxboat.jenkins.library.config.BaseConfig
import com.boxboat.jenkins.library.config.Config

class AzureProfile extends BaseConfig<AzureProfile> implements Serializable{

String keyVaultName

String tenantIdCredential

String clientIdCredential

String clientSecretKeyCredential

def withCredentials(Closure closure) {
List<Object> credentials = []
if (tenantIdCredential) {
credentials.add(Config.pipeline.string(credentialsId: tenantIdCredential, variable: 'AZURE_TENANT_ID',))
}
if (clientIdCredential) {
credentials.add(Config.pipeline.string(credentialsId: clientIdCredential, variable: 'AZURE_CLIENT_ID',))
}
if (clientSecretKeyCredential) {
credentials.add(Config.pipeline.string(credentialsId: clientSecretKeyCredential, variable: 'AZURE_CLIENT_SECRET',))
}
Config.pipeline.withCredentials(credentials) {
closure()
}
}
}
12 changes: 12 additions & 0 deletions src/com/boxboat/jenkins/library/config/GlobalConfig.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.boxboat.jenkins.library.config

import com.boxboat.jenkins.library.aws.AwsProfile
import com.boxboat.jenkins.library.azure.AzureProfile
import com.boxboat.jenkins.library.deployTarget.IDeployTarget
import com.boxboat.jenkins.library.docker.Registry
import com.boxboat.jenkins.library.environment.Environment
Expand All @@ -13,6 +14,8 @@ class GlobalConfig extends BaseConfig<GlobalConfig> implements Serializable {

Map<String, AwsProfile> awsProfileMap

Map<String, AzureProfile> azureProfileMap

Map<String, IDeployTarget> deployTargetMap

Map<String, Environment> environmentMap
Expand All @@ -37,6 +40,15 @@ class GlobalConfig extends BaseConfig<GlobalConfig> implements Serializable {
return awsProfile
}

AzureProfile getAzureProfile(String key) {
def azureProfile = azureProfileMap.get(key)
if (!azureProfile) {
throw new Exception("azureProfile entry '${key}' does not exist in config file")
}
return azureProfile

}

IDeployTarget getDeployTarget(String key) {
def deployTarget = deployTargetMap.get(key)
if (!deployTarget) {
Expand Down
24 changes: 24 additions & 0 deletions src/com/boxboat/jenkins/pipeline/common/dockcmd/DockcmdGetSecrets.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.boxboat.jenkins.pipeline.common.dockcmd

import com.boxboat.jenkins.library.azure.AzureProfile
import com.boxboat.jenkins.library.config.Config
import com.boxboat.jenkins.library.aws.AwsProfile
import com.boxboat.jenkins.library.vault.Vault
Expand All @@ -10,6 +11,8 @@ class DockcmdGetSecrets implements Serializable {

public String vaultKey

public String azureProfileKey

public String directory = "."

public String[] files = []
Expand Down Expand Up @@ -37,6 +40,27 @@ class DockcmdGetSecrets implements Serializable {

}

public parseAzureSecrets(Map<String, Object> additionalOptions = [:]) {
if (!azureProfileKey) {
Config.pipeline.error "'azureProfileKey' is required"
}
AzureProfile azure = Config.global.getAzureProfile(azureProfileKey)
azure.withCredentials {
Config.pipeline.sh parseAzureSecretsScript(azure.keyVaultName, additionalOptions)
}
}

public parseAzureSecretsScript(String keyVaultName, Map<String, Object> additionalOptions = [:]) {
def combinedOptions = combineOptions(options, additionalOptions)
return """
dockcmd_current_dir=\$(pwd)
cd "${directory}"
dockcmd azure get-secrets --key-vault "${keyVaultName}" ${optionsString(combinedOptions)} ${files.join('" "')}
cd "\$dockcmd_current_dir"
"""

}

public parseVaultSecrets(Map<String, Object> additionalOptions = [:]) {
if (!vaultKey) {
Config.pipeline.error "'vaultKey' is required"
Expand Down
6 changes: 6 additions & 0 deletions test-resources/com/boxboat/jenkins/test/library/config/globalConfig/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ awsProfileMap:
region: us-east-1
accessKeyIdCredential: aws-access-key-id
secretAccessKeyCredential: aws-secret-access-key
azureProfileMap:
default:
keyVaultName: vault-name
tenantIdCredential: azure-tenant-id
clientIdCredential: azure-client-id
clientSecretKeyCredential: azure-client-secret-key
deployTargetMap:
dev01: !!com.boxboat.jenkins.library.deployTarget.KubernetesDeployTarget
contextName: boxboat
Expand Down
17 changes: 17 additions & 0 deletions test-resources/com/boxboat/jenkins/test/pipeline/deployment.jenkins
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,23 @@ def execute() {

dockcmdAws.parseAwsSecrets()

def dockcmdAzure = new DockcmdGetSecrets(
azureProfileKey: "default",
files: [
"secret-values-*.yaml",
],
options: [
"edit-in-place": true,
"set": [
"Deployment=dev",
"Foo=bar",
]
],
)

dockcmdAzure.parseAzureSecrets()


deploy.withCredentials() {
sh "helm upgrade --install test ."
}
Expand Down
9 changes: 9 additions & 0 deletions test/com/boxboat/jenkins/test/library/config/GlobalConfigTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.boxboat.jenkins.test.library.config

import com.boxboat.jenkins.library.aws.AwsProfile
import com.boxboat.jenkins.library.azure.AzureProfile
import com.boxboat.jenkins.library.config.CommonConfig
import com.boxboat.jenkins.library.config.DeployConfig
import com.boxboat.jenkins.library.config.GlobalConfig
Expand Down Expand Up @@ -68,6 +69,14 @@ class GlobalConfigTest {
secretAccessKeyCredential: "aws-secret-access-key",
),
],
azureProfileMap: [
"default": new AzureProfile(
keyVaultName: "vault-name",
tenantIdCredential: "tenant-id",
clientIdCredential: "azure-client-id",
clientSecretKeyCredential: "azure-client-secret-key",
),
],
deployTargetMap: [
"dev01" : new KubernetesDeployTarget(
contextName: "boxboat",
Expand Down