CloudBees action: Deploy to a Kubernetes cluster using a Kustomize configuration

Use this action to customize Kubernetes configurations and resources with Kustomize, which uses overlays to change base YAML manifests without directly modifying them.

Prerequisites

Make sure to initialize the connection using your AWS credentials, by adding the following to your YAML file:

      - name: Configure AWS credentials
        uses: cloudbees-io/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEU }}
          aws-secret-access-key: ${{ secrets.AWS_ACCESS_KEU }}
          aws-region: ap-south-1

Refer to CloudBees action: Configure AWS credentials for more information.

Inputs

Note	Kustomize ConfigMap literals and files are not encrypted, so store only non-confidential data with kustomize-configmap-literal and kustomize-configmap-file. To store data that must be encrypted, use kustomize-secret-file.

Table 1. Input details

Input name	Data type	Required?	Description
kustomization-base-dir	String	Yes	Set the path to the Kustomize base directory.
kustomization-overlays-dir	String	Yes	Set the path to the Kustomize overlay directory.
kustomize-annotation	JSON	No	Add, update, or remove Kustomize annotations. Valid objects are add, set, and remove.
kustomize-label	JSON	No	Add, update, or remove Kustomize labels. Valid objects are add, set, and remove.
kustomize-configmap-literal	JSON	No	Refer to non-sensitive data as literals on a ConfigMap resource. Valid value is add.
kustomize-configmap-file	JSON	No	Refer to non-sensitive data as files on a ConfigMap resource. Valid value is add.
kustomize-secret-file	JSON	No	Refer to sensitive data as secrets files on a Secrets resource. Valid value is add.
kustomize-buildmetadata	JSON	No	Specify build information options in Kustomize labels and annotations. Valid options are originAnnotations, managedByLabel, and transformerAnnotations.
kustomize-image	JSON	No	Set container image names, tags and/or digests without creating patches. Valid options are name, newName, and newTag.
kustomize-nameprefix	String	No	Add a prefix to names in defined YAML files.
kustomize-namesuffix	String	No	Add a suffix to names in defined YAML files. The suffix is appended before the content hash if the resource type is ConfigMap or Secret.
kustomize-namespace	String	No	Add a namespace, or override an existing namespace, on a resource.
kustomize-replicas	JSON	No	Set the number of replicas for a resource.

Usage examples

The example payload below does the following:

• Adds annotations.

• Updates existing labels.

• Updates the build metadata options.

• Overrides the namespace.

• Adds a custom prefix.

      - id: k8s-kustomize-deploy
        name: Add Kustomize labels and annotations
        uses: https://github.com/cloudbees-io/kustomize-deploy@v2
        with:
          kustomization-base-dir: ${{ cloudbees.workspace }}/testdata/base
          kustomization-overlays-dir: ${{ cloudbees.workspace }}/testdata/overlays/dev
          kustomize-annotation: '{"add":{"nam1":"val1","nam2":"val2"}}'
          kustomize-label: '{"set":{"nam1":"val1","nam2":"val2"}}'
          kustomize-buildmetadata: '{"add":["originAnnotations"],"set":["managedByLabel"],"remove":["transformerAnnotations"]}'
          kustomize-namespace: 'dev'
          kustomize-nameprefix: 'dev-'

The example payload below does the following:

• Stores non-sensitive data as literals in a ConfigMap.

• Stores non-sensitive data as files in a ConfigMap.

• Adds container image information without creating patches.

      - id: k8s-kustomize-deploy
        name: Store non-sensitive data
        uses: https://github.com/cloudbees-io/kustomize-deploy@v2
        with:
          kustomization-base-dir: ${{ cloudbees.workspace }}/testdata/base
          kustomization-overlays-dir: ${{ cloudbees.workspace }}/testdata/overlays/dev
          kustomize-configmap-literal: '{"name":"example-config","add":{"nam1":"val1","nam2":"val2"}}'
          kustomize-configmap-file: '{"name":"my-config","add":"config.properties"}'
          kustomize-image: '{"name":"nginx:1.7.9","newName":"nginx","newTag":"1.7.9-alpine"}'

The example payload below does the following:

• Stores sensitive data encrypted as Secrets.

• Sets the number of replicas for the hello resource.

      - id: k8s-kustomize-deploy
        name: Store secrets and set replicas
        uses: https://github.com/cloudbees-io/kustomize-deploy@v2
        with:
          kustomization-base-dir: ${{ cloudbees.workspace }}/testdata/base
          kustomization-overlays-dir: ${{ cloudbees.workspace }}/testdata/overlays/dev
          kustomize-secret-file: '{"name":"my-secret","namespace":"dev","add":"secrets.properties"}'
          kustomize-replicas: '["hello:5"]'

License

This code is made available under the MIT license.

References

• Learn more about using actions in CloudBees workflows.

• Learn about the CloudBees platform.