@freight-trust/gitops-update

A GitHub Action and Workflow to update a collection of Kubernetes YAMLs for use in a GitOps-based deployment strategy

• GitOps Actions@Workflow
  • Usage
    • Default Kubernetes artifacts via Helm, etc.
    • Appsody app-deploy.yaml
  • Parameters
    • Inputs
  • Example
  • License

• Usage
• Commands

Usage

$ npm install -g @freight-trust/gitops-update
$ gitops-update COMMAND
running command...
$ gitops-update (-v|--version|version)
@freight-trust/gitops-update/1.0.5 darwin-x64 node-v10.21.0
$ gitops-update --help [COMMAND]
USAGE
  $ gitops-update COMMAND
...

GitOps Actions@Workflow

• GitOps Actions@Workflow
  • Usage
    • Default Kubernetes artifacts via Helm, etc.
    • Appsody app-deploy.yaml
  • Parameters
    • Inputs
  • Example
  • License

Usage

Default Kubernetes artifacts via Helm, etc.

      - name: Update GitOps YAMLs
        id: update-gitops-yamls
        uses: freight-trust/actions-update-gitops@master
        with:
          filePath: 'templates/deployment.yaml'

The action expects to be run inside a working directory (by default, this is the /github/workspace directory in the virtual environment), with a default collection of application component deployment YAML files that have been created by helm template commands with the following folder structure:

      /{component-a}/templates/deployment.yaml
      /{component-a}/templates/service.yaml
      /{component-b}/templates/deployment.yaml
      /{component-b}/templates/service.yaml
      ...
      /{component-n}/templates/deployment.yaml
      /{component-n}/templates/service.yaml

The action gets the latest Docker image versions from Docker Hub by searching against the image repositories used in each deployment.yaml and updates it inline in each file to the latest version (as defined by semantic versioning rules).

Appsody app-deploy.yaml

      - name: Update GitOps YAMLs
        id: update-gitops-yamls
        uses: freight-trust-cloud-architecture/actions-update-gitops@master
        with:
          filePath: 'appsody/app-deploy.yaml'

The action expects to be run inside a working directory (by default, this is the /github/workspace directory in the virtual environment), with a collection of application component deployment YAML files that have been created by helm template commands with the following folder structure:

      /{component-a}/appsody/app-deploy.yaml
      /{component-b}/appsody/app-deploy.yaml
      /{component-c}/appsody/app-deploy.yaml
      ...
      /{component-n}/appsody/app-deploy.yaml

The action gets the latest Docker image versions from Docker Hub by searching against the image repositories used in each app-deploy.yaml and updates it inline in each file to the latest version (as defined by semantic versioning rules).

Parameters

Inputs

• filePath is the relative path inside of each components' working directory that will be searched for Docker image version replacement. This should not start with a leading slash and must be the complete file name, uniform across all components. A single execution of the action will only scan files with same filePath across all components, however multiple executions with different filePath values can be run against the same working directory.

Example

name: Update GitOps deployments
on: [push]
env:
  DESIRED_BRANCH: gitops-yaml-branch
jobs:
  update-gitops-deployments:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Checkout default sandbox branch
      id: checkout-sandbox-branch
      run: |
        git checkout ${DESIRED_BRANCH}
    - name: Update GitOps YAMLs
      id: update-gitops-yamls
      uses: freight-trust/actions-update-gitops@master
      with:
        filePath: 'templates/deployment.yaml'
    - name: Commit & push modified files
      id: commit-and-push-files
      env:
        GITHUB_TOKEN: ...
        GITHUB_ACTOR: ...
      run: |
        ...

License

Apache 2.0