Compare commits

...

18 Commits

Author SHA1 Message Date
Oliver King ebc294c887 add clean function 2022-07-06 16:07:01 -04:00
Hariharan Subramanian 72a09f4051 Logging Changes for Promote, Reject actions (#207) 2022-07-06 10:41:48 -04:00
Vidya Reddy a17f35ba63 Add ncc build to build script (#208)
Co-authored-by: Vidya Reddy <vidyareddy@microsoft.com>
2022-07-05 10:16:41 -07:00
Hariharan Subramanian 7b11ddb1d5 Hari/beautify logs (#206)
* Logging changes for deploy

* Logging Changes with group

* format check changes
2022-06-29 11:26:44 -04:00
David Gamero ecec5912ba switch none deployment strategy to basic (#204)
* switch none deployment strategy to basic

* update readme

* update deployment strategy fallthrough logic

* comment fixed

* add disclaimer for basic strategy only supporting deploy action
2022-06-28 16:33:13 -04:00
Vidya dcd9bc6b1a Vidya reddy/prettier code (#203) 2022-06-24 16:57:45 -04:00
nv35 976c5c4981 Add missing API switch for GHES (#200) 2022-06-22 12:14:43 -04:00
Vidya 4ebf668e6f upgraded to Node16 (#197)
Co-authored-by: Vidya Reddy <vidyareddy@microsoft.com>
2022-06-16 13:20:04 -04:00
David Gamero 15920eb094 omit namespace arg for default namespace (#195) 2022-06-15 10:01:20 -04:00
David Gamero 507f2d4fc7 prefix for annotations (#191) 2022-06-08 11:39:09 -04:00
Oliver King 06a06b13b9 Remove kubectl version example (#188) 2022-06-06 15:15:43 -04:00
Jaiveer Katariya fa093f2922 Modifying README to include instructions/examples for directory functionality (#183)
* Added some tests, not sure what else to try but gonna think of more examples

* forgot some files

* reverted package-lock.json

* Added empty dir test

* Cleaned up some extra spaces

* Add node modules and compiled JavaScript from main

* forgot to actually include functionality

* removed unnecessary files

* Update .gitignore

* Update .gitignore

* Update .gitignore

* thx david

* renamed searchFilesRec

* integrations test fix

* added examples to README

* added note about depth

* added additional note

* removed ticks

* changed version string

Co-authored-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MacBook-Pro.local>
Co-authored-by: Oliver King <oking3@uncc.edu>
2022-04-12 15:53:01 -04:00
Jaiveer Katariya aabcfcba3e Add directory functionality (#181) 2022-04-12 13:17:37 -04:00
dependabot[bot] fd893fd074 Bump minimist from 1.2.5 to 1.2.6 (#175)
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-04-11 10:22:59 -04:00
dependabot[bot] 659e414483 Bump ansi-regex from 5.0.0 to 5.0.1 (#166)
Bumps [ansi-regex](https://github.com/chalk/ansi-regex) from 5.0.0 to 5.0.1.
- [Release notes](https://github.com/chalk/ansi-regex/releases)
- [Commits](https://github.com/chalk/ansi-regex/compare/v5.0.0...v5.0.1)

---
updated-dependencies:
- dependency-name: ansi-regex
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-04-11 10:22:42 -04:00
dependabot[bot] 1e490c6238 Bump tmpl from 1.0.4 to 1.0.5 (#152)
Bumps [tmpl](https://github.com/daaku/nodejs-tmpl) from 1.0.4 to 1.0.5.
- [Release notes](https://github.com/daaku/nodejs-tmpl/releases)
- [Commits](https://github.com/daaku/nodejs-tmpl/commits/v1.0.5)

---
updated-dependencies:
- dependency-name: tmpl
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-04-11 10:22:24 -04:00
Jan Röhrich 75cb5d47f7 Make namespace annotation switchable (#177) 2022-04-11 10:22:05 -04:00
Jan Röhrich bcdb90f36f Make pulling of images switchable (#178) 2022-04-11 10:20:36 -04:00
80 changed files with 16146 additions and 15642 deletions
+39 -40
View File
@@ -1,52 +1,51 @@
name: "Code scanning - action" name: 'Code scanning - action'
on: on:
push: push:
pull_request: pull_request:
schedule: schedule:
- cron: '0 19 * * 0' - cron: '0 19 * * 0'
jobs: jobs:
CodeQL-Build: CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest
# CodeQL runs on ubuntu-latest and windows-latest steps:
runs-on: ubuntu-latest - name: Checkout repository
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2
steps: # If this run was triggered by a pull request event, then checkout
- name: Checkout repository # the head of the pull request instead of the merge commit.
uses: actions/checkout@v2 - run: git checkout HEAD^2
with: if: ${{ github.event_name == 'pull_request' }}
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2
# If this run was triggered by a pull request event, then checkout # Initializes the CodeQL tools for scanning.
# the head of the pull request instead of the merge commit. - name: Initialize CodeQL
- run: git checkout HEAD^2 uses: github/codeql-action/init@v1
if: ${{ github.event_name == 'pull_request' }} # Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java
# Initializes the CodeQL tools for scanning. # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
- name: Initialize CodeQL # If this step fails, then you should remove it and run the build manually (see below)
uses: github/codeql-action/init@v1 - name: Autobuild
# Override language selection by uncommenting this and choosing your languages uses: github/codeql-action/autobuild@v1
# with:
# languages: go, javascript, csharp, python, cpp, java
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # ️ Command-line programs to run using the OS shell.
# If this step fails, then you should remove it and run the build manually (see below) # 📚 https://git.io/JvXDl
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell. # If the Autobuild fails above, remove it and uncomment the following three lines
# 📚 https://git.io/JvXDl # and modify them (or add more) to build your code if your project
# uses a compiled language
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines #- run: |
# and modify them (or add more) to build your code if your project # make bootstrap
# uses a compiled language # make release
#- run: | - name: Perform CodeQL Analysis
# make bootstrap uses: github/codeql-action/analyze@v1
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
+26 -27
View File
@@ -2,35 +2,34 @@ name: setting-default-labels
# Controls when the action will run. # Controls when the action will run.
on: on:
schedule: schedule:
- cron: "0 0/3 * * *" - cron: '0 0/3 * * *'
# A workflow run is made up of one or more jobs that can run sequentially or in parallel # A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs: jobs:
build: build:
# The type of runner that the job will run on # The type of runner that the job will run on
runs-on: ubuntu-latest runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job # Steps represent a sequence of tasks that will be executed as part of the job
steps: steps:
- uses: actions/stale@v3
name: Setting issue as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
stale-issue-label: 'idle'
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@v3 - uses: actions/stale@v3
name: Setting issue as idle name: Setting PR as idle
with: with:
repo-token: ${{ secrets.GITHUB_TOKEN }} repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.' stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
stale-issue-label: 'idle' stale-pr-label: 'idle'
days-before-stale: 14 days-before-stale: 14
days-before-close: -1 days-before-close: -1
operations-per-run: 100 operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@v3
name: Setting PR as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
stale-pr-label: 'idle'
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
+18
View File
@@ -0,0 +1,18 @@
name: 'Run prettify'
on:
pull_request:
push:
branches: [main]
jobs:
prettier:
name: Prettier Check
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Enforce Prettier
uses: actionsx/prettier@v2
with:
args: --check .
+9 -9
View File
@@ -1,14 +1,14 @@
name: Create release PR name: Create release PR
on: on:
workflow_dispatch: workflow_dispatch:
inputs: inputs:
release: release:
description: "Define release version (ex: v1, v2, v3)" description: 'Define release version (ex: v1, v2, v3)'
required: true required: true
jobs: jobs:
release-pr: release-pr:
uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
with: with:
release: ${{ github.event.inputs.release }} release: ${{ github.event.inputs.release }}
+185 -181
View File
@@ -1,211 +1,215 @@
name: Minikube Integration Tests name: Minikube Integration Tests
on: on:
pull_request: pull_request:
branches: branches:
- master - master
- main - main
- "releases/*" - 'releases/*'
push: push:
branches: branches:
- master - master
- main - main
- "releases/*" - 'releases/*'
workflow_dispatch: workflow_dispatch:
jobs: jobs:
run-integration-test: run-integration-test:
name: Run Minikube Integration Tests name: Run Minikube Integration Tests
runs-on: ubuntu-latest runs-on: ubuntu-latest
env: env:
KUBECONFIG: /home/runner/.kube/config KUBECONFIG: /home/runner/.kube/config
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Building latest changes - name: Install dependencies
run: | run: |
rm -rf node_modules/ rm -rf node_modules/
npm install npm install
npm run build
- name: Set name of ns - name: Install ncc
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)" run: npm i -g @vercel/ncc
shell: bash - name: Build
id: ns run: ncc build src/run.ts -o lib
- uses: Azure/setup-kubectl@v1 - name: Set name of ns
name: Install Kubectl run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
shell: bash
id: ns
- id: setup-minikube - uses: Azure/setup-kubectl@v1
name: Setup Minikube name: Install Kubectl
uses: manusa/actions-setup-minikube@v2.4.2
with:
minikube version: "v1.24.0"
kubernetes version: "v1.17.8"
driver: "none"
timeout-minutes: 3
- name: Create namespace to run tests - id: setup-minikube
run: kubectl create ns test-${{ steps.ns.outputs.name }} name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2
with:
minikube version: 'v1.24.0'
kubernetes version: 'v1.17.8'
driver: 'none'
timeout-minutes: 3
- uses: actions/setup-python@v2 - name: Create namespace to run tests
name: Install Python run: kubectl create ns test-${{ steps.ns.outputs.name }}
with:
python-version: "3.x"
- name: Cleaning any previously created items - uses: actions/setup-python@v2
run: | name: Install Python
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }} python-version: '3.x'
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
- name: Executing deploy action - name: Cleaning any previously created items
uses: ./ run: |
with: python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }}
images: nginx:1.14.2 python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }}
manifests: | python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
test/integration/manifests/test-service.yml python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels - name: Executing deploy action
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Executing promote action - name: Checking if deploments and services were created with green labels
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Checking if deploments and services were created with none labels after promote - name: Executing promote action
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Executing deploy action on - name: Checking if deploments and services were created with none labels after promote
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy - name: Executing deploy action on
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Executing reject action - name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
images: nginx:1.19.1 python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: reject
- name: Checking if deploments and services were routed back to none labels after reject - name: Executing reject action
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: reject
- name: Cleaning up current set up - name: Checking if deploments and services were routed back to none labels after reject
run: | run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress - name: Cleaning up current set up
uses: ./ run: |
with: python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels - name: Executing deploy action for ingress
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Executing promote action for ingress - name: Checking if deploments, services and ingresses were created with green labels
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
images: nginx:1.14.2 python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Checking if deploments, services and ingresses were created with none labels after promote - name: Executing promote action for ingress
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }} images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Executing deploy action for ingress - name: Checking if deploments, services and ingresses were created with none labels after promote
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
images: nginx:1.19.1 python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists - name: Executing deploy action for ingress
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} images: nginx:1.19.1
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} manifests: |
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Executing reject action for ingress - name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
uses: ./ run: |
with: python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
namespace: test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
images: nginx:1.19.1 python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
manifests: | python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
test/integration/manifests/test-ingress.yml python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
strategy: blue-green
route-method: ingress
action: reject
- name: Checking if deploments, services and ingresses were created with none labels after reject - name: Executing reject action for ingress
run: | uses: ./
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} with:
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }} images: nginx:1.19.1
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: reject
- if: ${{ always() }} - name: Checking if deploments, services and ingresses were created with none labels after reject
name: Delete created namespace run: |
run: kubectl delete ns test-${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- if: ${{ always() }} - if: ${{ always() }}
name: Posting result back to PR name: Delete created namespace
run: | run: kubectl delete ns test-${{ steps.ns.outputs.name }}
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
shell: bash - if: ${{ always() }}
name: Posting result back to PR
run: |
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
shell: bash
+5 -5
View File
@@ -1,10 +1,10 @@
name: Tag and create release draft name: Tag and create release draft
on: on:
push: push:
branches: branches:
- releases/* - releases/*
jobs: jobs:
tag-and-release: tag-and-release:
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
+16 -16
View File
@@ -1,19 +1,19 @@
name: "Run unit tests." name: 'Run unit tests.'
on: # rebuild any PRs and main branch changes on: # rebuild any PRs and main branch changes
pull_request: pull_request:
branches: branches:
- master - main
- "releases/*" - 'releases/*'
push: push:
branches: branches:
- master - main
- "releases/*" - 'releases/*'
jobs: jobs:
build: # make sure build/ci works properly build: # make sure build/ci works properly
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- run: | - run: |
npm install npm install
npm test npm test
+4
View File
@@ -0,0 +1,4 @@
# dependencies
/node_modules
coverage
/lib
+8
View File
@@ -0,0 +1,8 @@
{
"trailingComma": "none",
"bracketSpacing": false,
"semi": false,
"tabWidth": 3,
"singleQuote": true,
"printWidth": 80
}
+3 -3
View File
@@ -4,6 +4,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
Resources: Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns - Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+239 -226
View File
@@ -8,24 +8,24 @@ If you are looking to automate your workflows to deploy to [Azure Web Apps](http
Following are the key capabilities of this action: Following are the key capabilities of this action:
- **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes. - **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes.
- **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure. - **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure.
- **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster. - **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster.
- **Deployment strategy** Supports both canary and blue-green deployment strategies - **Deployment strategy** Supports both canary and blue-green deployment strategies
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported: - **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
- **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers). - **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers).
- **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary. - **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary.
- **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action: - **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
- **Service route-method**: Identified services are configured to target the green deployments. - **Service route-method**: Identified services are configured to target the green deployments.
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services. - **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services.
- **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster. - **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster.
Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads. Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads.
## Action inputs ## Action inputs
@@ -42,7 +42,15 @@ Following are the key capabilities of this action:
</tr> </tr>
<tr> <tr>
<td>manifests </br></br>(Required)</td> <td>manifests </br></br>(Required)</td>
<td>Path to the manifest files to be used for deployment</td> <td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
</tr>
<tr>
<td>strategy </br></br>(Required)</td>
<td>Acceptable values: basic/canary/blue-green. <br>
Default value: basic
<br>Deployment strategy to be used while applying manifest files on the cluster.
<br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
</tr> </tr>
<tr> <tr>
<td>namespace </br></br>(Optional) <td>namespace </br></br>(Optional)
@@ -59,9 +67,8 @@ Following are the key capabilities of this action:
<td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td> <td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td>
</tr> </tr>
<tr> <tr>
<td>strategy </br></br>(Optional)</td> <td>pull-images</br></br>(Optional)</td>
<td>Acceptable values: none/canary/blue-green. <br> <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
Deployment strategy to be used while applying manifest files on the cluster.<br>none - No deployment strategy is used when deploying.<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
</tr> </tr>
<tr> <tr>
<td>traffic-split-method </br></br>(Optional)</td> <td>traffic-split-method </br></br>(Optional)</td>
@@ -90,6 +97,10 @@ Following are the key capabilities of this action:
<td>force </br></br>(Optional)</td> <td>force </br></br>(Optional)</td>
<td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td> <td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
</tr> </tr>
<tr>
<td>annotate-namespace</br></br>(Optional)</td>
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
</tr>
</table> </table>
## Usage Examples ## Usage Examples
@@ -97,129 +108,131 @@ Following are the key capabilities of this action:
### Basic deployment (without any deployment strategy) ### Basic deployment (without any deployment strategy)
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
manifests: | manifests: |
deployment.yaml dir/manifestsDirectory
service.yaml images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" imagepullsecrets: |
imagepullsecrets: | image-pull-secret1
image-pull-secret1 image-pull-secret2
image-pull-secret2
kubectl-version: "latest"
``` ```
### Canary deployment without service mesh ### Canary deployment without service mesh
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
strategy: canary dir/manifestsDirectory
action: deploy strategy: canary
percentage: 20 action: deploy
percentage: 20
``` ```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
strategy: canary dir/manifestsDirectory
action: promote # substitute reject if you want to reject strategy: canary
action: promote # substitute reject if you want to reject
``` ```
### Canary deployment based on Service Mesh Interface ### Canary deployment based on Service Mesh Interface
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
strategy: canary dir/manifestsDirectory
action: deploy strategy: canary
traffic-split-method: smi action: deploy
percentage: 20 traffic-split-method: smi
baseline-and-canary-replicas: 1 percentage: 20
baseline-and-canary-replicas: 1
``` ```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }} " images: 'contoso.azurecr.io/myapp:${{ event.run_id }} '
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
strategy: canary dir/manifestsDirectory
traffic-split-method: smi strategy: canary
action: reject # substitute reject if you want to reject traffic-split-method: smi
action: reject # substitute reject if you want to reject
``` ```
### Blue-Green deployment with different route methods ### Blue-Green deployment with different route methods
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
ingress.yml ingress.yml
strategy: blue-green strategy: blue-green
action: deploy action: deploy
route-method: ingress # substitute with service/smi as per need route-method: ingress # substitute with service/smi as per need
version-switch-buffer: 15 version-switch-buffer: 15
``` ```
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used: To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: "myapp" namespace: 'myapp'
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
ingress-yml ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress # should be the same as the value when action was deploy route-method: ingress # should be the same as the value when action was deploy
action: promote # substitute reject if you want to reject action: promote # substitute reject if you want to reject
``` ```
## End to end workflows ## End to end workflows
@@ -232,47 +245,47 @@ Following are a few examples of not just this action, but how this action could
on: [push] on: [push]
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: Azure/docker-login@v1 - uses: Azure/docker-login@v1
with: with:
login-server: contoso.azurecr.io login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }} username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} password: ${{ secrets.REGISTRY_PASSWORD }}
- run: | - run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: azure/setup-kubectl@v2.0 - uses: azure/setup-kubectl@v2.0
# Set the target AKS cluster. # Set the target AKS cluster.
- uses: Azure/aks-set-context@v1 - uses: Azure/aks-set-context@v1
with: with:
creds: "${{ secrets.AZURE_CREDENTIALS }}" creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso cluster-name: contoso
resource-group: contoso-rg resource-group: contoso-rg
- uses: Azure/k8s-create-secret@v1.1 - uses: Azure/k8s-create-secret@v1.1
with: with:
container-registry-url: contoso.azurecr.io container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret secret-name: demo-k8s-secret
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
action: deploy action: deploy
manifests: | manifests: |
manifests/deployment.yml manifests/deployment.yml
manifests/service.yml manifests/service.yml
images: | images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | imagepullsecrets: |
demo-k8s-secret demo-k8s-secret
``` ```
### Build container image and deploy to any Azure Kubernetes Service cluster ### Build container image and deploy to any Azure Kubernetes Service cluster
@@ -281,44 +294,44 @@ jobs:
on: [push] on: [push]
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: Azure/docker-login@v1 - uses: Azure/docker-login@v1
with: with:
login-server: contoso.azurecr.io login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }} username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} password: ${{ secrets.REGISTRY_PASSWORD }}
- run: | - run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: azure/setup-kubectl@v2.0 - uses: azure/setup-kubectl@v2.0
- uses: Azure/k8s-set-context@v2 - uses: Azure/k8s-set-context@v2
with: with:
kubeconfig: ${{ secrets.KUBE_CONFIG }} kubeconfig: ${{ secrets.KUBE_CONFIG }}
- uses: Azure/k8s-create-secret@v1.1 - uses: Azure/k8s-create-secret@v1.1
with: with:
container-registry-url: contoso.azurecr.io container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret secret-name: demo-k8s-secret
- uses: Azure/k8s-deploy@v1.4 - uses: Azure/k8s-deploy@v3.1
with: with:
action: deploy action: deploy
manifests: | manifests: |
manifests/deployment.yml manifests/deployment.yml
manifests/service.yml manifests/service.yml
images: | images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | imagepullsecrets: |
demo-k8s-secret demo-k8s-secret
``` ```
### Build image and add `dockerfile-path` label to it ### Build image and add `dockerfile-path` label to it
@@ -328,23 +341,23 @@ We can use this image in other workflows once built.
```yaml ```yaml
on: [push] on: [push]
env: env:
NAMESPACE: demo-ns2 NAMESPACE: demo-ns2
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: Azure/docker-login@v1 - uses: Azure/docker-login@v1
with: with:
login-server: contoso.azurecr.io login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }} username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} password: ${{ secrets.REGISTRY_PASSWORD }}
- run: | - run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
``` ```
### Use bake action to get manifests deploying to a Kubernetes cluster ### Use bake action to get manifests deploying to a Kubernetes cluster
@@ -352,62 +365,62 @@ jobs:
```yaml ```yaml
on: [push] on: [push]
env: env:
NAMESPACE: demo-ns2 NAMESPACE: demo-ns2
jobs: jobs:
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: Azure/docker-login@v1 - uses: Azure/docker-login@v1
with: with:
login-server: contoso.azurecr.io login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }} username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} password: ${{ secrets.REGISTRY_PASSWORD }}
- uses: azure/setup-kubectl@v2.0 - uses: azure/setup-kubectl@v2.0
# Set the target AKS cluster. # Set the target AKS cluster.
- uses: Azure/aks-set-context@v1 - uses: Azure/aks-set-context@v1
with: with:
creds: "${{ secrets.AZURE_CREDENTIALS }}" creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso cluster-name: contoso
resource-group: contoso-rg resource-group: contoso-rg
- uses: Azure/k8s-create-secret@v1.1 - uses: Azure/k8s-create-secret@v1.1
with: with:
namespace: ${{ env.NAMESPACE }} namespace: ${{ env.NAMESPACE }}
container-registry-url: contoso.azurecr.io container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret secret-name: demo-k8s-secret
- uses: azure/k8s-bake@v2 - uses: azure/k8s-bake@v2
with: with:
renderEngine: "helm" renderEngine: 'helm'
helmChart: "./aks-helloworld/" helmChart: './aks-helloworld/'
overrideFiles: "./aks-helloworld/values-override.yaml" overrideFiles: './aks-helloworld/values-override.yaml'
overrides: | overrides: |
replicas:2 replicas:2
helm-version: "latest" helm-version: 'latest'
id: bake id: bake
- uses: Azure/k8s-deploy@v1.2 - uses: Azure/k8s-deploy@v1.2
with: with:
action: deploy action: deploy
manifests: ${{ steps.bake.outputs.manifestsBundle }} manifests: ${{ steps.bake.outputs.manifestsBundle }}
images: | images: |
contoso.azurecr.io/k8sdemo:${{ github.sha }} contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | imagepullsecrets: |
demo-k8s-secret demo-k8s-secret
``` ```
## Traceability Fields Support ## Traceability Fields Support
- Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests. - Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests.
- Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability. - Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability.
- Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows. - Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows.
## Contributing ## Contributing
+9 -9
View File
@@ -4,23 +4,23 @@
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/). Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below. If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>) of a security vulnerability, please report it to us as described below.
## Reporting Security Issues ## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155). **Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) - Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue - Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL) - The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue - Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue - Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible) - Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue - Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly. This information will help us triage your report more quickly.
+63 -55
View File
@@ -1,59 +1,67 @@
name: "Deploy to Kubernetes cluster" name: 'Deploy to Kubernetes cluster'
description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters" description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters'
inputs: inputs:
# Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action # Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action
# You also need to have kubectl installed (azure/setup-kubectl) # You also need to have kubectl installed (azure/setup-kubectl)
namespace: namespace:
description: "Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace." description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.'
required: false required: false
manifests: manifests:
description: "Path to the manifest files which will be used for deployment." description: 'Path to the manifest files which will be used for deployment.'
required: true required: true
images: images:
description: "Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test" description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test'
required: false required: false
imagepullsecrets: imagepullsecrets:
description: "Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files" description: 'Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files'
required: false required: false
strategy: pull-images:
description: "Deployment strategy to be used. Allowed values are none, canary and blue-green" description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations"
required: false required: false
default: "none" default: true
route-method: strategy:
description: "Route based on service, ingress or SMI for blue-green strategy" description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
required: false required: true
default: "service" default: 'basic'
version-switch-buffer: route-method:
description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)" description: 'Route based on service, ingress or SMI for blue-green strategy'
required: false required: false
default: 0 default: 'service'
traffic-split-method: version-switch-buffer:
description: "Traffic split method to be used. Allowed values are pod and smi" description: 'Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)'
required: false required: false
default: "pod" default: 0
baseline-and-canary-replicas: traffic-split-method:
description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)" description: 'Traffic split method to be used. Allowed values are pod and smi'
required: false required: false
default: 0 default: 'pod'
percentage: baseline-and-canary-replicas:
description: "Percentage of traffic redirect to canary deployment" description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)'
required: false required: false
default: 0 default: 0
action: percentage:
description: "deploy, promote, or reject" description: 'Percentage of traffic redirect to canary deployment'
required: true required: false
default: "deploy" default: 0
force: action:
description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command" description: 'deploy, promote, or reject'
required: false required: true
default: false default: 'deploy'
token: force:
description: "Github token" description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command'
default: ${{ github.token }} required: false
required: true default: false
token:
description: 'Github token'
default: ${{ github.token }}
required: true
annotate-namespace:
description: 'Annotate the target namespace'
required: false
default: true
branding: branding:
color: "green" color: 'green'
runs: runs:
using: "node12" using: 'node16'
main: "lib/index.js" main: 'lib/index.js'
+8 -8
View File
@@ -1,10 +1,10 @@
module.exports = { module.exports = {
clearMocks: true, clearMocks: true,
moduleFileExtensions: ['js', 'ts'], moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node', testEnvironment: 'node',
testMatch: ['**/*.test.ts'], testMatch: ['**/*.test.ts'],
transform: { transform: {
'^.+\\.ts$': 'ts-jest' '^.+\\.ts$': 'ts-jest'
}, },
verbose: true verbose: true
} }
+10880 -10816
View File
File diff suppressed because it is too large Load Diff
+30 -26
View File
@@ -1,28 +1,32 @@
{ {
"name": "k8s-deploy-action", "name": "k8s-deploy-action",
"version": "0.0.0", "version": "0.0.0",
"author": "Deepak Sattiraju", "author": "Deepak Sattiraju",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"build": "tsc --outDir ./lib --rootDir ./src", "build": "ncc build src/run.ts -o lib",
"test": "jest" "test": "jest",
}, "format": "prettier --write .",
"dependencies": { "format-check": "prettier --check ."
"@actions/core": "^1.2.6", },
"@actions/exec": "^1.0.0", "dependencies": {
"@actions/io": "^1.0.0", "@actions/core": "^1.2.6",
"@actions/tool-cache": "1.1.2", "@actions/exec": "^1.0.0",
"@octokit/core": "^3.5.1", "@actions/io": "^1.0.0",
"@octokit/plugin-retry": "^3.0.9", "@actions/tool-cache": "1.1.2",
"@types/minipass": "^3.1.2", "@octokit/core": "^3.5.1",
"js-yaml": "3.13.1" "@octokit/plugin-retry": "^3.0.9",
}, "@types/minipass": "^3.1.2",
"devDependencies": { "js-yaml": "3.13.1"
"@types/jest": "^26.0.0", },
"@types/js-yaml": "^3.12.7", "devDependencies": {
"@types/node": "^12.20.41", "@types/jest": "^26.0.0",
"jest": "^26.0.0", "@types/js-yaml": "^3.12.7",
"ts-jest": "^25.5.1", "@types/node": "^12.20.41",
"typescript": "3.9.5" "@vercel/ncc": "^0.34.0",
} "jest": "^26.0.0",
"prettier": "2.7.1",
"ts-jest": "^26.0.0",
"typescript": "3.9.5"
}
} }
+79 -74
View File
@@ -1,85 +1,90 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as models from "../types/kubernetesTypes"; import * as models from '../types/kubernetesTypes'
import * as KubernetesConstants from "../types/kubernetesTypes"; import * as KubernetesConstants from '../types/kubernetesTypes'
import { Kubectl, Resource } from "../types/kubectl"; import {Kubectl, Resource} from '../types/kubectl'
import { import {
getResources, getResources,
updateManifestFiles, updateManifestFiles
} from "../utilities/manifestUpdateUtils"; } from '../utilities/manifestUpdateUtils'
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper"; import {routeBlueGreen} from '../strategyHelpers/blueGreen/blueGreenHelper'
import { import {
annotateAndLabelResources, annotateAndLabelResources,
checkManifestStability, checkManifestStability,
deployManifests, deployManifests
} from "../strategyHelpers/deploymentHelper"; } from '../strategyHelpers/deploymentHelper'
import { DeploymentStrategy } from "../types/deploymentStrategy"; import {DeploymentStrategy} from '../types/deploymentStrategy'
import { parseTrafficSplitMethod } from "../types/trafficSplitMethod"; import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
import { parseRouteStrategy } from "../types/routeStrategy"; import {parseRouteStrategy} from '../types/routeStrategy'
export async function deploy( export async function deploy(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[], manifestFilePaths: string[],
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
// update manifests // update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths); const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths)
core.debug("Input manifest files: " + inputManifestFiles); core.debug('Input manifest files: ' + inputManifestFiles)
// deploy manifests // deploy manifests
core.info("Deploying manifests"); core.startGroup('Deploying manifests')
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true }) core.getInput('traffic-split-method', {required: true})
); )
const deployedManifestFiles = await deployManifests( const deployedManifestFiles = await deployManifests(
inputManifestFiles, inputManifestFiles,
deploymentStrategy, deploymentStrategy,
kubectl, kubectl,
trafficSplitMethod trafficSplitMethod
); )
core.debug("Deployed manifest files: " + deployedManifestFiles); core.endGroup()
core.debug('Deployed manifest files: ' + deployedManifestFiles)
// check manifest stability // check manifest stability
core.info("Checking manifest stability"); core.startGroup('Checking manifest stability')
const resourceTypes: Resource[] = getResources( const resourceTypes: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE, KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
]) ])
); )
await checkManifestStability(kubectl, resourceTypes); await checkManifestStability(kubectl, resourceTypes)
core.endGroup()
if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) { if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
core.info("Routing blue green"); core.startGroup('Routing blue green')
const routeStrategy = parseRouteStrategy( const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true }) core.getInput('route-method', {required: true})
); )
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy); await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy)
} core.endGroup()
}
// print ingresses // print ingresses
core.info("Printing ingresses"); core.startGroup('Printing ingresses')
const ingressResources: Resource[] = getResources(deployedManifestFiles, [ const ingressResources: Resource[] = getResources(deployedManifestFiles, [
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
]); ])
for (const ingressResource of ingressResources) { for (const ingressResource of ingressResources) {
await kubectl.getResource( await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name ingressResource.name
); )
} }
core.endGroup()
// annotate resources // annotate resources
core.info("Annotating resources"); core.startGroup('Annotating resources')
let allPods; let allPods
try { try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout); allPods = JSON.parse((await kubectl.getAllPods()).stdout)
} catch (e) { } catch (e) {
core.debug("Unable to parse pods: " + e); core.debug('Unable to parse pods: ' + e)
} }
await annotateAndLabelResources( await annotateAndLabelResources(
deployedManifestFiles, deployedManifestFiles,
kubectl, kubectl,
resourceTypes, resourceTypes,
allPods allPods
); )
core.endGroup()
} }
+156 -147
View File
@@ -1,172 +1,181 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as deploy from "./deploy"; import * as deploy from './deploy'
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper"; import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper"; import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import { import {
getResources, getResources,
updateManifestFiles, updateManifestFiles
} from "../utilities/manifestUpdateUtils"; } from '../utilities/manifestUpdateUtils'
import * as models from "../types/kubernetesTypes"; import * as models from '../types/kubernetesTypes'
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils"; import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
import { import {
BlueGreenManifests, BlueGreenManifests,
deleteWorkloadsAndServicesWithLabel, deleteWorkloadsAndServicesWithLabel,
deleteWorkloadsWithLabel, deleteWorkloadsWithLabel,
getManifestObjects, getManifestObjects,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
NONE_LABEL_VALUE, NONE_LABEL_VALUE
} from "../strategyHelpers/blueGreen/blueGreenHelper"; } from '../strategyHelpers/blueGreen/blueGreenHelper'
import { import {
promoteBlueGreenService, promoteBlueGreenService,
routeBlueGreenService, routeBlueGreenService
} from "../strategyHelpers/blueGreen/serviceBlueGreenHelper"; } from '../strategyHelpers/blueGreen/serviceBlueGreenHelper'
import { import {
promoteBlueGreenIngress, promoteBlueGreenIngress,
routeBlueGreenIngress, routeBlueGreenIngress
} from "../strategyHelpers/blueGreen/ingressBlueGreenHelper"; } from '../strategyHelpers/blueGreen/ingressBlueGreenHelper'
import { import {
cleanupSMI, cleanupSMI,
promoteBlueGreenSMI, promoteBlueGreenSMI,
routeBlueGreenSMI, routeBlueGreenSMI
} from "../strategyHelpers/blueGreen/smiBlueGreenHelper"; } from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
import { Kubectl, Resource } from "../types/kubectl"; import {Kubectl, Resource} from '../types/kubectl'
import { DeploymentStrategy } from "../types/deploymentStrategy"; import {DeploymentStrategy} from '../types/deploymentStrategy'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod, TrafficSplitMethod
} from "../types/trafficSplitMethod"; } from '../types/trafficSplitMethod'
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy"; import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
export async function promote( export async function promote(
kubectl: Kubectl, kubectl: Kubectl,
manifests: string[], manifests: string[],
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: case DeploymentStrategy.CANARY:
await promoteCanary(kubectl, manifests); await promoteCanary(kubectl, manifests)
break; break
case DeploymentStrategy.BLUE_GREEN: case DeploymentStrategy.BLUE_GREEN:
await promoteBlueGreen(kubectl, manifests); await promoteBlueGreen(kubectl, manifests)
break; break
default: default:
throw Error("Invalid promote deployment strategy"); throw Error('Invalid promote deployment strategy')
} }
} }
async function promoteCanary(kubectl: Kubectl, manifests: string[]) { async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false; let includeServices = false
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true }) core.getInput('traffic-split-method', {required: true})
); )
if (trafficSplitMethod == TrafficSplitMethod.SMI) { if (trafficSplitMethod == TrafficSplitMethod.SMI) {
includeServices = true; includeServices = true
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to // In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
// canary deployment, then update stable deployment and then redirect traffic to stable deployment // canary deployment, then update stable deployment and then redirect traffic to stable deployment
core.info("Redirecting traffic to canary deployment"); core.startGroup('Redirecting traffic to canary deployment')
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment( await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
kubectl, kubectl,
manifests manifests
); )
core.endGroup()
core.info("Deploying input manifests with SMI canary strategy"); core.startGroup('Deploying input manifests with SMI canary strategy')
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY); await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
core.info("Redirecting traffic to stable deployment"); core.startGroup('Redirecting traffic to stable deployment')
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl, kubectl,
manifests manifests
); )
} else { core.endGroup()
core.info("Deploying input manifests"); } else {
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY); core.startGroup('Deploying input manifests')
} await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
}
core.info("Deleting canary and baseline workloads"); core.startGroup('Deleting canary and baseline workloads')
try { try {
await canaryDeploymentHelper.deleteCanaryDeployment( await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl, kubectl,
manifests, manifests,
includeServices includeServices
); )
} catch (ex) { } catch (ex) {
core.warning( core.warning(
"Exception occurred while deleting canary and baseline workloads: " + ex 'Exception occurred while deleting canary and baseline workloads: ' +
); ex
} )
}
core.endGroup()
} }
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) { async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// update container images and pull secrets // update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests); const inputManifestFiles: string[] = updateManifestFiles(manifests)
const manifestObjects: BlueGreenManifests = const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles); getManifestObjects(inputManifestFiles)
const routeStrategy = parseRouteStrategy( const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true }) core.getInput('route-method', {required: true})
); )
core.info("Deleting old deployment and making new one"); core.startGroup('Deleting old deployment and making new one')
let result; let result
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
result = await promoteBlueGreenIngress(kubectl, manifestObjects); result = await promoteBlueGreenIngress(kubectl, manifestObjects)
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
result = await promoteBlueGreenSMI(kubectl, manifestObjects); result = await promoteBlueGreenSMI(kubectl, manifestObjects)
} else { } else {
result = await promoteBlueGreenService(kubectl, manifestObjects); result = await promoteBlueGreenService(kubectl, manifestObjects)
} }
core.endGroup()
// checking stability of newly created deployments // checking stability of newly created deployments
core.info("Checking manifest stability"); core.startGroup('Checking manifest stability')
const deployedManifestFiles = result.newFilePaths; const deployedManifestFiles = result.newFilePaths
const resources: Resource[] = getResources( const resources: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE, models.DiscoveryAndLoadBalancerResource.SERVICE
]) ])
); )
await KubernetesManifestUtility.checkManifestStability(kubectl, resources); await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
core.endGroup()
core.info( core.startGroup(
"Routing to new deployments and deleting old workloads and services" 'Routing to new deployments and deleting old workloads and services'
); )
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress( await routeBlueGreenIngress(
kubectl, kubectl,
null, null,
manifestObjects.serviceNameMap, manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList manifestObjects.ingressEntityList
); )
await deleteWorkloadsAndServicesWithLabel( await deleteWorkloadsAndServicesWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI( await routeBlueGreenSMI(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
await deleteWorkloadsWithLabel( await deleteWorkloadsWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList manifestObjects.deploymentEntityList
); )
await cleanupSMI(kubectl, manifestObjects.serviceEntityList); await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
} else { } else {
await routeBlueGreenService( await routeBlueGreenService(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
await deleteWorkloadsWithLabel( await deleteWorkloadsWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList manifestObjects.deploymentEntityList
); )
} }
core.endGroup()
} }
+57 -54
View File
@@ -1,68 +1,71 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper"; import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper"; import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import { Kubectl } from "../types/kubectl"; import {Kubectl} from '../types/kubectl'
import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper"; import {rejectBlueGreenService} from '../strategyHelpers/blueGreen/serviceBlueGreenHelper'
import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper"; import {rejectBlueGreenIngress} from '../strategyHelpers/blueGreen/ingressBlueGreenHelper'
import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper"; import {rejectBlueGreenSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
import { DeploymentStrategy } from "../types/deploymentStrategy"; import {DeploymentStrategy} from '../types/deploymentStrategy'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod, TrafficSplitMethod
} from "../types/trafficSplitMethod"; } from '../types/trafficSplitMethod'
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy"; import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
export async function reject( export async function reject(
kubectl: Kubectl, kubectl: Kubectl,
manifests: string[], manifests: string[],
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: case DeploymentStrategy.CANARY:
await rejectCanary(kubectl, manifests); await rejectCanary(kubectl, manifests)
break; break
case DeploymentStrategy.BLUE_GREEN: case DeploymentStrategy.BLUE_GREEN:
await rejectBlueGreen(kubectl, manifests); await rejectBlueGreen(kubectl, manifests)
break; break
default: default:
throw "Invalid delete deployment strategy"; throw 'Invalid delete deployment strategy'
} }
} }
async function rejectCanary(kubectl: Kubectl, manifests: string[]) { async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false; let includeServices = false
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true }) core.getInput('traffic-split-method', {required: true})
); )
if (trafficSplitMethod == TrafficSplitMethod.SMI) { if (trafficSplitMethod == TrafficSplitMethod.SMI) {
core.info("Rejecting deployment with SMI canary strategy"); core.startGroup('Rejecting deployment with SMI canary strategy')
includeServices = true; includeServices = true
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
manifests
)
core.endGroup()
}
core.startGroup('Deleting baseline and canary workloads')
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl, kubectl,
manifests manifests,
); includeServices
} )
core.endGroup()
core.info("Deleting baseline and canary workloads");
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
manifests,
includeServices
);
} }
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) { async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
core.info("Rejecting deployment with blue green strategy"); core.startGroup('Rejecting deployment with blue green strategy')
const routeStrategy = parseRouteStrategy( const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true }) core.getInput('route-method', {required: true})
); )
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
await rejectBlueGreenIngress(kubectl, manifests); await rejectBlueGreenIngress(kubectl, manifests)
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
await rejectBlueGreenSMI(kubectl, manifests); await rejectBlueGreenSMI(kubectl, manifests)
} else { } else {
await rejectBlueGreenService(kubectl, manifests); await rejectBlueGreenService(kubectl, manifests)
} }
core.endGroup()
} }
+49 -47
View File
@@ -1,54 +1,56 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import { getKubectlPath, Kubectl } from "./types/kubectl"; import {getKubectlPath, Kubectl} from './types/kubectl'
import { deploy } from "./actions/deploy"; import {deploy} from './actions/deploy'
import { promote } from "./actions/promote"; import {promote} from './actions/promote'
import { reject } from "./actions/reject"; import {reject} from './actions/reject'
import { Action, parseAction } from "./types/action"; import {Action, parseAction} from './types/action'
import { parseDeploymentStrategy } from "./types/deploymentStrategy"; import {parseDeploymentStrategy} from './types/deploymentStrategy'
import {getFilesFromDirectories} from './utilities/fileUtils'
export async function run() { export async function run() {
// verify kubeconfig is set // verify kubeconfig is set
if (!process.env["KUBECONFIG"]) if (!process.env['KUBECONFIG'])
core.warning( core.warning(
"KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action." 'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.'
); )
// get inputs // get inputs
const action: Action | undefined = parseAction( const action: Action | undefined = parseAction(
core.getInput("action", { required: true }) core.getInput('action', {required: true})
); )
const strategy = parseDeploymentStrategy(core.getInput("strategy")); const strategy = parseDeploymentStrategy(core.getInput('strategy'))
const manifestsInput = core.getInput("manifests", { required: true }); const manifestsInput = core.getInput('manifests', {required: true})
const manifestFilePaths = manifestsInput const manifestFilePaths = manifestsInput
.split(/[\n,;]+/) // split into each individual manifest .split(/[\n,;]+/) // split into each individual manifest
.map((manifest) => manifest.trim()) // remove surrounding whitespace .map((manifest) => manifest.trim()) // remove surrounding whitespace
.filter((manifest) => manifest.length > 0); // remove any blanks .filter((manifest) => manifest.length > 0) // remove any blanks
// create kubectl const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
const kubectlPath = await getKubectlPath(); // create kubectl
const namespace = core.getInput("namespace") || "default"; const kubectlPath = await getKubectlPath()
const kubectl = new Kubectl(kubectlPath, namespace, true); const namespace = core.getInput('namespace') || 'default'
const kubectl = new Kubectl(kubectlPath, namespace, true)
// run action // run action
switch (action) { switch (action) {
case Action.DEPLOY: { case Action.DEPLOY: {
await deploy(kubectl, manifestFilePaths, strategy); await deploy(kubectl, fullManifestFilePaths, strategy)
break; break
} }
case Action.PROMOTE: { case Action.PROMOTE: {
await promote(kubectl, manifestFilePaths, strategy); await promote(kubectl, fullManifestFilePaths, strategy)
break; break
} }
case Action.REJECT: { case Action.REJECT: {
await reject(kubectl, manifestFilePaths, strategy); await reject(kubectl, fullManifestFilePaths, strategy)
break; break
} }
default: { default: {
throw Error( throw Error(
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".' 'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
); )
} }
} }
} }
run().catch(core.setFailed); run().catch(core.setFailed)
+277 -274
View File
@@ -1,355 +1,358 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import { import {
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload
} from "../../types/kubernetesTypes"; } from '../../types/kubernetesTypes'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import { routeBlueGreenService } from "./serviceBlueGreenHelper"; import {routeBlueGreenService} from './serviceBlueGreenHelper'
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper"; import {routeBlueGreenIngress} from './ingressBlueGreenHelper'
import { routeBlueGreenSMI } from "./smiBlueGreenHelper"; import {routeBlueGreenSMI} from './smiBlueGreenHelper'
import { import {
UnsetClusterSpecificDetails, UnsetClusterSpecificDetails,
updateObjectLabels, updateObjectLabels,
updateSelectorLabels, updateSelectorLabels
} from "../../utilities/manifestUpdateUtils"; } from '../../utilities/manifestUpdateUtils'
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils"; import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import { checkForErrors } from "../../utilities/kubectlUtils"; import {checkForErrors} from '../../utilities/kubectlUtils'
import { sleep } from "../../utilities/timeUtils"; import {sleep} from '../../utilities/timeUtils'
import { RouteStrategy } from "../../types/routeStrategy"; import {RouteStrategy} from '../../types/routeStrategy'
export const GREEN_LABEL_VALUE = "green"; export const GREEN_LABEL_VALUE = 'green'
export const NONE_LABEL_VALUE = "None"; export const NONE_LABEL_VALUE = 'None'
export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color"; export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color'
export const GREEN_SUFFIX = "-green"; export const GREEN_SUFFIX = '-green'
export const STABLE_SUFFIX = "-stable"; export const STABLE_SUFFIX = '-stable'
export interface BlueGreenManifests { export interface BlueGreenManifests {
serviceEntityList: any[]; serviceEntityList: any[]
serviceNameMap: Map<string, string>; serviceNameMap: Map<string, string>
unroutedServiceEntityList: any[]; unroutedServiceEntityList: any[]
deploymentEntityList: any[]; deploymentEntityList: any[]
ingressEntityList: any[]; ingressEntityList: any[]
otherObjects: any[]; otherObjects: any[]
} }
export async function routeBlueGreen( export async function routeBlueGreen(
kubectl: Kubectl, kubectl: Kubectl,
inputManifestFiles: string[], inputManifestFiles: string[],
routeStrategy: RouteStrategy routeStrategy: RouteStrategy
) { ) {
// sleep for buffer time // sleep for buffer time
const bufferTime: number = parseInt( const bufferTime: number = parseInt(
core.getInput("version-switch-buffer") || "0" core.getInput('version-switch-buffer') || '0'
); )
if (bufferTime < 0 || bufferTime > 300) if (bufferTime < 0 || bufferTime > 300)
throw Error("Version switch buffer must be between 0 and 300 (inclusive)"); throw Error('Version switch buffer must be between 0 and 300 (inclusive)')
const startSleepDate = new Date(); const startSleepDate = new Date()
core.info( core.info(
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}` `Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
); )
await sleep(bufferTime * 1000 * 60); await sleep(bufferTime * 1000 * 60)
const endSleepDate = new Date(); const endSleepDate = new Date()
core.info( core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}` `Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
); )
const manifestObjects: BlueGreenManifests = const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles); getManifestObjects(inputManifestFiles)
core.debug("Manifest objects: " + JSON.stringify(manifestObjects)); core.debug('Manifest objects: ' + JSON.stringify(manifestObjects))
// route to new deployments // route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) { if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress( await routeBlueGreenIngress(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap, manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList manifestObjects.ingressEntityList
); )
} else if (routeStrategy == RouteStrategy.SMI) { } else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI( await routeBlueGreenSMI(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
} else { } else {
await routeBlueGreenService( await routeBlueGreenService(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
} }
} }
export async function deleteWorkloadsWithLabel( export async function deleteWorkloadsWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deleteLabel: string, deleteLabel: string,
deploymentEntityList: any[] deploymentEntityList: any[]
) { ) {
const resourcesToDelete = []; const resourcesToDelete = []
deploymentEntityList.forEach((inputObject) => { deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (deleteLabel === NONE_LABEL_VALUE) { if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments // delete stable deployments
const resourceToDelete = { name, kind }; const resourceToDelete = {name, kind}
resourcesToDelete.push(resourceToDelete); resourcesToDelete.push(resourceToDelete)
} else { } else {
// delete new green deployments // delete new green deployments
const resourceToDelete = { const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX), name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind, kind: kind
}; }
resourcesToDelete.push(resourceToDelete); resourcesToDelete.push(resourceToDelete)
} }
}); })
await deleteObjects(kubectl, resourcesToDelete); await deleteObjects(kubectl, resourcesToDelete)
} }
export async function deleteWorkloadsAndServicesWithLabel( export async function deleteWorkloadsAndServicesWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deleteLabel: string, deleteLabel: string,
deploymentEntityList: any[], deploymentEntityList: any[],
serviceEntityList: any[] serviceEntityList: any[]
) { ) {
// need to delete services and deployments // need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList); const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList)
const resourcesToDelete = []; const resourcesToDelete = []
deletionEntitiesList.forEach((inputObject) => { deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (deleteLabel === NONE_LABEL_VALUE) { if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects // delete stable objects
const resourceToDelete = { name, kind }; const resourceToDelete = {name, kind}
resourcesToDelete.push(resourceToDelete); resourcesToDelete.push(resourceToDelete)
} else { } else {
// delete green labels // delete green labels
const resourceToDelete = { const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX), name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind, kind: kind
}; }
resourcesToDelete.push(resourceToDelete); resourcesToDelete.push(resourceToDelete)
} }
}); })
await deleteObjects(kubectl, resourcesToDelete); await deleteObjects(kubectl, resourcesToDelete)
} }
export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) { export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// delete services and deployments // delete services and deployments
for (const delObject of deleteList) { for (const delObject of deleteList) {
try { try {
const result = await kubectl.delete([delObject.kind, delObject.name]); const result = await kubectl.delete([delObject.kind, delObject.name])
checkForErrors([result]); checkForErrors([result])
} catch (ex) { } catch (ex) {
// Ignore failures of delete if it doesn't exist // Ignore failures of delete if it doesn't exist
} }
} }
} }
// other common functions // other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests { export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList = []; const deploymentEntityList = []
const routedServiceEntityList = []; const routedServiceEntityList = []
const unroutedServiceEntityList = []; const unroutedServiceEntityList = []
const ingressEntityList = []; const ingressEntityList = []
const otherEntitiesList = []; const otherEntitiesList = []
const serviceNameMap = new Map<string, string>(); const serviceNameMap = new Map<string, string>()
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) { if (!!inputObject) {
const kind = inputObject.kind; const kind = inputObject.kind
const name = inputObject.metadata.name; const name = inputObject.metadata.name
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject); deploymentEntityList.push(inputObject)
} else if (isServiceEntity(kind)) { } else if (isServiceEntity(kind)) {
if (isServiceRouted(inputObject, deploymentEntityList)) { if (isServiceRouted(inputObject, deploymentEntityList)) {
routedServiceEntityList.push(inputObject); routedServiceEntityList.push(inputObject)
serviceNameMap.set( serviceNameMap.set(
name, name,
getBlueGreenResourceName(name, GREEN_SUFFIX) getBlueGreenResourceName(name, GREEN_SUFFIX)
); )
} else { } else {
unroutedServiceEntityList.push(inputObject); unroutedServiceEntityList.push(inputObject)
} }
} else if (isIngressEntity(kind)) { } else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject); ingressEntityList.push(inputObject)
} else { } else {
otherEntitiesList.push(inputObject); otherEntitiesList.push(inputObject)
} }
} }
}); })
}); })
return { return {
serviceEntityList: routedServiceEntityList, serviceEntityList: routedServiceEntityList,
serviceNameMap: serviceNameMap, serviceNameMap: serviceNameMap,
unroutedServiceEntityList: unroutedServiceEntityList, unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList, deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList, ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList, otherObjects: otherEntitiesList
}; }
} }
export function isServiceRouted( export function isServiceRouted(
serviceObject: any[], serviceObject: any[],
deploymentEntityList: any[] deploymentEntityList: any[]
): boolean { ): boolean {
let shouldBeRouted: boolean = false; let shouldBeRouted: boolean = false
const serviceSelector: any = getServiceSelector(serviceObject); const serviceSelector: any = getServiceSelector(serviceObject)
if (serviceSelector) { if (serviceSelector) {
if ( if (
deploymentEntityList.some((depObject) => { deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets // finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject); const matchLabels: any = getDeploymentMatchLabels(depObject)
return ( return (
matchLabels && matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels) isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
); )
}) })
) { ) {
shouldBeRouted = true; shouldBeRouted = true
} }
} }
return shouldBeRouted; return shouldBeRouted
} }
export async function createWorkloadsWithLabel( export async function createWorkloadsWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deploymentObjectList: any[], deploymentObjectList: any[],
nextLabel: string nextLabel: string
) { ) {
const newObjectsList = []; const newObjectsList = []
deploymentObjectList.forEach((inputObject) => { deploymentObjectList.forEach((inputObject) => {
// creating deployment with label // creating deployment with label
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel); const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel)
core.debug( core.debug(
"New blue-green object is: " + JSON.stringify(newBlueGreenObject) 'New blue-green object is: ' + JSON.stringify(newBlueGreenObject)
); )
newObjectsList.push(newBlueGreenObject); newObjectsList.push(newBlueGreenObject)
}); })
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const result = await kubectl.apply(manifestFiles); const result = await kubectl.apply(manifestFiles)
return { result: result, newFilePaths: manifestFiles }; return {result: result, newFilePaths: manifestFiles}
} }
export function getNewBlueGreenObject( export function getNewBlueGreenObject(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): object { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
// Updating name only if label is green label is given // Updating name only if label is green label is given
if (labelValue === GREEN_LABEL_VALUE) { if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
GREEN_SUFFIX GREEN_SUFFIX
); )
} }
// Adding labels and annotations // Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue); addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject; return newObject
} }
export function addBlueGreenLabelsAndAnnotations( export function addBlueGreenLabelsAndAnnotations(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
) { ) {
//creating the k8s.deploy.color label //creating the k8s.deploy.color label
const newLabels = new Map<string, string>(); const newLabels = new Map<string, string>()
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue; newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue
// updating object labels and selector labels // updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false); updateObjectLabels(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false); updateSelectorLabels(inputObject, newLabels, false)
// updating spec labels if it is a service // updating spec labels if it is a service
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false); updateSpecLabels(inputObject, newLabels, false)
} }
} }
export function getBlueGreenResourceName(name: string, suffix: string) { export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}`; return `${name}${suffix}`
} }
export function getDeploymentMatchLabels(deploymentObject: any): any { export function getDeploymentMatchLabels(deploymentObject: any): any {
if ( if (
deploymentObject?.kind?.toUpperCase() == deploymentObject?.kind?.toUpperCase() ==
KubernetesWorkload.POD.toUpperCase() && KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels deploymentObject?.metadata?.labels
) { ) {
return deploymentObject.metadata.labels; return deploymentObject.metadata.labels
} else if (deploymentObject?.spec?.selector?.matchLabels) { } else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels; return deploymentObject.spec.selector.matchLabels
} }
} }
export function getServiceSelector(serviceObject: any): any { export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) { if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector; return serviceObject.spec.selector
} }
} }
export function isServiceSelectorSubsetOfMatchLabel( export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any, serviceSelector: any,
matchLabels: any matchLabels: any
): boolean { ): boolean {
const serviceSelectorMap = new Map(); const serviceSelectorMap = new Map()
const matchLabelsMap = new Map(); const matchLabelsMap = new Map()
JSON.parse(JSON.stringify(serviceSelector), (key, value) => { JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value); serviceSelectorMap.set(key, value)
}); })
JSON.parse(JSON.stringify(matchLabels), (key, value) => { JSON.parse(JSON.stringify(matchLabels), (key, value) => {
matchLabelsMap.set(key, value); matchLabelsMap.set(key, value)
}); })
let isMatch = true; let isMatch = true
serviceSelectorMap.forEach((value, key) => { serviceSelectorMap.forEach((value, key) => {
if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value) if (
isMatch = false; !!key &&
}); (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value
)
isMatch = false
})
return isMatch; return isMatch
} }
export async function fetchResource( export async function fetchResource(
kubectl: Kubectl, kubectl: Kubectl,
kind: string, kind: string,
name: string name: string
) { ) {
const result = await kubectl.getResource(kind, name); const result = await kubectl.getResource(kind, name)
if (result == null || !!result.stderr) { if (result == null || !!result.stderr) {
return null; return null
} }
if (!!result.stdout) { if (!!result.stdout) {
const resource = JSON.parse(result.stdout); const resource = JSON.parse(result.stdout)
try { try {
UnsetClusterSpecificDetails(resource); UnsetClusterSpecificDetails(resource)
return resource; return resource
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while Parsing ${resource} in Json object: ${ex}` `Exception occurred while Parsing ${resource} in Json object: ${ex}`
); )
} }
} }
} }
@@ -1,229 +1,229 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests, BlueGreenManifests,
createWorkloadsWithLabel, createWorkloadsWithLabel,
deleteWorkloadsAndServicesWithLabel, deleteWorkloadsAndServicesWithLabel,
fetchResource, fetchResource,
getManifestObjects, getManifestObjects,
getNewBlueGreenObject, getNewBlueGreenObject,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
NONE_LABEL_VALUE, NONE_LABEL_VALUE
} from "./blueGreenHelper"; } from './blueGreenHelper'
import * as core from "@actions/core"; import * as core from '@actions/core'
const BACKEND = "BACKEND"; const BACKEND = 'BACKEND'
export async function deployBlueGreenIngress( export async function deployBlueGreenIngress(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
// get all kubernetes objects defined in manifest files // get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value // create deployments with green label value
const result = createWorkloadsWithLabel( const result = createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create new services and other objects
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE GREEN_LABEL_VALUE
); )
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); // create new services and other objects
await kubectl.apply(manifestFiles); let newObjectsList = []
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
)
newObjectsList.push(newBlueGreenObject)
})
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList)
return result; const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
return result
} }
export async function promoteBlueGreenIngress( export async function promoteBlueGreenIngress(
kubectl: Kubectl, kubectl: Kubectl,
manifestObjects manifestObjects
) { ) {
//checking if anything to promote //checking if anything to promote
if ( if (
!validateIngressesState( !validateIngressesState(
kubectl,
manifestObjects.ingressEntityList,
manifestObjects.serviceNameMap
)
) {
throw 'Ingress not in promote state'
}
// create stable deployments with new configuration
const result = createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.ingressEntityList, manifestObjects.deploymentEntityList,
manifestObjects.serviceNameMap
)
) {
throw "Ingress not in promote state";
}
// create stable deployments with new configuration
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
// create stable services with new configuration
const newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE NONE_LABEL_VALUE
); )
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); // create stable services with new configuration
await kubectl.apply(manifestFiles); const newObjectsList = []
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE
)
newObjectsList.push(newBlueGreenObject)
})
return result; const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles)
return result
} }
export async function rejectBlueGreenIngress( export async function rejectBlueGreenIngress(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
// get all kubernetes objects defined in manifest files // get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// route ingress to stables services // route ingress to stables services
await routeBlueGreenIngress( await routeBlueGreenIngress(
kubectl, kubectl,
null, null,
manifestObjects.serviceNameMap, manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList manifestObjects.ingressEntityList
); )
// delete green services and deployments // delete green services and deployments
await deleteWorkloadsAndServicesWithLabel( await deleteWorkloadsAndServicesWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
} }
export async function routeBlueGreenIngress( export async function routeBlueGreenIngress(
kubectl: Kubectl, kubectl: Kubectl,
nextLabel: string, nextLabel: string,
serviceNameMap: Map<string, string>, serviceNameMap: Map<string, string>,
ingressEntityList: any[] ingressEntityList: any[]
) { ) {
let newObjectsList = []; let newObjectsList = []
if (!nextLabel) { if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) => newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap) isIngressRouted(ingress, serviceNameMap)
); )
} else { } else {
ingressEntityList.forEach((inputObject) => { ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) { if (isIngressRouted(inputObject, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress( const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
inputObject, inputObject,
serviceNameMap, serviceNameMap,
GREEN_LABEL_VALUE GREEN_LABEL_VALUE
); )
newObjectsList.push(newBlueGreenIngressObject); newObjectsList.push(newBlueGreenIngressObject)
} else { } else {
newObjectsList.push(inputObject); newObjectsList.push(inputObject)
} }
}); })
} }
core.debug("New objects: " + JSON.stringify(newObjectsList)); core.debug('New objects: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles); await kubectl.apply(manifestFiles)
} }
export function validateIngressesState( export function validateIngressesState(
kubectl: Kubectl, kubectl: Kubectl,
ingressEntityList: any[], ingressEntityList: any[],
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): boolean { ): boolean {
let areIngressesTargetingNewServices: boolean = true; let areIngressesTargetingNewServices: boolean = true
ingressEntityList.forEach(async (inputObject) => { ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) { if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress //querying existing ingress
const existingIngress = await fetchResource( const existingIngress = await fetchResource(
kubectl, kubectl,
inputObject.kind, inputObject.kind,
inputObject.metadata.name inputObject.metadata.name
); )
if (!!existingIngress) { if (!!existingIngress) {
const currentLabel: string = const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL]; existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL]
// if not green label, then wrong configuration // if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE) if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false; areIngressesTargetingNewServices = false
} else { } else {
// no ingress at all, so nothing to promote // no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false; areIngressesTargetingNewServices = false
}
} }
} })
});
return areIngressesTargetingNewServices; return areIngressesTargetingNewServices
} }
function isIngressRouted( function isIngressRouted(
ingressObject: any, ingressObject: any,
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): boolean { ): boolean {
let isIngressRouted: boolean = false; let isIngressRouted: boolean = false
// check if ingress targets a service in the given manifests // check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => { JSON.parse(JSON.stringify(ingressObject), (key, value) => {
if (key === "serviceName" && serviceNameMap.has(value)) { if (key === 'serviceName' && serviceNameMap.has(value)) {
isIngressRouted = true; isIngressRouted = true
} }
return value; return value
}); })
return isIngressRouted; return isIngressRouted
} }
export function getUpdatedBlueGreenIngress( export function getUpdatedBlueGreenIngress(
inputObject: any, inputObject: any,
serviceNameMap: Map<string, string>, serviceNameMap: Map<string, string>,
type: string type: string
): object { ): object {
if (!type) { if (!type) {
return inputObject; return inputObject
} }
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
// add green labels and values // add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type); addBlueGreenLabelsAndAnnotations(newObject, type)
// update ingress labels // update ingress labels
return updateIngressBackend(newObject, serviceNameMap); return updateIngressBackend(newObject, serviceNameMap)
} }
export function updateIngressBackend( export function updateIngressBackend(
inputObject: any, inputObject: any,
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): any { ): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if (key.toUpperCase() === BACKEND) { if (key.toUpperCase() === BACKEND) {
const { serviceName } = value; const {serviceName} = value
if (serviceNameMap.has(serviceName)) { if (serviceNameMap.has(serviceName)) {
// update service name with corresponding bluegreen name only if service is provied in given manifests // update service name with corresponding bluegreen name only if service is provied in given manifests
value.serviceName = serviceNameMap.get(serviceName); value.serviceName = serviceNameMap.get(serviceName)
}
} }
}
return value; return value
}); })
return inputObject; return inputObject
} }
@@ -1,146 +1,146 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests, BlueGreenManifests,
createWorkloadsWithLabel, createWorkloadsWithLabel,
deleteWorkloadsWithLabel, deleteWorkloadsWithLabel,
fetchResource, fetchResource,
getManifestObjects, getManifestObjects,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
NONE_LABEL_VALUE, NONE_LABEL_VALUE
} from "./blueGreenHelper"; } from './blueGreenHelper'
export async function deployBlueGreenService( export async function deployBlueGreenService(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value // create deployments with green label value
const result = await createWorkloadsWithLabel( const result = await createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE GREEN_LABEL_VALUE
); )
// create other non deployment and non service entities // create other non deployment and non service entities
const newObjectsList = manifestObjects.otherObjects const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.ingressEntityList) .concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList); .concat(manifestObjects.unroutedServiceEntityList)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
if (manifestFiles.length > 0) await kubectl.apply(manifestFiles); if (manifestFiles.length > 0) await kubectl.apply(manifestFiles)
// returning deployment details to check for rollout stability // returning deployment details to check for rollout stability
return result; return result
} }
export async function promoteBlueGreenService( export async function promoteBlueGreenService(
kubectl: Kubectl, kubectl: Kubectl,
manifestObjects manifestObjects
) { ) {
// checking if services are in the right state ie. targeting green deployments // checking if services are in the right state ie. targeting green deployments
if ( if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList)) !(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) { ) {
throw "Not inP promote state"; throw 'Not inP promote state'
} }
// creating stable deployments with new configurations // creating stable deployments with new configurations
return await createWorkloadsWithLabel( return await createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE NONE_LABEL_VALUE
); )
} }
export async function rejectBlueGreenService( export async function rejectBlueGreenService(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
// get all kubernetes objects defined in manifest files // get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// route to stable objects // route to stable objects
await routeBlueGreenService( await routeBlueGreenService(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
// delete new deployments with green suffix // delete new deployments with green suffix
await deleteWorkloadsWithLabel( await deleteWorkloadsWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList manifestObjects.deploymentEntityList
); )
} }
export async function routeBlueGreenService( export async function routeBlueGreenService(
kubectl: Kubectl, kubectl: Kubectl,
nextLabel: string, nextLabel: string,
serviceEntityList: any[] serviceEntityList: any[]
) { ) {
const newObjectsList = []; const newObjectsList = []
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService( const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject, serviceObject,
nextLabel nextLabel
); )
newObjectsList.push(newBlueGreenServiceObject); newObjectsList.push(newBlueGreenServiceObject)
}); })
// configures the services // configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles); await kubectl.apply(manifestFiles)
} }
// add green labels to configure existing service // add green labels to configure existing service
function getUpdatedBlueGreenService( function getUpdatedBlueGreenService(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): object { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
// Adding labels and annotations. // Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue); addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject; return newObject
} }
export async function validateServicesState( export async function validateServicesState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let areServicesGreen: boolean = true; let areServicesGreen: boolean = true
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
// finding the existing routed service // finding the existing routed service
const existingService = await fetchResource( const existingService = await fetchResource(
kubectl, kubectl,
serviceObject.kind, serviceObject.kind,
serviceObject.metadata.name serviceObject.metadata.name
); )
if (!!existingService) { if (!!existingService) {
const currentLabel: string = getServiceSpecLabel(existingService); const currentLabel: string = getServiceSpecLabel(existingService)
if (currentLabel != GREEN_LABEL_VALUE) { if (currentLabel != GREEN_LABEL_VALUE) {
// service should be targeting deployments with green label // service should be targeting deployments with green label
areServicesGreen = false; areServicesGreen = false
}
} else {
// service targeting deployment doesn't exist
areServicesGreen = false
} }
} else { }
// service targeting deployment doesn't exist
areServicesGreen = false;
}
}
return areServicesGreen; return areServicesGreen
} }
export function getServiceSpecLabel(inputObject: any): string { export function getServiceSpecLabel(inputObject: any): string {
if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) { if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL]; return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL]
} }
return ""; return ''
} }
@@ -1,272 +1,277 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as kubectlUtils from "../../utilities/trafficSplitUtils"; import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import { import {
BlueGreenManifests, BlueGreenManifests,
createWorkloadsWithLabel, createWorkloadsWithLabel,
deleteObjects, deleteObjects,
deleteWorkloadsWithLabel, deleteWorkloadsWithLabel,
fetchResource, fetchResource,
getBlueGreenResourceName, getBlueGreenResourceName,
getManifestObjects, getManifestObjects,
getNewBlueGreenObject, getNewBlueGreenObject,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
GREEN_SUFFIX, GREEN_SUFFIX,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
STABLE_SUFFIX, STABLE_SUFFIX
} from "./blueGreenHelper"; } from './blueGreenHelper'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit"; const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit'
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit"; const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
const MIN_VAL = 0; const MIN_VAL = 0
const MAX_VAL = 100; const MAX_VAL = 100
export async function deployBlueGreenSMI( export async function deployBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
// get all kubernetes objects defined in manifest files // get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create services and other objects // create services and other objects
const newObjectsList = manifestObjects.otherObjects const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.serviceEntityList) .concat(manifestObjects.serviceEntityList)
.concat(manifestObjects.ingressEntityList) .concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList); .concat(manifestObjects.unroutedServiceEntityList)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles); await kubectl.apply(manifestFiles)
// make extraservices and trafficsplit // make extraservices and trafficsplit
await setupSMI(kubectl, manifestObjects.serviceEntityList); await setupSMI(kubectl, manifestObjects.serviceEntityList)
// create new deloyments // create new deloyments
return await createWorkloadsWithLabel( return await createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE GREEN_LABEL_VALUE
); )
} }
export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) { export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
// checking if there is something to promote // checking if there is something to promote
if ( if (
!(await validateTrafficSplitsState( !(await validateTrafficSplitsState(
kubectl, kubectl,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
)) ))
) { ) {
throw Error("Not in promote state SMI"); throw Error('Not in promote state SMI')
} }
// create stable deployments with new configuration // create stable deployments with new configuration
return await createWorkloadsWithLabel( return await createWorkloadsWithLabel(
kubectl, kubectl,
manifestObjects.deploymentEntityList, manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE NONE_LABEL_VALUE
); )
} }
export async function rejectBlueGreenSMI( export async function rejectBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] filePaths: string[]
) { ) {
// get all kubernetes objects defined in manifest files // get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// route trafficsplit to stable deploymetns // route trafficsplit to stable deploymetns
await routeBlueGreenSMI( await routeBlueGreenSMI(
kubectl, kubectl,
NONE_LABEL_VALUE, NONE_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.serviceEntityList
); )
// delete rejected new bluegreen deployments // delete rejected new bluegreen deployments
await deleteWorkloadsWithLabel( await deleteWorkloadsWithLabel(
kubectl, kubectl,
GREEN_LABEL_VALUE, GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList manifestObjects.deploymentEntityList
); )
// delete trafficsplit and extra services // delete trafficsplit and extra services
await cleanupSMI(kubectl, manifestObjects.serviceEntityList); await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
} }
export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) { export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const newObjectsList = []; const newObjectsList = []
const trafficObjectList = []; const trafficObjectList = []
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service // create a trafficsplit for service
trafficObjectList.push(serviceObject); trafficObjectList.push(serviceObject)
// set up the services for trafficsplit // set up the services for trafficsplit
const newStableService = getSMIServiceResource( const newStableService = getSMIServiceResource(
serviceObject, serviceObject,
STABLE_SUFFIX STABLE_SUFFIX
); )
const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX); const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX)
newObjectsList.push(newStableService); newObjectsList.push(newStableService)
newObjectsList.push(newGreenService); newObjectsList.push(newGreenService)
}); })
// create services // create services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
await kubectl.apply(manifestFiles); await kubectl.apply(manifestFiles)
// route to stable service // route to stable service
trafficObjectList.forEach((inputObject) => { trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject( createTrafficSplitObject(
kubectl, kubectl,
inputObject.metadata.name, inputObject.metadata.name,
NONE_LABEL_VALUE NONE_LABEL_VALUE
); )
}); })
} }
let trafficSplitAPIVersion = ""; let trafficSplitAPIVersion = ''
async function createTrafficSplitObject( async function createTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
name: string, name: string,
nextLabel: string nextLabel: string
): Promise<any> { ): Promise<any> {
// cache traffic split api version // cache traffic split api version
if (!trafficSplitAPIVersion) if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl kubectl
); )
// decide weights based on nextlabel // decide weights based on nextlabel
const stableWeight: number = const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL; nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL
const greenWeight: number = const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL; nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL
const trafficSplitObject = JSON.stringify({ const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion, apiVersion: trafficSplitAPIVersion,
kind: "TrafficSplit", kind: 'TrafficSplit',
metadata: { metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX), name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
}, },
spec: { spec: {
service: name, service: name,
backends: [ backends: [
{ {
service: getBlueGreenResourceName(name, STABLE_SUFFIX), service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight, weight: stableWeight
}, },
{ {
service: getBlueGreenResourceName(name, GREEN_SUFFIX), service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight, weight: greenWeight
}, }
], ]
}, }
}); })
// create traffic split object // create traffic split object
const trafficSplitManifestFile = fileHelper.writeManifestToFile( const trafficSplitManifestFile = fileHelper.writeManifestToFile(
trafficSplitObject, trafficSplitObject,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX) getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
); )
await kubectl.apply(trafficSplitManifestFile); await kubectl.apply(trafficSplitManifestFile)
} }
export function getSMIServiceResource( export function getSMIServiceResource(
inputObject: any, inputObject: any,
suffix: string suffix: string
): object { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
if (suffix === STABLE_SUFFIX) { if (suffix === STABLE_SUFFIX) {
// adding stable suffix to service name // adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
); )
return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE); return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE)
} else { } else {
// green label will be added for these // green label will be added for these
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE); return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE)
} }
} }
export async function routeBlueGreenSMI( export async function routeBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
nextLabel: string, nextLabel: string,
serviceEntityList: any[] serviceEntityList: any[]
) { ) {
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label // route trafficsplit to given label
await createTrafficSplitObject( await createTrafficSplitObject(
kubectl, kubectl,
serviceObject.metadata.name, serviceObject.metadata.name,
nextLabel nextLabel
); )
} }
} }
export async function validateTrafficSplitsState( export async function validateTrafficSplitsState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let trafficSplitsInRightState: boolean = true; let trafficSplitsInRightState: boolean = true
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name; const name = serviceObject.metadata.name
let trafficSplitObject = await fetchResource( let trafficSplitObject = await fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX) getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
); )
if (!trafficSplitObject) { if (!trafficSplitObject) {
// no traffic split exits // no traffic split exits
trafficSplitsInRightState = false; trafficSplitsInRightState = false
}
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
trafficSplitObject.spec.backends.forEach((element) => {
// checking if trafficsplit in right state to deploy
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
} }
if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) { trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject))
if (element.weight != MIN_VAL) trafficSplitsInRightState = false; trafficSplitObject.spec.backends.forEach((element) => {
} // checking if trafficsplit in right state to deploy
}); if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
} if (element.weight != MAX_VAL) trafficSplitsInRightState = false
}
return trafficSplitsInRightState; if (
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
if (element.weight != MIN_VAL) trafficSplitsInRightState = false
}
})
}
return trafficSplitsInRightState
} }
export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) { export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const deleteList = []; const deleteList = []
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
), ),
kind: TRAFFIC_SPLIT_OBJECT, kind: TRAFFIC_SPLIT_OBJECT
}); })
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX), name: getBlueGreenResourceName(
kind: serviceObject.kind, serviceObject.metadata.name,
}); GREEN_SUFFIX
),
kind: serviceObject.kind
})
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
), ),
kind: serviceObject.kind, kind: serviceObject.kind
}); })
}); })
// delete all objects // delete all objects
await deleteObjects(kubectl, deleteList); await deleteObjects(kubectl, deleteList)
} }
+132 -132
View File
@@ -1,196 +1,196 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import * as core from "@actions/core"; import * as core from '@actions/core'
import { import {
isDeploymentEntity, isDeploymentEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload
} from "../../types/kubernetesTypes"; } from '../../types/kubernetesTypes'
import * as utils from "../../utilities/manifestUpdateUtils"; import * as utils from '../../utilities/manifestUpdateUtils'
import { import {
updateObjectAnnotations, updateObjectAnnotations,
updateObjectLabels, updateObjectLabels,
updateSelectorLabels, updateSelectorLabels
} from "../../utilities/manifestUpdateUtils"; } from '../../utilities/manifestUpdateUtils'
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils"; import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import { checkForErrors } from "../../utilities/kubectlUtils"; import {checkForErrors} from '../../utilities/kubectlUtils'
export const CANARY_VERSION_LABEL = "workflow/version"; export const CANARY_VERSION_LABEL = 'workflow/version'
const BASELINE_SUFFIX = "-baseline"; const BASELINE_SUFFIX = '-baseline'
export const BASELINE_LABEL_VALUE = "baseline"; export const BASELINE_LABEL_VALUE = 'baseline'
const CANARY_SUFFIX = "-canary"; const CANARY_SUFFIX = '-canary'
export const CANARY_LABEL_VALUE = "canary"; export const CANARY_LABEL_VALUE = 'canary'
export const STABLE_SUFFIX = "-stable"; export const STABLE_SUFFIX = '-stable'
export const STABLE_LABEL_VALUE = "stable"; export const STABLE_LABEL_VALUE = 'stable'
export async function deleteCanaryDeployment( export async function deleteCanaryDeployment(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[], manifestFilePaths: string[],
includeServices: boolean includeServices: boolean
) { ) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) { if (manifestFilePaths == null || manifestFilePaths.length == 0) {
throw new Error("Manifest file not found"); throw new Error('Manifest file not found')
} }
await cleanUpCanary(kubectl, manifestFilePaths, includeServices); await cleanUpCanary(kubectl, manifestFilePaths, includeServices)
} }
export function markResourceAsStable(inputObject: any): object { export function markResourceAsStable(inputObject: any): object {
if (isResourceMarkedAsStable(inputObject)) { if (isResourceMarkedAsStable(inputObject)) {
return inputObject; return inputObject
} }
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE); addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE)
return newObject; return newObject
} }
export function isResourceMarkedAsStable(inputObject: any): boolean { export function isResourceMarkedAsStable(inputObject: any): boolean {
return ( return (
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
); )
} }
export function getStableResource(inputObject: any): object { export function getStableResource(inputObject: any): object {
const replicaCount = specContainsReplicas(inputObject.kind) const replicaCount = specContainsReplicas(inputObject.kind)
? inputObject.metadata.replicas ? inputObject.metadata.replicas
: 0; : 0
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE); return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE)
} }
export function getNewBaselineResource( export function getNewBaselineResource(
stableObject: any, stableObject: any,
replicas?: number replicas?: number
): object { ): object {
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE); return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE)
} }
export function getNewCanaryResource( export function getNewCanaryResource(
inputObject: any, inputObject: any,
replicas?: number replicas?: number
): object { ): object {
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE); return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE)
} }
export async function fetchResource( export async function fetchResource(
kubectl: Kubectl, kubectl: Kubectl,
kind: string, kind: string,
name: string name: string
) { ) {
const result = await kubectl.getResource(kind, name); const result = await kubectl.getResource(kind, name)
if (!result || result?.stderr) { if (!result || result?.stderr) {
return null; return null
} }
if (result.stdout) { if (result.stdout) {
const resource = JSON.parse(result.stdout); const resource = JSON.parse(result.stdout)
try { try {
utils.UnsetClusterSpecificDetails(resource); utils.UnsetClusterSpecificDetails(resource)
return resource; return resource
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while Parsing ${resource} in JSON object: ${ex}` `Exception occurred while Parsing ${resource} in JSON object: ${ex}`
); )
} }
} }
} }
export function getCanaryResourceName(name: string) { export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX; return name + CANARY_SUFFIX
} }
export function getBaselineResourceName(name: string) { export function getBaselineResourceName(name: string) {
return name + BASELINE_SUFFIX; return name + BASELINE_SUFFIX
} }
export function getStableResourceName(name: string) { export function getStableResourceName(name: string) {
return name + STABLE_SUFFIX; return name + STABLE_SUFFIX
} }
function getNewCanaryObject( function getNewCanaryObject(
inputObject: any, inputObject: any,
replicas: number, replicas: number,
type: string type: string
): object { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)); const newObject = JSON.parse(JSON.stringify(inputObject))
// Updating name // Updating name
if (type === CANARY_LABEL_VALUE) { if (type === CANARY_LABEL_VALUE) {
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name); newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name)
} else if (type === STABLE_LABEL_VALUE) { } else if (type === STABLE_LABEL_VALUE) {
newObject.metadata.name = getStableResourceName(inputObject.metadata.name); newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
} else { } else {
newObject.metadata.name = getBaselineResourceName( newObject.metadata.name = getBaselineResourceName(
inputObject.metadata.name inputObject.metadata.name
); )
} }
addCanaryLabelsAndAnnotations(newObject, type); addCanaryLabelsAndAnnotations(newObject, type)
if (specContainsReplicas(newObject.kind)) { if (specContainsReplicas(newObject.kind)) {
newObject.spec.replicas = replicas; newObject.spec.replicas = replicas
} }
return newObject; return newObject
} }
function specContainsReplicas(kind: string) { function specContainsReplicas(kind: string) {
return ( return (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
!isServiceEntity(kind) !isServiceEntity(kind)
); )
} }
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) { function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newLabels = new Map<string, string>(); const newLabels = new Map<string, string>()
newLabels[CANARY_VERSION_LABEL] = type; newLabels[CANARY_VERSION_LABEL] = type
updateObjectLabels(inputObject, newLabels, false); updateObjectLabels(inputObject, newLabels, false)
updateObjectAnnotations(inputObject, newLabels, false); updateObjectAnnotations(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false); updateSelectorLabels(inputObject, newLabels, false)
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false); updateSpecLabels(inputObject, newLabels, false)
} }
} }
async function cleanUpCanary( async function cleanUpCanary(
kubectl: Kubectl, kubectl: Kubectl,
files: string[], files: string[],
includeServices: boolean includeServices: boolean
) { ) {
const deleteObject = async function (kind, name) { const deleteObject = async function (kind, name) {
try { try {
const result = await kubectl.delete([kind, name]); const result = await kubectl.delete([kind, name])
checkForErrors([result]); checkForErrors([result])
} catch (ex) { } catch (ex) {
// Ignore failures of delete if it doesn't exist // Ignore failures of delete if it doesn't exist
}
};
for (const filePath of files) {
const fileContents = fs.readFileSync(filePath).toString();
const parsedYaml = yaml.safeLoadAll(fileContents);
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (
isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind))
) {
const canaryObjectName = getCanaryResourceName(name);
const baselineObjectName = getBaselineResourceName(name);
await deleteObject(kind, canaryObjectName);
await deleteObject(kind, baselineObjectName);
} }
} }
}
for (const filePath of files) {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (
isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind))
) {
const canaryObjectName = getCanaryResourceName(name)
const baselineObjectName = getBaselineResourceName(name)
await deleteObject(kind, canaryObjectName)
await deleteObject(kind, baselineObjectName)
}
}
}
} }
+76 -72
View File
@@ -1,90 +1,94 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import * as canaryDeploymentHelper from "./canaryHelper"; import * as canaryDeploymentHelper from './canaryHelper'
import { isDeploymentEntity } from "../../types/kubernetesTypes"; import {isDeploymentEntity} from '../../types/kubernetesTypes'
import { getReplicaCount } from "../../utilities/manifestUpdateUtils"; import {getReplicaCount} from '../../utilities/manifestUpdateUtils'
export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) { export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
const newObjectsList = []; const newObjectsList = []
const percentage = parseInt(core.getInput("percentage")); const percentage = parseInt(core.getInput('percentage'))
if (percentage < 0 || percentage > 100) if (percentage < 0 || percentage > 100)
throw Error("Percentage must be between 0 and 100"); throw Error('Percentage must be between 0 and 100')
for (const filePath of filePaths) { for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents); const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
core.debug("Calculating replica count for canary"); core.debug('Calculating replica count for canary')
const canaryReplicaCount = calculateReplicaCountForCanary( const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject, inputObject,
percentage percentage
); )
core.debug("Replica count is " + canaryReplicaCount); core.debug('Replica count is ' + canaryReplicaCount)
// Get stable object // Get stable object
core.debug("Querying stable object"); core.debug('Querying stable object')
const stableObject = await canaryDeploymentHelper.fetchResource( const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
kind, kind,
name name
); )
if (!stableObject) { if (!stableObject) {
core.debug("Stable object not found. Creating canary object"); core.debug('Stable object not found. Creating canary object')
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( const newCanaryObject =
inputObject, canaryDeploymentHelper.getNewCanaryResource(
canaryReplicaCount inputObject,
); canaryReplicaCount
newObjectsList.push(newCanaryObject); )
} else { newObjectsList.push(newCanaryObject)
core.debug( } else {
"Creating canary and baseline objects. Stable object found: " + core.debug(
JSON.stringify(stableObject) 'Creating canary and baseline objects. Stable object found: ' +
); JSON.stringify(stableObject)
)
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( const newCanaryObject =
inputObject, canaryDeploymentHelper.getNewCanaryResource(
canaryReplicaCount inputObject,
); canaryReplicaCount
core.debug("New canary object: " + JSON.stringify(newCanaryObject)); )
core.debug(
'New canary object: ' + JSON.stringify(newCanaryObject)
)
const newBaselineObject = const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource( canaryDeploymentHelper.getNewBaselineResource(
stableObject, stableObject,
canaryReplicaCount canaryReplicaCount
); )
core.debug( core.debug(
"New baseline object: " + JSON.stringify(newBaselineObject) 'New baseline object: ' + JSON.stringify(newBaselineObject)
); )
newObjectsList.push(newCanaryObject); newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject); newObjectsList.push(newBaselineObject)
} }
} else { } else {
// update non deployment entity as it is // update non deployment entity as it is
newObjectsList.push(inputObject); newObjectsList.push(inputObject)
}
} }
} }
}
core.debug("New objects list: " + JSON.stringify(newObjectsList)); core.debug('New objects list: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput("force").toLowerCase() === "true"; const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(manifestFiles, forceDeployment); const result = await kubectl.apply(manifestFiles, forceDeployment)
return { result, newFilePaths: manifestFiles }; return {result, newFilePaths: manifestFiles}
} }
function calculateReplicaCountForCanary(inputObject: any, percentage: number) { function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
const inputReplicaCount = getReplicaCount(inputObject); const inputReplicaCount = getReplicaCount(inputObject)
return Math.round((inputReplicaCount * percentage) / 100); return Math.round((inputReplicaCount * percentage) / 100)
} }
+266 -257
View File
@@ -1,319 +1,328 @@
import { Kubectl } from "../../types/kubectl"; import {Kubectl} from '../../types/kubectl'
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import * as fileHelper from "../../utilities/fileUtils"; import * as fileHelper from '../../utilities/fileUtils'
import * as kubectlUtils from "../../utilities/trafficSplitUtils"; import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import * as canaryDeploymentHelper from "./canaryHelper"; import * as canaryDeploymentHelper from './canaryHelper'
import { import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
isDeploymentEntity, import {checkForErrors} from '../../utilities/kubectlUtils'
isServiceEntity,
} from "../../types/kubernetesTypes";
import { checkForErrors } from "../../utilities/kubectlUtils";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout"; const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit"; const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) { export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
const canaryReplicaCount = parseInt( const canaryReplicaCount = parseInt(
core.getInput("baseline-and-canary-replicas") core.getInput('baseline-and-canary-replicas')
); )
if (canaryReplicaCount < 0 || canaryReplicaCount > 100) if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
throw Error("Baseline-and-canary-replicas must be between 0 and 100"); throw Error('Baseline-and-canary-replicas must be between 0 and 100')
const newObjectsList = []; const newObjectsList = []
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
const stableObject = canaryDeploymentHelper.fetchResource( const stableObject = canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
kind, kind,
name name
); )
if (!stableObject) { if (!stableObject) {
core.debug("Stable object not found. Creating only canary object"); core.debug(
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( 'Stable object not found. Creating only canary object'
inputObject, )
canaryReplicaCount const newCanaryObject =
); canaryDeploymentHelper.getNewCanaryResource(
newObjectsList.push(newCanaryObject); inputObject,
} else { canaryReplicaCount
if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) { )
throw Error(`StableSpecSelectorNotExist : ${name}`); newObjectsList.push(newCanaryObject)
} } else {
if (
!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)
) {
throw Error(`StableSpecSelectorNotExist : ${name}`)
}
core.debug( core.debug(
"Stable object found. Creating canary and baseline objects" 'Stable object found. Creating canary and baseline objects'
); )
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( const newCanaryObject =
inputObject, canaryDeploymentHelper.getNewCanaryResource(
canaryReplicaCount inputObject,
); canaryReplicaCount
const newBaselineObject = )
canaryDeploymentHelper.getNewBaselineResource( const newBaselineObject =
stableObject, canaryDeploymentHelper.getNewBaselineResource(
canaryReplicaCount stableObject,
); canaryReplicaCount
newObjectsList.push(newCanaryObject); )
newObjectsList.push(newBaselineObject); newObjectsList.push(newCanaryObject)
} newObjectsList.push(newBaselineObject)
} else { }
// Update non deployment entity as it is } else {
newObjectsList.push(inputObject); // Update non deployment entity as it is
} newObjectsList.push(inputObject)
}); }
}); })
})
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList); const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput("force").toLowerCase() === "true"; const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(newFilePaths, forceDeployment); const result = await kubectl.apply(newFilePaths, forceDeployment)
await createCanaryService(kubectl, filePaths); await createCanaryService(kubectl, filePaths)
return { result, newFilePaths }; return {result, newFilePaths}
} }
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) { async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
const newObjectsList = []; const newObjectsList = []
const trafficObjectsList = []; const trafficObjectsList = []
for (const filePath of filePaths) { for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents); const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (isServiceEntity(kind)) { if (isServiceEntity(kind)) {
const newCanaryServiceObject = const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject); canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject); newObjectsList.push(newCanaryServiceObject)
const newBaselineServiceObject = const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject); canaryDeploymentHelper.getNewBaselineResource(inputObject)
newObjectsList.push(newBaselineServiceObject); newObjectsList.push(newBaselineServiceObject)
const stableObject = await canaryDeploymentHelper.fetchResource( const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
kind, kind,
canaryDeploymentHelper.getStableResourceName(name) canaryDeploymentHelper.getStableResourceName(name)
); )
if (!stableObject) { if (!stableObject) {
const newStableServiceObject = const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject); canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(newStableServiceObject); newObjectsList.push(newStableServiceObject)
core.debug("Creating the traffic object for service: " + name); core.debug('Creating the traffic object for service: ' + name)
const trafficObject = await createTrafficSplitManifestFile( const trafficObject = await createTrafficSplitManifestFile(
kubectl, kubectl,
name, name,
0, 0,
0, 0,
1000 1000
); )
trafficObjectsList.push(trafficObject); trafficObjectsList.push(trafficObject)
} else { } else {
let updateTrafficObject = true; let updateTrafficObject = true
const trafficObject = await canaryDeploymentHelper.fetchResource( const trafficObject = await canaryDeploymentHelper.fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name) getTrafficSplitResourceName(name)
); )
if (trafficObject) { if (trafficObject) {
const trafficJObject = JSON.parse(JSON.stringify(trafficObject)); const trafficJObject = JSON.parse(
if (trafficJObject?.spec?.backends) { JSON.stringify(trafficObject)
trafficJObject.spec.backends.forEach((s) => { )
if ( if (trafficJObject?.spec?.backends) {
s.service === trafficJObject.spec.backends.forEach((s) => {
canaryDeploymentHelper.getCanaryResourceName(name) && if (
s.weight === "1000m" s.service ===
) { canaryDeploymentHelper.getCanaryResourceName(
core.debug("Update traffic objcet not required"); name
updateTrafficObject = false; ) &&
} s.weight === '1000m'
}); ) {
core.debug('Update traffic objcet not required')
updateTrafficObject = false
}
})
}
}
if (updateTrafficObject) {
core.debug(
'Stable service object present so updating the traffic object for service: ' +
name
)
trafficObjectsList.push(
updateTrafficSplitObject(kubectl, name)
)
}
} }
} }
if (updateTrafficObject) {
core.debug(
"Stable service object present so updating the traffic object for service: " +
name
);
trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
}
}
} }
} }
}
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...trafficObjectsList); manifestFiles.push(...trafficObjectsList)
const forceDeployment = core.getInput("force").toLowerCase() === "true"; const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(manifestFiles, forceDeployment); const result = await kubectl.apply(manifestFiles, forceDeployment)
checkForErrors([result]); checkForErrors([result])
} }
export async function redirectTrafficToCanaryDeployment( export async function redirectTrafficToCanaryDeployment(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[] manifestFilePaths: string[]
) { ) {
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000); await adjustTraffic(kubectl, manifestFilePaths, 0, 1000)
} }
export async function redirectTrafficToStableDeployment( export async function redirectTrafficToStableDeployment(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[] manifestFilePaths: string[]
) { ) {
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0); await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
} }
async function adjustTraffic( async function adjustTraffic(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[], manifestFilePaths: string[],
stableWeight: number, stableWeight: number,
canaryWeight: number canaryWeight: number
) { ) {
if (!manifestFilePaths || manifestFilePaths?.length == 0) { if (!manifestFilePaths || manifestFilePaths?.length == 0) {
return; return
} }
const trafficSplitManifests = []; const trafficSplitManifests = []
for (const filePath of manifestFilePaths) { for (const filePath of manifestFilePaths) {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents); const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) { for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name; const name = inputObject.metadata.name
const kind = inputObject.kind; const kind = inputObject.kind
if (isServiceEntity(kind)) { if (isServiceEntity(kind)) {
trafficSplitManifests.push( trafficSplitManifests.push(
await createTrafficSplitManifestFile( await createTrafficSplitManifestFile(
kubectl, kubectl,
name, name,
stableWeight, stableWeight,
0, 0,
canaryWeight canaryWeight
) )
); )
}
} }
} }
}
if (trafficSplitManifests.length <= 0) { if (trafficSplitManifests.length <= 0) {
return; return
} }
const forceDeployment = core.getInput("force").toLowerCase() === "true"; const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(trafficSplitManifests, forceDeployment); const result = await kubectl.apply(trafficSplitManifests, forceDeployment)
checkForErrors([result]); checkForErrors([result])
} }
async function updateTrafficSplitObject( async function updateTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
serviceName: string serviceName: string
): Promise<string> { ): Promise<string> {
const percentage = parseInt(core.getInput("percentage")); const percentage = parseInt(core.getInput('percentage'))
if (percentage < 0 || percentage > 100) if (percentage < 0 || percentage > 100)
throw Error("Percentage must be between 0 and 100"); throw Error('Percentage must be between 0 and 100')
const percentageWithMuliplier = percentage * 10; const percentageWithMuliplier = percentage * 10
const baselineAndCanaryWeight = percentageWithMuliplier / 2; const baselineAndCanaryWeight = percentageWithMuliplier / 2
const stableDeploymentWeight = 1000 - percentageWithMuliplier; const stableDeploymentWeight = 1000 - percentageWithMuliplier
core.debug( core.debug(
"Creating the traffic object with canary weight: " + 'Creating the traffic object with canary weight: ' +
baselineAndCanaryWeight + baselineAndCanaryWeight +
",baseling weight: " + ',baseling weight: ' +
baselineAndCanaryWeight + baselineAndCanaryWeight +
",stable: " + ',stable: ' +
stableDeploymentWeight stableDeploymentWeight
); )
return await createTrafficSplitManifestFile( return await createTrafficSplitManifestFile(
kubectl, kubectl,
serviceName, serviceName,
stableDeploymentWeight, stableDeploymentWeight,
baselineAndCanaryWeight, baselineAndCanaryWeight,
baselineAndCanaryWeight baselineAndCanaryWeight
); )
} }
async function createTrafficSplitManifestFile( async function createTrafficSplitManifestFile(
kubectl: Kubectl, kubectl: Kubectl,
serviceName: string, serviceName: string,
stableWeight: number, stableWeight: number,
baselineWeight: number, baselineWeight: number,
canaryWeight: number canaryWeight: number
): Promise<string> { ): Promise<string> {
const smiObjectString = await getTrafficSplitObject( const smiObjectString = await getTrafficSplitObject(
kubectl, kubectl,
serviceName, serviceName,
stableWeight, stableWeight,
baselineWeight, baselineWeight,
canaryWeight canaryWeight
); )
const manifestFile = fileHelper.writeManifestToFile( const manifestFile = fileHelper.writeManifestToFile(
smiObjectString, smiObjectString,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
serviceName serviceName
); )
if (!manifestFile) { if (!manifestFile) {
throw new Error("Unable to create traffic split manifest file"); throw new Error('Unable to create traffic split manifest file')
} }
return manifestFile; return manifestFile
} }
let trafficSplitAPIVersion = ""; let trafficSplitAPIVersion = ''
async function getTrafficSplitObject( async function getTrafficSplitObject(
kubectl: Kubectl, kubectl: Kubectl,
name: string, name: string,
stableWeight: number, stableWeight: number,
baselineWeight: number, baselineWeight: number,
canaryWeight: number canaryWeight: number
): Promise<string> { ): Promise<string> {
// cached version // cached version
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl kubectl
); )
} }
return JSON.stringify({ return JSON.stringify({
apiVersion: trafficSplitAPIVersion, apiVersion: trafficSplitAPIVersion,
kind: "TrafficSplit", kind: 'TrafficSplit',
metadata: { metadata: {
name: getTrafficSplitResourceName(name), name: getTrafficSplitResourceName(name)
}, },
spec: { spec: {
backends: [ backends: [
{ {
service: canaryDeploymentHelper.getStableResourceName(name), service: canaryDeploymentHelper.getStableResourceName(name),
weight: stableWeight, weight: stableWeight
}, },
{ {
service: canaryDeploymentHelper.getBaselineResourceName(name), service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight, weight: baselineWeight
}, },
{ {
service: canaryDeploymentHelper.getCanaryResourceName(name), service: canaryDeploymentHelper.getCanaryResourceName(name),
weight: canaryWeight, weight: canaryWeight
}, }
], ],
service: name, service: name
}, }
}); })
} }
function getTrafficSplitResourceName(name: string) { function getTrafficSplitResourceName(name: string) {
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX; return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
} }
+183 -172
View File
@@ -1,214 +1,225 @@
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import * as canaryDeploymentHelper from "./canary/canaryHelper"; import * as canaryDeploymentHelper from './canary/canaryHelper'
import * as models from "../types/kubernetesTypes"; import * as models from '../types/kubernetesTypes'
import { isDeploymentEntity } from "../types/kubernetesTypes"; import {isDeploymentEntity} from '../types/kubernetesTypes'
import * as fileHelper from "../utilities/fileUtils"; import * as fileHelper from '../utilities/fileUtils'
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils"; import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
import { Kubectl, Resource } from "../types/kubectl"; import {Kubectl, Resource} from '../types/kubectl'
import { deployPodCanary } from "./canary/podCanaryHelper"; import {deployPodCanary} from './canary/podCanaryHelper'
import { deploySMICanary } from "./canary/smiCanaryHelper"; import {deploySMICanary} from './canary/smiCanaryHelper'
import { DeploymentConfig } from "../types/deploymentConfig"; import {DeploymentConfig} from '../types/deploymentConfig'
import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper"; import {deployBlueGreenService} from './blueGreen/serviceBlueGreenHelper'
import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper"; import {deployBlueGreenIngress} from './blueGreen/ingressBlueGreenHelper'
import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper"; import {deployBlueGreenSMI} from './blueGreen/smiBlueGreenHelper'
import { DeploymentStrategy } from "../types/deploymentStrategy"; import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from "@actions/core"; import * as core from '@actions/core'
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod, TrafficSplitMethod
} from "../types/trafficSplitMethod"; } from '../types/trafficSplitMethod'
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy"; import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
import { ExecOutput } from "@actions/exec"; import {ExecOutput} from '@actions/exec'
import { import {
getWorkflowAnnotationKeyLabel, getWorkflowAnnotationKeyLabel,
getWorkflowAnnotations, getWorkflowAnnotations,
} from "../utilities/workflowAnnotationUtils"; cleanLabel
} from '../utilities/workflowAnnotationUtils'
import { import {
annotateChildPods, annotateChildPods,
checkForErrors, checkForErrors,
getLastSuccessfulRunSha, getLastSuccessfulRunSha
} from "../utilities/kubectlUtils"; } from '../utilities/kubectlUtils'
import { import {
getWorkflowFilePath, getWorkflowFilePath,
normalizeWorkflowStrLabel, normalizeWorkflowStrLabel
} from "../utilities/githubUtils"; } from '../utilities/githubUtils'
import { getDeploymentConfig } from "../utilities/dockerUtils"; import {getDeploymentConfig} from '../utilities/dockerUtils'
export async function deployManifests( export async function deployManifests(
files: string[], files: string[],
deploymentStrategy: DeploymentStrategy, deploymentStrategy: DeploymentStrategy,
kubectl: Kubectl, kubectl: Kubectl,
trafficSplitMethod: TrafficSplitMethod trafficSplitMethod: TrafficSplitMethod
): Promise<string[]> { ): Promise<string[]> {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: { case DeploymentStrategy.CANARY: {
const { result, newFilePaths } = const {result, newFilePaths} =
trafficSplitMethod == TrafficSplitMethod.SMI trafficSplitMethod == TrafficSplitMethod.SMI
? await deploySMICanary(files, kubectl) ? await deploySMICanary(files, kubectl)
: await deployPodCanary(files, kubectl); : await deployPodCanary(files, kubectl)
checkForErrors([result]); checkForErrors([result])
return newFilePaths; return newFilePaths
}
case DeploymentStrategy.BLUE_GREEN: {
const routeStrategy = parseRouteStrategy(
core.getInput("route-method", { required: true })
);
const { result, newFilePaths } = await Promise.resolve(
(routeStrategy == RouteStrategy.INGRESS &&
deployBlueGreenIngress(kubectl, files)) ||
(routeStrategy == RouteStrategy.SMI &&
deployBlueGreenSMI(kubectl, files)) ||
deployBlueGreenService(kubectl, files)
);
checkForErrors([result]);
return newFilePaths;
}
case undefined: {
core.warning("Deployment strategy is not recognized.");
}
default: {
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true })
);
const forceDeployment = core.getInput("force").toLowerCase() === "true";
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
const updatedManifests = appendStableVersionLabelToResource(files);
const result = await kubectl.apply(updatedManifests, forceDeployment);
checkForErrors([result]);
} else {
const result = await kubectl.apply(files, forceDeployment);
checkForErrors([result]);
} }
return files; case DeploymentStrategy.BLUE_GREEN: {
} const routeStrategy = parseRouteStrategy(
} core.getInput('route-method', {required: true})
)
const {result, newFilePaths} = await Promise.resolve(
(routeStrategy == RouteStrategy.INGRESS &&
deployBlueGreenIngress(kubectl, files)) ||
(routeStrategy == RouteStrategy.SMI &&
deployBlueGreenSMI(kubectl, files)) ||
deployBlueGreenService(kubectl, files)
)
checkForErrors([result])
return newFilePaths
}
case DeploymentStrategy.BASIC: {
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
const updatedManifests = appendStableVersionLabelToResource(files)
const result = await kubectl.apply(
updatedManifests,
forceDeployment
)
checkForErrors([result])
} else {
const result = await kubectl.apply(files, forceDeployment)
checkForErrors([result])
}
return files
}
default: {
throw new Error('Deployment strategy is not recognized.')
}
}
} }
function appendStableVersionLabelToResource(files: string[]): string[] { function appendStableVersionLabelToResource(files: string[]): string[] {
const manifestFiles = []; const manifestFiles = []
const newObjectsList = []; const newObjectsList = []
files.forEach((filePath: string) => { files.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, function (inputObject) { yaml.safeLoadAll(fileContents, function (inputObject) {
const { kind } = inputObject; const {kind} = inputObject
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
const updatedObject = const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject); canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject); newObjectsList.push(updatedObject)
} else { } else {
manifestFiles.push(filePath); manifestFiles.push(filePath)
} }
}); })
}); })
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...updatedManifestFiles); manifestFiles.push(...updatedManifestFiles)
return manifestFiles; return manifestFiles
} }
export async function checkManifestStability( export async function checkManifestStability(
kubectl: Kubectl, kubectl: Kubectl,
resources: Resource[] resources: Resource[]
): Promise<void> { ): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(kubectl, resources); await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
} }
export async function annotateAndLabelResources( export async function annotateAndLabelResources(
files: string[], files: string[],
kubectl: Kubectl, kubectl: Kubectl,
resourceTypes: Resource[], resourceTypes: Resource[],
allPods: any allPods: any
) { ) {
const githubToken = core.getInput("token"); const githubToken = core.getInput('token')
const workflowFilePath = await getWorkflowFilePath(githubToken); const workflowFilePath = await getWorkflowFilePath(githubToken)
const deploymentConfig = await getDeploymentConfig(); const deploymentConfig = await getDeploymentConfig()
const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath); const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath)
await annotateResources( await annotateResources(
files, files,
kubectl, kubectl,
resourceTypes, resourceTypes,
allPods, allPods,
annotationKeyLabel, annotationKeyLabel,
workflowFilePath, workflowFilePath,
deploymentConfig deploymentConfig
); )
await labelResources(files, kubectl, annotationKeyLabel); await labelResources(files, kubectl, annotationKeyLabel)
} }
async function annotateResources( async function annotateResources(
files: string[], files: string[],
kubectl: Kubectl, kubectl: Kubectl,
resourceTypes: Resource[], resourceTypes: Resource[],
allPods: any, allPods: any,
annotationKey: string, annotationKey: string,
workflowFilePath: string, workflowFilePath: string,
deploymentConfig: DeploymentConfig deploymentConfig: DeploymentConfig
) { ) {
const annotateResults: ExecOutput[] = []; const annotateResults: ExecOutput[] = []
const namespace = core.getInput("namespace") || "default"; const namespace = core.getInput('namespace') || 'default'
const lastSuccessSha = await getLastSuccessfulRunSha( const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl, kubectl,
namespace, namespace,
annotationKey annotationKey
); )
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations( const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
lastSuccessSha, lastSuccessSha,
workflowFilePath, workflowFilePath,
deploymentConfig deploymentConfig
)}`; )}`
annotateResults.push(
await kubectl.annotate("namespace", namespace, annotationKeyValStr)
);
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr));
for (const resource of resourceTypes) { const annotateNamespace = !(
if ( core.getInput('annotate-namespace').toLowerCase() === 'false'
resource.type.toLowerCase() !== )
models.KubernetesWorkload.POD.toLowerCase() if (annotateNamespace) {
) { annotateResults.push(
( await kubectl.annotate('namespace', namespace, annotationKeyValStr)
await annotateChildPods( )
kubectl, }
resource.type, annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr))
resource.name,
annotationKeyValStr,
allPods
)
).forEach((execResult) => annotateResults.push(execResult));
}
}
checkForErrors(annotateResults, true); for (const resource of resourceTypes) {
if (
resource.type.toLowerCase() !==
models.KubernetesWorkload.POD.toLowerCase()
) {
;(
await annotateChildPods(
kubectl,
resource.type,
resource.name,
annotationKeyValStr,
allPods
)
).forEach((execResult) => annotateResults.push(execResult))
}
}
checkForErrors(annotateResults, true)
} }
async function labelResources( async function labelResources(
files: string[], files: string[],
kubectl: Kubectl, kubectl: Kubectl,
label: string label: string
) { ) {
const labels = [ const labels = [
`workflowFriendlyName=${normalizeWorkflowStrLabel( `workflowFriendlyName=${cleanLabel(
process.env.GITHUB_WORKFLOW normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
)}`, )}`,
`workflow=${label}`, `workflow=${cleanLabel(label)}`
]; ]
checkForErrors([await kubectl.labelFiles(files, labels)], true); checkForErrors([await kubectl.labelFiles(files, labels)], true)
} }
+19 -19
View File
@@ -1,22 +1,22 @@
import { Action, parseAction } from "./action"; import {Action, parseAction} from './action'
describe("Action type", () => { describe('Action type', () => {
test("it has required values", () => { test('it has required values', () => {
const vals = <any>Object.values(Action); const vals = <any>Object.values(Action)
expect(vals.includes("deploy")).toBe(true); expect(vals.includes('deploy')).toBe(true)
expect(vals.includes("promote")).toBe(true); expect(vals.includes('promote')).toBe(true)
expect(vals.includes("reject")).toBe(true); expect(vals.includes('reject')).toBe(true)
}); })
test("it can parse valid values from a string", () => { test('it can parse valid values from a string', () => {
expect(parseAction("deploy")).toBe(Action.DEPLOY); expect(parseAction('deploy')).toBe(Action.DEPLOY)
expect(parseAction("Deploy")).toBe(Action.DEPLOY); expect(parseAction('Deploy')).toBe(Action.DEPLOY)
expect(parseAction("DEPLOY")).toBe(Action.DEPLOY); expect(parseAction('DEPLOY')).toBe(Action.DEPLOY)
expect(parseAction("deploY")).toBe(Action.DEPLOY); expect(parseAction('deploY')).toBe(Action.DEPLOY)
}); })
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction("invalid")).toBe(undefined); expect(parseAction('invalid')).toBe(undefined)
expect(parseAction("unsupportedType")).toBe(undefined); expect(parseAction('unsupportedType')).toBe(undefined)
}); })
}); })
+8 -8
View File
@@ -1,7 +1,7 @@
export enum Action { export enum Action {
DEPLOY = "deploy", DEPLOY = 'deploy',
PROMOTE = "promote", PROMOTE = 'promote',
REJECT = "reject", REJECT = 'reject'
} }
/** /**
@@ -10,8 +10,8 @@ export enum Action {
* @returns The Action enum or undefined if it can't be parsed * @returns The Action enum or undefined if it can't be parsed
*/ */
export const parseAction = (str: string): Action | undefined => export const parseAction = (str: string): Action | undefined =>
Action[ Action[
Object.keys(Action).filter( Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase() (k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof Action )[0] as keyof typeof Action
]; ]
+3 -3
View File
@@ -1,5 +1,5 @@
export interface DeploymentConfig { export interface DeploymentConfig {
manifestFilePaths: string[]; manifestFilePaths: string[]
helmChartFilePaths: string[]; helmChartFilePaths: string[]
dockerfilePaths: any; dockerfilePaths: any
} }
+23 -25
View File
@@ -1,27 +1,25 @@
import { import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy'
DeploymentStrategy,
parseDeploymentStrategy,
} from "./deploymentStrategy";
describe("Deployment strategy type", () => { describe('Deployment strategy type', () => {
test("it has required values", () => { test('it has required values', () => {
const vals = <any>Object.values(DeploymentStrategy); const vals = <any>Object.values(DeploymentStrategy)
expect(vals.includes("canary")).toBe(true); expect(vals.includes('canary')).toBe(true)
expect(vals.includes("blue-green")).toBe(true); expect(vals.includes('blue-green')).toBe(true)
}); expect(vals.includes('basic')).toBe(true)
})
test("it can parse valid values from a string", () => { test('it can parse valid values from a string', () => {
expect(parseDeploymentStrategy("blue-green")).toBe( expect(parseDeploymentStrategy('blue-green')).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
); )
expect(parseDeploymentStrategy("Blue-green")).toBe( expect(parseDeploymentStrategy('Blue-green')).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
); )
expect(parseDeploymentStrategy("BLUE-GREEN")).toBe( expect(parseDeploymentStrategy('BLUE-GREEN')).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
); )
expect(parseDeploymentStrategy("blue-greeN")).toBe( expect(parseDeploymentStrategy('blue-greeN')).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
); )
}); })
}); })
+10 -9
View File
@@ -1,6 +1,7 @@
export enum DeploymentStrategy { export enum DeploymentStrategy {
CANARY = "canary", BASIC = 'basic',
BLUE_GREEN = "blue-green", CANARY = 'canary',
BLUE_GREEN = 'blue-green'
} }
/** /**
@@ -9,11 +10,11 @@ export enum DeploymentStrategy {
* @returns The DeploymentStrategy enum or undefined if it can't be parsed * @returns The DeploymentStrategy enum or undefined if it can't be parsed
*/ */
export const parseDeploymentStrategy = ( export const parseDeploymentStrategy = (
str: string str: string
): DeploymentStrategy | undefined => ): DeploymentStrategy | undefined =>
DeploymentStrategy[ DeploymentStrategy[
Object.keys(DeploymentStrategy).filter( Object.keys(DeploymentStrategy).filter(
(k) => (k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase() DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy )[0] as keyof typeof DeploymentStrategy
]; ]
+82 -82
View File
@@ -1,98 +1,98 @@
import { DockerExec } from "./docker"; import {DockerExec} from './docker'
import * as actions from "@actions/exec"; import * as actions from '@actions/exec'
const dockerPath = "dockerPath"; const dockerPath = 'dockerPath'
const image = "image"; const image = 'image'
const args = ["arg1", "arg2", "arg3"]; const args = ['arg1', 'arg2', 'arg3']
describe("Docker class", () => { describe('Docker class', () => {
const docker = new DockerExec(dockerPath); const docker = new DockerExec(dockerPath)
describe("with a success exec return", () => { describe('with a success exec return', () => {
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" }; const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => { jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn; return execReturn
}); })
}); })
test("pulls an image", async () => { test('pulls an image', async () => {
await docker.pull(image, args); await docker.pull(image, args)
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
["pull", image, ...args], ['pull', image, ...args],
{ silent: false } {silent: false}
); )
}); })
test("pulls an image silently", async () => { test('pulls an image silently', async () => {
await docker.pull(image, args, true); await docker.pull(image, args, true)
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
["pull", image, ...args], ['pull', image, ...args],
{ silent: true } {silent: true}
); )
}); })
test("inspects a docker image", async () => { test('inspects a docker image', async () => {
const result = await docker.inspect(image, args); const result = await docker.inspect(image, args)
expect(result).toBe(execReturn.stdout); expect(result).toBe(execReturn.stdout)
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
["inspect", image, ...args], ['inspect', image, ...args],
{ silent: false } {silent: false}
); )
}); })
test("inspects a docker image silently", async () => { test('inspects a docker image silently', async () => {
const result = await docker.inspect(image, args, true); const result = await docker.inspect(image, args, true)
expect(result).toBe(execReturn.stdout); expect(result).toBe(execReturn.stdout)
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
["inspect", image, ...args], ['inspect', image, ...args],
{ silent: true } {silent: true}
); )
}); })
}); })
describe("with an unsuccessful exec return code", () => { describe('with an unsuccessful exec return code', () => {
const execReturn = { exitCode: 3, stdout: "", stderr: "" }; const execReturn = {exitCode: 3, stdout: '', stderr: ''}
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => { jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn; return execReturn
}); })
}); })
test("pulls an image", async () => { test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow(); await expect(docker.pull(image, args)).rejects.toThrow()
}); })
test("inspects a docker image", async () => { test('inspects a docker image', async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow(); ).rejects.toThrow()
}); })
}); })
describe("with an unsuccessful exec return code", () => { describe('with an unsuccessful exec return code', () => {
const execReturn = { exitCode: 0, stdout: "", stderr: "Output" }; const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'}
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => { jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn; return execReturn
}); })
}); })
test("pulls an image", async () => { test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow(); await expect(docker.pull(image, args)).rejects.toThrow()
}); })
test("inspects a docker image", async () => { test('inspects a docker image', async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow(); ).rejects.toThrow()
}); })
}); })
}); })
+24 -24
View File
@@ -1,32 +1,32 @@
import { getExecOutput } from "@actions/exec"; import {getExecOutput} from '@actions/exec'
export class DockerExec { export class DockerExec {
private readonly dockerPath: string; private readonly dockerPath: string
constructor(dockerPath: string) { constructor(dockerPath: string) {
this.dockerPath = dockerPath; this.dockerPath = dockerPath
} }
public async pull(image: string, args: string[], silent?: boolean) { public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(["pull", image, ...args], silent); const result = await this.execute(['pull', image, ...args], silent)
if (result.stderr != "" || result.exitCode != 0) { if (result.stderr != '' || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`); throw new Error(`docker images pull failed: ${result.stderr}`)
} }
} }
public async inspect( public async inspect(
image: string, image: string,
args: string[], args: string[],
silent: boolean = false silent: boolean = false
): Promise<string> { ): Promise<string> {
const result = await this.execute(["inspect", image, ...args], silent); const result = await this.execute(['inspect', image, ...args], silent)
if (result.stderr != "" || result.exitCode != 0) if (result.stderr != '' || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`); throw new Error(`docker inspect failed: ${result.stderr}`)
return result.stdout; return result.stdout
} }
private async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, { silent }); return await getExecOutput(this.dockerPath, args, {silent})
} }
} }
+31 -29
View File
@@ -1,38 +1,40 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import { Octokit } from "@octokit/core"; import {Octokit} from '@octokit/core'
import { Endpoints } from "@octokit/types"; import {Endpoints} from '@octokit/types'
import { retry } from "@octokit/plugin-retry"; import {retry} from '@octokit/plugin-retry'
export const OkStatusCode = 200; export const OkStatusCode = 200
const RetryOctokit = Octokit.plugin(retry); const RetryOctokit = Octokit.plugin(retry)
const RETRY_COUNT = 5; const RETRY_COUNT = 5
const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows"; const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows'
type responseType = type responseType =
Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]; Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response']
export class GitHubClient { export class GitHubClient {
private readonly repository: string; private readonly repository: string
private readonly token: string; private readonly token: string
constructor(repository: string, token: string) { constructor(repository: string, token: string) {
this.repository = repository; this.repository = repository
this.token = token; this.token = token
} }
public async getWorkflows(): Promise<responseType> { // prettier-ignore
const octokit = new RetryOctokit({ public async getWorkflows(): Promise<responseType> {
auth: this.token, const octokit = new RetryOctokit({
request: { retries: RETRY_COUNT }, auth: this.token,
}); request: {retries: RETRY_COUNT},
const [owner, repo] = this.repository.split("/"); baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com",
core.debug(`Getting workflows for repo: ${this.repository}`);
return Promise.resolve(
await octokit.request(requestUrl, {
owner,
repo,
}) })
); const [owner, repo] = this.repository.split('/')
}
core.debug(`Getting workflows for repo: ${this.repository}`)
return Promise.resolve(
await octokit.request(requestUrl, {
owner,
repo
})
)
}
} }
+337 -301
View File
@@ -1,331 +1,367 @@
import { getKubectlPath, Kubectl } from "./kubectl"; import {getKubectlPath, Kubectl} from './kubectl'
import * as exec from "@actions/exec"; import * as exec from '@actions/exec'
import * as io from "@actions/io"; import * as io from '@actions/io'
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as toolCache from "@actions/tool-cache"; import * as toolCache from '@actions/tool-cache'
import { config } from "process"; import {config} from 'process'
describe("Kubectl path", () => { describe('Kubectl path', () => {
const version = "1.1"; const version = '1.1'
const path = "path"; const path = 'path'
it("gets the kubectl path", async () => { it('gets the kubectl path', async () => {
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined); jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, "which").mockImplementationOnce(async () => path); jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
expect(await getKubectlPath()).toBe(path); expect(await getKubectlPath()).toBe(path)
}); })
it("gets the kubectl path with version", async () => { it('gets the kubectl path with version', async () => {
jest.spyOn(core, "getInput").mockImplementationOnce(() => version); jest.spyOn(core, 'getInput').mockImplementationOnce(() => version)
jest.spyOn(toolCache, "find").mockImplementationOnce(() => path); jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path)
expect(await getKubectlPath()).toBe(path); expect(await getKubectlPath()).toBe(path)
}); })
it("throws if kubectl not found", async () => { it('throws if kubectl not found', async () => {
// without version // without version
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined); jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow(); await expect(() => getKubectlPath()).rejects.toThrow()
// with verision // with verision
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined); jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined); jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow(); await expect(() => getKubectlPath()).rejects.toThrow()
}); })
}); })
const kubectlPath = "kubectlPath"; const kubectlPath = 'kubectlPath'
const namespace = "namespace"; const testNamespace = 'testNamespace'
describe("Kubectl class", () => { const defaultNamespace = 'default'
const kubectl = new Kubectl(kubectlPath, namespace); describe('Kubectl class', () => {
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
describe("with a success exec return", () => { beforeEach(() => {
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" }; jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
beforeEach(() => { describe('omits default namespace from commands', () => {
jest.spyOn(exec, "getExecOutput").mockImplementation(async () => { it('executes a command without appending --namespace arg', async () => {
return execReturn; // no args
}); const command = 'command'
}); expect(await kubectl.executeCommand(command)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(kubectlPath, [command], {
silent: false
})
})
})
})
it("applies a configuration with a single config path", async () => { describe('with a success exec return in testNamespace', () => {
const configPaths = "configPaths"; const kubectl = new Kubectl(kubectlPath, testNamespace)
const result = await kubectl.apply(configPaths); const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["apply", "-f", configPaths, "--namespace", namespace],
{ silent: false }
);
});
it("applies a configuration with multiple config paths", async () => { beforeEach(() => {
const configPaths = ["configPath1", "configPath2", "configPath3"]; jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
const result = await kubectl.apply(configPaths); return execReturn
expect(result).toBe(execReturn); })
expect(exec.getExecOutput).toBeCalledWith( })
kubectlPath,
[
"apply",
"-f",
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
"--namespace",
namespace,
],
{ silent: false }
);
});
it("applies a configuration with force when specified", async () => { it('applies a configuration with a single config path', async () => {
const configPaths = ["configPath1", "configPath2", "configPath3"]; const configPaths = 'configPaths'
const result = await kubectl.apply(configPaths, true); const result = await kubectl.apply(configPaths)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ ['apply', '-f', configPaths, '--namespace', testNamespace],
"apply", {silent: false}
"-f", )
configPaths[0] + "," + configPaths[1] + "," + configPaths[2], })
"--force",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("describes a resource", async () => { it('applies a configuration with multiple config paths', async () => {
const resourceType = "type"; const configPaths = ['configPath1', 'configPath2', 'configPath3']
const resourceName = "name"; const result = await kubectl.apply(configPaths)
const result = await kubectl.describe(resourceType, resourceName); expect(result).toBe(execReturn)
expect(result).toBe(execReturn); expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, [
["describe", resourceType, resourceName, "--namespace", namespace], 'apply',
{ silent: false } '-f',
); configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
}); '--namespace',
testNamespace
],
{silent: false}
)
})
it("describes a resource silently", async () => { it('applies a configuration with force when specified', async () => {
const resourceType = "type"; const configPaths = ['configPath1', 'configPath2', 'configPath3']
const resourceName = "name"; const result = await kubectl.apply(configPaths, true)
const result = await kubectl.describe(resourceType, resourceName, true); expect(result).toBe(execReturn)
expect(result).toBe(execReturn); expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, [
["describe", resourceType, resourceName, "--namespace", namespace], 'apply',
{ silent: true } '-f',
); configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
}); '--force',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("annotates resource", async () => { it('describes a resource', async () => {
const resourceType = "type"; const resourceType = 'type'
const resourceName = "name"; const resourceName = 'name'
const annotation = "annotation"; const result = await kubectl.describe(resourceType, resourceName)
const result = await kubectl.annotate( expect(result).toBe(execReturn)
resourceType, expect(exec.getExecOutput).toBeCalledWith(
resourceName, kubectlPath,
annotation [
); 'describe',
expect(result).toBe(execReturn); resourceType,
expect(exec.getExecOutput).toBeCalledWith( resourceName,
kubectlPath, '--namespace',
[ testNamespace
"annotate", ],
resourceType, {silent: false}
resourceName, )
annotation, })
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("annotates files with single file", async () => { it('describes a resource silently', async () => {
const file = "file"; const resourceType = 'type'
const annotation = "annotation"; const resourceName = 'name'
const result = await kubectl.annotateFiles(file, annotation); const result = await kubectl.describe(resourceType, resourceName, true)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
"annotate", 'describe',
"-f", resourceType,
file, resourceName,
annotation, '--namespace',
"--overwrite", testNamespace
"--namespace", ],
namespace, {silent: true}
], )
{ silent: false } })
);
});
it("annotates files with mulitple files", async () => { it('annotates resource', async () => {
const files = ["file1", "file2", "file3"]; const resourceType = 'type'
const annotation = "annotation"; const resourceName = 'name'
const result = await kubectl.annotateFiles(files, annotation); const annotation = 'annotation'
expect(result).toBe(execReturn); const result = await kubectl.annotate(
expect(exec.getExecOutput).toBeCalledWith( resourceType,
kubectlPath, resourceName,
[ annotation
"annotate", )
"-f", expect(result).toBe(execReturn)
files.join(","), expect(exec.getExecOutput).toBeCalledWith(
annotation, kubectlPath,
"--overwrite", [
"--namespace", 'annotate',
namespace, resourceType,
], resourceName,
{ silent: false } annotation,
); '--overwrite',
}); '--namespace',
testNamespace
],
{silent: false}
)
})
it("labels files with single file", async () => { it('annotates files with single file', async () => {
const file = "file"; const file = 'file'
const labels = ["label1", "label2"]; const annotation = 'annotation'
const result = await kubectl.labelFiles(file, labels); const result = await kubectl.annotateFiles(file, annotation)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
"label", 'annotate',
"-f", '-f',
file, file,
...labels, annotation,
"--overwrite", '--overwrite',
"--namespace", '--namespace',
namespace, testNamespace
], ],
{ silent: false } {silent: false}
); )
}); })
it("labels files with multiple files", async () => { it('annotates files with mulitple files', async () => {
const files = ["file1", "file2", "file3"]; const files = ['file1', 'file2', 'file3']
const labels = ["label1", "label2"]; const annotation = 'annotation'
const result = await kubectl.labelFiles(files, labels); const result = await kubectl.annotateFiles(files, annotation)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
"label", 'annotate',
"-f", '-f',
files.join(","), files.join(','),
...labels, annotation,
"--overwrite", '--overwrite',
"--namespace", '--namespace',
namespace, testNamespace
], ],
{ silent: false } {silent: false}
); )
}); })
it("gets all pods", async () => { it('labels files with single file', async () => {
expect(await kubectl.getAllPods()).toBe(execReturn); const file = 'file'
expect(exec.getExecOutput).toBeCalledWith( const labels = ['label1', 'label2']
kubectlPath, const result = await kubectl.labelFiles(file, labels)
["get", "pods", "-o", "json", "--namespace", namespace], expect(result).toBe(execReturn)
{ silent: true } expect(exec.getExecOutput).toBeCalledWith(
); kubectlPath,
}); [
'label',
'-f',
file,
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("checks rollout status", async () => { it('labels files with multiple files', async () => {
const resourceType = "type"; const files = ['file1', 'file2', 'file3']
const name = "name"; const labels = ['label1', 'label2']
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe( const result = await kubectl.labelFiles(files, labels)
execReturn expect(result).toBe(execReturn)
); expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, [
[ 'label',
"rollout", '-f',
"status", files.join(','),
`${resourceType}/${name}`, ...labels,
"--namespace", '--overwrite',
namespace, '--namespace',
], testNamespace
{ silent: false } ],
); {silent: false}
}); )
})
it("gets resource", async () => { it('gets all pods', async () => {
const resourceType = "type"; expect(await kubectl.getAllPods()).toBe(execReturn)
const name = "name"; expect(exec.getExecOutput).toBeCalledWith(
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn); kubectlPath,
expect(exec.getExecOutput).toBeCalledWith( ['get', 'pods', '-o', 'json', '--namespace', testNamespace],
kubectlPath, {silent: true}
[ )
"get", })
`${resourceType}/${name}`,
"-o",
"json",
"--namespace",
namespace,
],
{ silent: false }
);
});
it("executes a command", async () => { it('checks rollout status', async () => {
// no args const resourceType = 'type'
const command = "command"; const name = 'name'
expect(await kubectl.executeCommand(command)).toBe(execReturn); expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
expect(exec.getExecOutput).toBeCalledWith( execReturn
kubectlPath, )
[command, "--namespace", namespace], expect(exec.getExecOutput).toBeCalledWith(
{ silent: false } kubectlPath,
); [
'rollout',
'status',
`${resourceType}/${name}`,
'--namespace',
testNamespace
],
{silent: false}
)
})
// with args it('gets resource', async () => {
const args = "args"; const resourceType = 'type'
expect(await kubectl.executeCommand(command, args)).toBe(execReturn); const name = 'name'
expect(exec.getExecOutput).toBeCalledWith( expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[command, args, "--namespace", namespace], kubectlPath,
{ silent: false } [
); 'get',
}); `${resourceType}/${name}`,
'-o',
'json',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("deletes with single argument", async () => { it('executes a command', async () => {
const arg = "argument"; // no args
expect(await kubectl.delete(arg)).toBe(execReturn); const command = 'command'
expect(exec.getExecOutput).toBeCalledWith( expect(await kubectl.executeCommand(command)).toBe(execReturn)
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
["delete", arg, "--namespace", namespace], kubectlPath,
{ silent: false } [command, '--namespace', testNamespace],
); {silent: false}
}); )
it("deletes with multiple arguments", async () => { // with args
const args = ["argument1", "argument2", "argument3"]; const args = 'args'
expect(await kubectl.delete(args)).toBe(execReturn); expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
["delete", ...args, "--namespace", namespace], [command, args, '--namespace', testNamespace],
{ silent: false } {silent: false}
); )
}); })
});
it("gets new replica sets", async () => { it('deletes with single argument', async () => {
const newReplicaSetName = "newreplicaset"; const arg = 'argument'
const name = "name"; expect(await kubectl.delete(arg)).toBe(execReturn)
const describeReturn = { expect(exec.getExecOutput).toBeCalledWith(
exitCode: 0, kubectlPath,
stdout: newReplicaSetName + name + " " + "extra", ['delete', arg, '--namespace', testNamespace],
stderr: "", {silent: false}
}; )
})
jest.spyOn(exec, "getExecOutput").mockImplementationOnce(async () => { it('deletes with multiple arguments', async () => {
return describeReturn; const args = ['argument1', 'argument2', 'argument3']
}); expect(await kubectl.delete(args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', ...args, '--namespace', testNamespace],
{silent: false}
)
})
})
const deployment = "deployment"; it('gets new replica sets', async () => {
const result = await kubectl.getNewReplicaSet(deployment); const kubectl = new Kubectl(kubectlPath, testNamespace)
expect(result).toBe(name);
}); const newReplicaSetName = 'newreplicaset'
}); const name = 'name'
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra',
stderr: ''
}
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
return describeReturn
})
const deployment = 'deployment'
const result = await kubectl.getNewReplicaSet(deployment)
expect(result).toBe(name)
})
})
+154 -141
View File
@@ -1,168 +1,181 @@
import { ExecOutput, getExecOutput } from "@actions/exec"; import {ExecOutput, getExecOutput} from '@actions/exec'
import { createInlineArray } from "../utilities/arrayUtils"; import {createInlineArray} from '../utilities/arrayUtils'
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as toolCache from "@actions/tool-cache"; import * as toolCache from '@actions/tool-cache'
import * as io from "@actions/io"; import * as io from '@actions/io'
export interface Resource { export interface Resource {
name: string; name: string
type: string; type: string
} }
export class Kubectl { export class Kubectl {
private readonly kubectlPath: string; private readonly kubectlPath: string
private readonly namespace: string; private readonly namespace: string
private readonly ignoreSSLErrors: boolean; private readonly ignoreSSLErrors: boolean
constructor( constructor(
kubectlPath: string, kubectlPath: string,
namespace: string = "default", namespace: string = 'default',
ignoreSSLErrors: boolean = false ignoreSSLErrors: boolean = false
) { ) {
this.kubectlPath = kubectlPath; this.kubectlPath = kubectlPath
this.ignoreSSLErrors = !!ignoreSSLErrors; this.ignoreSSLErrors = !!ignoreSSLErrors
this.namespace = namespace; this.namespace = namespace
} }
public async apply( public async apply(
configurationPaths: string | string[], configurationPaths: string | string[],
force: boolean = false force: boolean = false
): Promise<ExecOutput> { ): Promise<ExecOutput> {
try { try {
if (!configurationPaths || configurationPaths?.length === 0) if (!configurationPaths || configurationPaths?.length === 0)
throw Error("Configuration paths must exist"); throw Error('Configuration paths must exist')
const applyArgs: string[] = [ const applyArgs: string[] = [
"apply", 'apply',
"-f", '-f',
createInlineArray(configurationPaths), createInlineArray(configurationPaths)
]; ]
if (force) applyArgs.push("--force"); if (force) applyArgs.push('--force')
return await this.execute(applyArgs); return await this.execute(applyArgs)
} catch (err) { } catch (err) {
core.debug("Kubectl apply failed:" + err); core.debug('Kubectl apply failed:' + err)
} }
} }
public async describe( public async describe(
resourceType: string, resourceType: string,
resourceName: string, resourceName: string,
silent: boolean = false silent: boolean = false
): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute(["describe", resourceType, resourceName], silent); return await this.execute(
} ['describe', resourceType, resourceName],
silent
)
}
public async getNewReplicaSet(deployment: string) { public async getNewReplicaSet(deployment: string) {
const result = await this.describe("deployment", deployment, true); const result = await this.describe('deployment', deployment, true)
let newReplicaSet = ""; let newReplicaSet = ''
if (result?.stdout) { if (result?.stdout) {
const stdout = result.stdout.split("\n"); const stdout = result.stdout.split('\n')
stdout.forEach((line: string) => { stdout.forEach((line: string) => {
const newreplicaset = "newreplicaset"; const newreplicaset = 'newreplicaset'
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
newReplicaSet = line newReplicaSet = line
.substring(newreplicaset.length) .substring(newreplicaset.length)
.trim() .trim()
.split(" ")[0]; .split(' ')[0]
}); })
} }
return newReplicaSet; return newReplicaSet
} }
public async annotate( public async annotate(
resourceType: string, resourceType: string,
resourceName: string, resourceName: string,
annotation: string annotation: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
"annotate", 'annotate',
resourceType, resourceType,
resourceName, resourceName,
annotation, annotation,
"--overwrite", '--overwrite'
]; ]
return await this.execute(args); return await this.execute(args)
} }
public async annotateFiles( public async annotateFiles(
files: string | string[], files: string | string[],
annotation: string annotation: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
"annotate", 'annotate',
"-f", '-f',
createInlineArray(files), createInlineArray(files),
annotation, annotation,
"--overwrite", '--overwrite'
]; ]
return await this.execute(args); return await this.execute(args)
} }
public async labelFiles( public async labelFiles(
files: string | string[], files: string | string[],
labels: string[] labels: string[]
): Promise<ExecOutput> { ): Promise<ExecOutput> {
const args = [ const args = [
"label", 'label',
"-f", '-f',
createInlineArray(files), createInlineArray(files),
...labels, ...labels,
"--overwrite", '--overwrite'
]; ]
return await this.execute(args); return await this.execute(args)
} }
public async getAllPods(): Promise<ExecOutput> { public async getAllPods(): Promise<ExecOutput> {
return await this.execute(["get", "pods", "-o", "json"], true); return await this.execute(['get', 'pods', '-o', 'json'], true)
} }
public async checkRolloutStatus( public async checkRolloutStatus(
resourceType: string, resourceType: string,
name: string name: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute(["rollout", "status", `${resourceType}/${name}`]); return await this.execute([
} 'rollout',
'status',
`${resourceType}/${name}`
])
}
public async getResource( public async getResource(
resourceType: string, resourceType: string,
name: string name: string
): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]); return await this.execute([
} 'get',
`${resourceType}/${name}`,
'-o',
'json'
])
}
public executeCommand(command: string, args?: string) { public executeCommand(command: string, args?: string) {
if (!command) throw new Error("Command must be defined"); if (!command) throw new Error('Command must be defined')
return args ? this.execute([command, args]) : this.execute([command]); return args ? this.execute([command, args]) : this.execute([command])
} }
public delete(args: string | string[]) { public delete(args: string | string[]) {
if (typeof args === "string") return this.execute(["delete", args]); if (typeof args === 'string') return this.execute(['delete', args])
return this.execute(["delete", ...args]); return this.execute(['delete', ...args])
} }
private async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
if (this.ignoreSSLErrors) { if (this.ignoreSSLErrors) {
args.push("--insecure-skip-tls-verify"); args.push('--insecure-skip-tls-verify')
} }
args = args.concat(["--namespace", this.namespace]); if (this.namespace && this.namespace != 'default') {
args = args.concat(['--namespace', this.namespace])
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`); }
return await getExecOutput(this.kubectlPath, args, { silent }); core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
} return await getExecOutput(this.kubectlPath, args, {silent})
}
} }
export async function getKubectlPath() { export async function getKubectlPath() {
const version = core.getInput("kubectl-version"); const version = core.getInput('kubectl-version')
const kubectlPath = version const kubectlPath = version
? toolCache.find("kubectl", version) ? toolCache.find('kubectl', version)
: await io.which("kubectl", true); : await io.which('kubectl', true)
if (!kubectlPath) if (!kubectlPath)
throw Error( throw Error(
"kubectl not found. You must install it before running this action" 'kubectl not found. You must install it before running this action'
); )
return kubectlPath; return kubectlPath
} }
+102 -100
View File
@@ -1,115 +1,117 @@
import { import {
DEPLOYMENT_TYPES, DEPLOYMENT_TYPES,
DiscoveryAndLoadBalancerResource, DiscoveryAndLoadBalancerResource,
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
ResourceKindNotDefinedError, ResourceKindNotDefinedError,
ServiceTypes, ServiceTypes,
WORKLOAD_TYPES, WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS, WORKLOAD_TYPES_WITH_ROLLOUT_STATUS
} from "./kubernetesTypes"; } from './kubernetesTypes'
describe("Kubernetes types", () => { describe('Kubernetes types', () => {
it("contains kubernetes workloads", () => { it('contains kubernetes workloads', () => {
expect(KubernetesWorkload.POD).toBe("Pod"); expect(KubernetesWorkload.POD).toBe('Pod')
expect(KubernetesWorkload.REPLICASET).toBe("Replicaset"); expect(KubernetesWorkload.REPLICASET).toBe('Replicaset')
expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment"); expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment')
expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet"); expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet')
expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet"); expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet')
expect(KubernetesWorkload.JOB).toBe("job"); expect(KubernetesWorkload.JOB).toBe('job')
expect(KubernetesWorkload.CRON_JOB).toBe("cronjob"); expect(KubernetesWorkload.CRON_JOB).toBe('cronjob')
}); })
it("contains discovery and load balancer resources", () => { it('contains discovery and load balancer resources', () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service"); expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service')
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress"); expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress')
}); })
it("contains service types", () => { it('contains service types', () => {
expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer"); expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer')
expect(ServiceTypes.NODE_PORT).toBe("NodePort"); expect(ServiceTypes.NODE_PORT).toBe('NodePort')
expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP"); expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP')
}); })
it("contains deployment types", () => { it('contains deployment types', () => {
const expected = [ const expected = [
"deployment", 'deployment',
"replicaset", 'replicaset',
"daemonset", 'daemonset',
"pod", 'pod',
"statefulset", 'statefulset'
]; ]
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true); expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true)
}); })
it("contains workload types", () => { it('contains workload types', () => {
const expected = [ const expected = [
"deployment", 'deployment',
"replicaset", 'replicaset',
"daemonset", 'daemonset',
"pod", 'pod',
"statefulset", 'statefulset',
"job", 'job',
"cronjob", 'cronjob'
]; ]
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true); expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true)
}); })
it("contains workload types with rollout status", () => { it('contains workload types with rollout status', () => {
const expected = ["deployment", "daemonset", "statefulset"]; const expected = ['deployment', 'daemonset', 'statefulset']
expect( expect(
expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val)) expected.every((val) =>
).toBe(true); WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val)
}); )
).toBe(true)
})
it("checks if kind is deployment entity", () => { it('checks if kind is deployment entity', () => {
// throws on no kind // throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow( expect(() => isDeploymentEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
); )
expect(isDeploymentEntity("deployment")).toBe(true); expect(isDeploymentEntity('deployment')).toBe(true)
expect(isDeploymentEntity("Deployment")).toBe(true); expect(isDeploymentEntity('Deployment')).toBe(true)
expect(isDeploymentEntity("deploymenT")).toBe(true); expect(isDeploymentEntity('deploymenT')).toBe(true)
expect(isDeploymentEntity("DEPLOYMENT")).toBe(true); expect(isDeploymentEntity('DEPLOYMENT')).toBe(true)
}); })
it("checks if kind is workload entity", () => { it('checks if kind is workload entity', () => {
// throws on no kind // throws on no kind
expect(() => isWorkloadEntity(undefined)).toThrow( expect(() => isWorkloadEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
); )
expect(isWorkloadEntity("deployment")).toBe(true); expect(isWorkloadEntity('deployment')).toBe(true)
expect(isWorkloadEntity("Deployment")).toBe(true); expect(isWorkloadEntity('Deployment')).toBe(true)
expect(isWorkloadEntity("deploymenT")).toBe(true); expect(isWorkloadEntity('deploymenT')).toBe(true)
expect(isWorkloadEntity("DEPLOYMENT")).toBe(true); expect(isWorkloadEntity('DEPLOYMENT')).toBe(true)
}); })
it("checks if kind is service entity", () => { it('checks if kind is service entity', () => {
// throws on no kind // throws on no kind
expect(() => isServiceEntity(undefined)).toThrow( expect(() => isServiceEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
); )
expect(isServiceEntity("service")).toBe(true); expect(isServiceEntity('service')).toBe(true)
expect(isServiceEntity("Service")).toBe(true); expect(isServiceEntity('Service')).toBe(true)
expect(isServiceEntity("servicE")).toBe(true); expect(isServiceEntity('servicE')).toBe(true)
expect(isServiceEntity("SERVICE")).toBe(true); expect(isServiceEntity('SERVICE')).toBe(true)
}); })
it("checks if kind is ingress entity", () => { it('checks if kind is ingress entity', () => {
// throws on no kind // throws on no kind
expect(() => isIngressEntity(undefined)).toThrow( expect(() => isIngressEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
); )
expect(isIngressEntity("ingress")).toBe(true); expect(isIngressEntity('ingress')).toBe(true)
expect(isIngressEntity("Ingress")).toBe(true); expect(isIngressEntity('Ingress')).toBe(true)
expect(isIngressEntity("ingresS")).toBe(true); expect(isIngressEntity('ingresS')).toBe(true)
expect(isIngressEntity("INGRESS")).toBe(true); expect(isIngressEntity('INGRESS')).toBe(true)
}); })
}); })
+48 -48
View File
@@ -1,81 +1,81 @@
export class KubernetesWorkload { export class KubernetesWorkload {
public static POD: string = "Pod"; public static POD: string = 'Pod'
public static REPLICASET: string = "Replicaset"; public static REPLICASET: string = 'Replicaset'
public static DEPLOYMENT: string = "Deployment"; public static DEPLOYMENT: string = 'Deployment'
public static STATEFUL_SET: string = "StatefulSet"; public static STATEFUL_SET: string = 'StatefulSet'
public static DAEMON_SET: string = "DaemonSet"; public static DAEMON_SET: string = 'DaemonSet'
public static JOB: string = "job"; public static JOB: string = 'job'
public static CRON_JOB: string = "cronjob"; public static CRON_JOB: string = 'cronjob'
} }
export class DiscoveryAndLoadBalancerResource { export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = "service"; public static SERVICE: string = 'service'
public static INGRESS: string = "ingress"; public static INGRESS: string = 'ingress'
} }
export class ServiceTypes { export class ServiceTypes {
public static LOAD_BALANCER: string = "LoadBalancer"; public static LOAD_BALANCER: string = 'LoadBalancer'
public static NODE_PORT: string = "NodePort"; public static NODE_PORT: string = 'NodePort'
public static CLUSTER_IP: string = "ClusterIP"; public static CLUSTER_IP: string = 'ClusterIP'
} }
export const DEPLOYMENT_TYPES: string[] = [ export const DEPLOYMENT_TYPES: string[] = [
"deployment", 'deployment',
"replicaset", 'replicaset',
"daemonset", 'daemonset',
"pod", 'pod',
"statefulset", 'statefulset'
]; ]
export const WORKLOAD_TYPES: string[] = [ export const WORKLOAD_TYPES: string[] = [
"deployment", 'deployment',
"replicaset", 'replicaset',
"daemonset", 'daemonset',
"pod", 'pod',
"statefulset", 'statefulset',
"job", 'job',
"cronjob", 'cronjob'
]; ]
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [ export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
"deployment", 'deployment',
"daemonset", 'daemonset',
"statefulset", 'statefulset'
]; ]
export function isDeploymentEntity(kind: string): boolean { export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError; if (!kind) throw ResourceKindNotDefinedError
return DEPLOYMENT_TYPES.some((type: string) => { return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase(); return type.toLowerCase() === kind.toLowerCase()
}); })
} }
export function isWorkloadEntity(kind: string): boolean { export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError; if (!kind) throw ResourceKindNotDefinedError
return WORKLOAD_TYPES.some( return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase() (type: string) => type.toLowerCase() === kind.toLowerCase()
); )
} }
export function isServiceEntity(kind: string): boolean { export function isServiceEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError; if (!kind) throw ResourceKindNotDefinedError
return "service" === kind.toLowerCase(); return 'service' === kind.toLowerCase()
} }
export function isIngressEntity(kind: string): boolean { export function isIngressEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError; if (!kind) throw ResourceKindNotDefinedError
return "ingress" === kind.toLowerCase(); return 'ingress' === kind.toLowerCase()
} }
export const ResourceKindNotDefinedError = Error("Resource kind not defined"); export const ResourceKindNotDefinedError = Error('Resource kind not defined')
export const NullInputObjectError = Error("Null inputObject"); export const NullInputObjectError = Error('Null inputObject')
export const InputObjectKindNotDefinedError = Error( export const InputObjectKindNotDefinedError = Error(
"Input object kind not defined" 'Input object kind not defined'
); )
export const InputObjectMetadataNotDefinedError = Error( export const InputObjectMetadataNotDefinedError = Error(
"Input object metatada not defined" 'Input object metatada not defined'
); )
+19 -19
View File
@@ -1,22 +1,22 @@
import { parseRouteStrategy, RouteStrategy } from "./routeStrategy"; import {parseRouteStrategy, RouteStrategy} from './routeStrategy'
describe("Route strategy type", () => { describe('Route strategy type', () => {
test("it has required values", () => { test('it has required values', () => {
const vals = <any>Object.values(RouteStrategy); const vals = <any>Object.values(RouteStrategy)
expect(vals.includes("ingress")).toBe(true); expect(vals.includes('ingress')).toBe(true)
expect(vals.includes("smi")).toBe(true); expect(vals.includes('smi')).toBe(true)
expect(vals.includes("service")).toBe(true); expect(vals.includes('service')).toBe(true)
}); })
test("it can parse valid values from a string", () => { test('it can parse valid values from a string', () => {
expect(parseRouteStrategy("ingress")).toBe(RouteStrategy.INGRESS); expect(parseRouteStrategy('ingress')).toBe(RouteStrategy.INGRESS)
expect(parseRouteStrategy("Ingress")).toBe(RouteStrategy.INGRESS); expect(parseRouteStrategy('Ingress')).toBe(RouteStrategy.INGRESS)
expect(parseRouteStrategy("ingresS")).toBe(RouteStrategy.INGRESS); expect(parseRouteStrategy('ingresS')).toBe(RouteStrategy.INGRESS)
expect(parseRouteStrategy("INGRESS")).toBe(RouteStrategy.INGRESS); expect(parseRouteStrategy('INGRESS')).toBe(RouteStrategy.INGRESS)
}); })
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy("invalid")).toBe(undefined); expect(parseRouteStrategy('invalid')).toBe(undefined)
expect(parseRouteStrategy("unsupportedType")).toBe(undefined); expect(parseRouteStrategy('unsupportedType')).toBe(undefined)
}); })
}); })
+8 -8
View File
@@ -1,12 +1,12 @@
export enum RouteStrategy { export enum RouteStrategy {
INGRESS = "ingress", INGRESS = 'ingress',
SMI = "smi", SMI = 'smi',
SERVICE = "service", SERVICE = 'service'
} }
export const parseRouteStrategy = (str: string): RouteStrategy | undefined => export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
RouteStrategy[ RouteStrategy[
Object.keys(RouteStrategy).filter( Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase() (k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy )[0] as keyof typeof RouteStrategy
]; ]
+18 -21
View File
@@ -1,24 +1,21 @@
import { import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod'
parseTrafficSplitMethod,
TrafficSplitMethod,
} from "./trafficSplitMethod";
describe("Traffic split method type", () => { describe('Traffic split method type', () => {
test("it has required values", () => { test('it has required values', () => {
const vals = <any>Object.values(TrafficSplitMethod); const vals = <any>Object.values(TrafficSplitMethod)
expect(vals.includes("pod")).toBe(true); expect(vals.includes('pod')).toBe(true)
expect(vals.includes("smi")).toBe(true); expect(vals.includes('smi')).toBe(true)
}); })
test("it can parse valid values from a string", () => { test('it can parse valid values from a string', () => {
expect(parseTrafficSplitMethod("pod")).toBe(TrafficSplitMethod.POD); expect(parseTrafficSplitMethod('pod')).toBe(TrafficSplitMethod.POD)
expect(parseTrafficSplitMethod("Pod")).toBe(TrafficSplitMethod.POD); expect(parseTrafficSplitMethod('Pod')).toBe(TrafficSplitMethod.POD)
expect(parseTrafficSplitMethod("poD")).toBe(TrafficSplitMethod.POD); expect(parseTrafficSplitMethod('poD')).toBe(TrafficSplitMethod.POD)
expect(parseTrafficSplitMethod("POD")).toBe(TrafficSplitMethod.POD); expect(parseTrafficSplitMethod('POD')).toBe(TrafficSplitMethod.POD)
}); })
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod("invalid")).toBe(undefined); expect(parseTrafficSplitMethod('invalid')).toBe(undefined)
expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined); expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined)
}); })
}); })
+9 -9
View File
@@ -1,6 +1,6 @@
export enum TrafficSplitMethod { export enum TrafficSplitMethod {
POD = "pod", POD = 'pod',
SMI = "smi", SMI = 'smi'
} }
/** /**
@@ -9,11 +9,11 @@ export enum TrafficSplitMethod {
* @returns The TrafficSplitMethod enum or undefined if it can't be parsed * @returns The TrafficSplitMethod enum or undefined if it can't be parsed
*/ */
export const parseTrafficSplitMethod = ( export const parseTrafficSplitMethod = (
str: string str: string
): TrafficSplitMethod | undefined => ): TrafficSplitMethod | undefined =>
TrafficSplitMethod[ TrafficSplitMethod[
Object.keys(TrafficSplitMethod).filter( Object.keys(TrafficSplitMethod).filter(
(k) => (k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase() TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod )[0] as keyof typeof TrafficSplitMethod
]; ]
+10 -10
View File
@@ -1,12 +1,12 @@
import { createInlineArray } from "./arrayUtils"; import {createInlineArray} from './arrayUtils'
describe("array utilities", () => { describe('array utilities', () => {
it("creates an inline array", () => { it('creates an inline array', () => {
const strings = ["str1", "str2", "str3"]; const strings = ['str1', 'str2', 'str3']
expect(createInlineArray(strings)).toBe(strings.join(",")); expect(createInlineArray(strings)).toBe(strings.join(','))
const string = "str1"; const string = 'str1'
expect(createInlineArray([string])).toBe(string); expect(createInlineArray([string])).toBe(string)
expect(createInlineArray(string)).toBe(string); expect(createInlineArray(string)).toBe(string)
}); })
}); })
+4 -4
View File
@@ -1,6 +1,6 @@
export function createInlineArray(str: string | string[]): string { export function createInlineArray(str: string | string[]): string {
if (typeof str === "string") { if (typeof str === 'string') {
return str; return str
} }
return str.join(","); return str.join(',')
} }
+13 -13
View File
@@ -1,15 +1,15 @@
import * as io from "@actions/io"; import * as io from '@actions/io'
import { checkDockerPath } from "./dockerUtils"; import {checkDockerPath} from './dockerUtils'
describe("docker utilities", () => { describe('docker utilities', () => {
it("checks if docker is installed", async () => { it('checks if docker is installed', async () => {
// docker installed // docker installed
const path = "path"; const path = 'path'
jest.spyOn(io, "which").mockImplementationOnce(async () => path); jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
expect(() => checkDockerPath()).not.toThrow(); expect(() => checkDockerPath()).not.toThrow()
// docker not installed // docker not installed
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined); jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => checkDockerPath()).rejects.toThrow(); await expect(() => checkDockerPath()).rejects.toThrow()
}); })
}); })
+60 -57
View File
@@ -1,72 +1,75 @@
import * as io from "@actions/io"; import * as io from '@actions/io'
import { DeploymentConfig } from "../types/deploymentConfig"; import {DeploymentConfig} from '../types/deploymentConfig'
import * as core from "@actions/core"; import * as core from '@actions/core'
import { DockerExec } from "../types/docker"; import {DockerExec} from '../types/docker'
import { getNormalizedPath } from "./githubUtils"; import {getNormalizedPath} from './githubUtils'
export async function getDeploymentConfig(): Promise<DeploymentConfig> { export async function getDeploymentConfig(): Promise<DeploymentConfig> {
let helmChartPaths: string[] = let helmChartPaths: string[] =
process.env?.HELM_CHART_PATHS?.split(";").filter((path) => path != "") || process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') ||
[]; []
helmChartPaths = helmChartPaths.map((helmchart) => helmChartPaths = helmChartPaths.map((helmchart) =>
getNormalizedPath(helmchart.trim()) getNormalizedPath(helmchart.trim())
); )
let inputManifestFiles: string[] = let inputManifestFiles: string[] =
core core
.getInput("manifests") .getInput('manifests')
.split(/[\n,;]+/) .split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || []; .filter((manifest) => manifest.trim().length > 0) || []
if (helmChartPaths?.length == 0) { if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) => inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile) getNormalizedPath(manifestFile)
); )
} }
const imageNames = core.getInput("images").split("\n") || []; const imageNames = core.getInput('images').split('\n') || []
const imageDockerfilePathMap: { [id: string]: string } = {}; const imageDockerfilePathMap: {[id: string]: string} = {}
//Fetching from image label if available const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false')
for (const image of imageNames) { if (pullImages) {
try { //Fetching from image label if available
imageDockerfilePathMap[image] = await getDockerfilePath(image); for (const image of imageNames) {
} catch (ex) { try {
core.warning( imageDockerfilePathMap[image] = await getDockerfilePath(image)
`Failed to get dockerfile path for image ${image.toString()}: ${ex} ` } catch (ex) {
); core.warning(
} `Failed to get dockerfile path for image ${image.toString()}: ${ex} `
} )
}
}
}
return Promise.resolve(<DeploymentConfig>{ return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles, manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths, helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap, dockerfilePaths: imageDockerfilePathMap
}); })
} }
async function getDockerfilePath(image: any): Promise<string> { async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath(); await checkDockerPath()
const dockerExec: DockerExec = new DockerExec("docker"); const dockerExec: DockerExec = new DockerExec('docker')
await dockerExec.pull(image, [], false); await dockerExec.pull(image, [], false)
const imageInspectResult: string = await dockerExec.inspect(image, [], false); const imageInspectResult: string = await dockerExec.inspect(image, [], false)
const imageConfig = JSON.parse(imageInspectResult)[0]; const imageConfig = JSON.parse(imageInspectResult)[0]
const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path"; const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path'
let pathValue: string = ""; let pathValue: string = ''
if ( if (
imageConfig?.Config?.Labels && imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY] imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) { ) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY]; const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY]
pathValue = getNormalizedPath(pathLabel); pathValue = getNormalizedPath(pathLabel)
} }
return Promise.resolve(pathValue); return Promise.resolve(pathValue)
} }
export async function checkDockerPath() { export async function checkDockerPath() {
const dockerPath = await io.which("docker", false); const dockerPath = await io.which('docker', false)
if (!dockerPath) { if (!dockerPath) {
throw new Error("Docker is not installed."); throw new Error('Docker is not installed.')
} }
} }
+62
View File
@@ -0,0 +1,62 @@
import {getFilesFromDirectories} from './fileUtils'
import * as path from 'path'
describe('File utils', () => {
it('detects files in nested directories and ignores non-manifest files and empty dirs', () => {
const testPath = path.join('test', 'unit', 'manifests')
const testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = [
'test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml',
'test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml',
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml',
'test/unit/manifests/test-ingress.yml',
'test/unit/manifests/test-service.yml'
]
// is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(5)
expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(fileName)
})
})
it('crashes when an invalid file is provided', () => {
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
const goodPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect(() => {
getFilesFromDirectories([badPath, goodPath])
}).toThrowError()
})
it("doesn't duplicate files when nested dir included", () => {
const outerPath = path.join('test', 'unit', 'manifests')
const fileAtOuter = path.join(
'test',
'unit',
'manifests',
'test-service.yml'
)
const innerPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect(
getFilesFromDirectories([outerPath, fileAtOuter, innerPath])
).toHaveLength(5)
})
})
// files that don't exist / nested files that don't exist / something else with non-manifest
// lots of combinations of pointing to a directory and non yaml/yaml file
// similarly named files in different folders
+99 -46
View File
@@ -1,63 +1,116 @@
import * as fs from "fs"; import * as fs from 'fs'
import * as path from "path"; import * as path from 'path'
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as os from "os"; import * as os from 'os'
import { getCurrentTime } from "./timeUtils"; import {getCurrentTime} from './timeUtils'
export function getTempDirectory(): string { export function getTempDirectory(): string {
return process.env["runner.tempDirectory"] || os.tmpdir(); return process.env['runner.tempDirectory'] || os.tmpdir()
} }
export function writeObjectsToFile(inputObjects: any[]): string[] { export function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = []; const newFilePaths = []
inputObjects.forEach((inputObject: any) => { inputObjects.forEach((inputObject: any) => {
try { try {
const inputObjectString = JSON.stringify(inputObject); const inputObjectString = JSON.stringify(inputObject)
if (inputObject?.metadata?.name) { if (inputObject?.metadata?.name) {
const fileName = getManifestFileName( const fileName = getManifestFileName(
inputObject.kind, inputObject.kind,
inputObject.metadata.name inputObject.metadata.name
); )
fs.writeFileSync(path.join(fileName), inputObjectString); fs.writeFileSync(path.join(fileName), inputObjectString)
newFilePaths.push(fileName); newFilePaths.push(fileName)
} else { } else {
core.debug( core.debug(
"Input object is not proper K8s resource object. Object: " + 'Input object is not proper K8s resource object. Object: ' +
inputObjectString inputObjectString
); )
}
} catch (ex) {
core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}`
)
} }
} catch (ex) { })
core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}`
);
}
});
return newFilePaths; return newFilePaths
} }
export function writeManifestToFile( export function writeManifestToFile(
inputObjectString: string, inputObjectString: string,
kind: string, kind: string,
name: string name: string
): string { ): string {
if (inputObjectString) { if (inputObjectString) {
try { try {
const fileName = getManifestFileName(kind, name); const fileName = getManifestFileName(kind, name)
fs.writeFileSync(path.join(fileName), inputObjectString); fs.writeFileSync(path.join(fileName), inputObjectString)
return fileName; return fileName
} catch (ex) { } catch (ex) {
throw Error( throw Error(
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}` `Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
); )
} }
} }
} }
function getManifestFileName(kind: string, name: string) { function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`; const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`
const tempDirectory = getTempDirectory(); const tempDirectory = getTempDirectory()
return path.join(tempDirectory, path.basename(filePath)); return path.join(tempDirectory, path.basename(filePath))
}
export function getFilesFromDirectories(filePaths: string[]): string[] {
const fullPathSet: Set<string> = new Set<string>()
filePaths.forEach((fileName) => {
try {
if (fs.lstatSync(fileName).isDirectory()) {
recurisveManifestGetter(fileName).forEach((file) => {
fullPathSet.add(file)
})
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
fullPathSet.add(fileName)
} else {
core.debug(
`Detected non-manifest file, ${fileName}, continuing... `
)
}
} catch (ex) {
throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
)
}
})
return Array.from(fullPathSet)
}
function recurisveManifestGetter(dirName: string): string[] {
const toRet: string[] = []
fs.readdirSync(dirName).forEach((fileName) => {
const fnwd: string = path.join(dirName, fileName)
if (fs.lstatSync(fnwd).isDirectory()) {
toRet.push(...recurisveManifestGetter(fnwd))
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
toRet.push(path.join(dirName, fileName))
} else {
core.debug(`Detected non-manifest file, ${fileName}, continuing... `)
}
})
return toRet
}
function getFileExtension(fileName: string) {
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
} }
+40 -40
View File
@@ -1,48 +1,48 @@
import { import {
getNormalizedPath, getNormalizedPath,
isHttpUrl, isHttpUrl,
normalizeWorkflowStrLabel, normalizeWorkflowStrLabel
} from "./githubUtils"; } from './githubUtils'
describe("Github utils", () => { describe('Github utils', () => {
it("normalizes workflow string labels", () => { it('normalizes workflow string labels', () => {
const workflowsPath = ".github/workflows/"; const workflowsPath = '.github/workflows/'
const path = "test/path/test"; const path = 'test/path/test'
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path); expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path)
expect(normalizeWorkflowStrLabel(path)).toBe(path); expect(normalizeWorkflowStrLabel(path)).toBe(path)
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe( expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath path + workflowsPath
); )
expect(normalizeWorkflowStrLabel(path + " " + path)).toBe( expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe(
path + "_" + path path + '_' + path
); )
}); })
it("normalizes path", () => { it('normalizes path', () => {
const httpUrl = "http://www.test.com"; const httpUrl = 'http://www.test.com'
expect(getNormalizedPath(httpUrl)).toBe(httpUrl); expect(getNormalizedPath(httpUrl)).toBe(httpUrl)
const httpsUrl = "https://www.test.com"; const httpsUrl = 'https://www.test.com'
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl); expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl)
const repo = "gh_repo"; const repo = 'gh_repo'
const sha = "gh_sha"; const sha = 'gh_sha'
const path = "path"; const path = 'path'
process.env.GITHUB_REPOSITORY = repo; process.env.GITHUB_REPOSITORY = repo
process.env.GITHUB_SHA = sha; process.env.GITHUB_SHA = sha
expect(getNormalizedPath(path)).toBe( expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}` `https://github.com/${repo}/blob/${sha}/${path}`
); )
}); })
it("checks if url is http", () => { it('checks if url is http', () => {
expect(isHttpUrl("www.test.com")).toBe(false); expect(isHttpUrl('www.test.com')).toBe(false)
expect(isHttpUrl("http.test.com")).toBe(false); expect(isHttpUrl('http.test.com')).toBe(false)
expect(isHttpUrl("http:.test.com")).toBe(false); expect(isHttpUrl('http:.test.com')).toBe(false)
expect(isHttpUrl("http:/.test.com")).toBe(false); expect(isHttpUrl('http:/.test.com')).toBe(false)
expect(isHttpUrl("https://www.test.com")).toBe(true); expect(isHttpUrl('https://www.test.com')).toBe(true)
expect(isHttpUrl("http://wwww.test.com")).toBe(true); expect(isHttpUrl('http://wwww.test.com')).toBe(true)
}); })
}); })
+39 -39
View File
@@ -1,54 +1,54 @@
import { GitHubClient, OkStatusCode } from "../types/githubClient"; import {GitHubClient, OkStatusCode} from '../types/githubClient'
import * as core from "@actions/core"; import * as core from '@actions/core'
export async function getWorkflowFilePath( export async function getWorkflowFilePath(
githubToken: string githubToken: string
): Promise<string> { ): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW; let workflowFilePath = process.env.GITHUB_WORKFLOW
if (!workflowFilePath.startsWith(".github/workflows/")) { if (!workflowFilePath.startsWith('.github/workflows/')) {
const githubClient = new GitHubClient( const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY, process.env.GITHUB_REPOSITORY,
githubToken githubToken
); )
const response = await githubClient.getWorkflows(); const response = await githubClient.getWorkflows()
if (response) { if (response) {
if (response.status === OkStatusCode && response.data.total_count) { if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) { if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) { for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) { if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path; workflowFilePath = workflow.path
break; break
}
}
} }
} } else if (response.status != OkStatusCode) {
} core.error(
} else if (response.status != OkStatusCode) { `An error occurred while getting list of workflows on the repo. Status code: ${response.status}`
core.error( )
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}` }
); } else {
core.error(`Failed to get response from workflow list API`)
} }
} else { }
core.error(`Failed to get response from workflow list API`); return Promise.resolve(workflowFilePath)
}
}
return Promise.resolve(workflowFilePath);
} }
export function normalizeWorkflowStrLabel(workflowName: string): string { export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = ".github/workflows/"; const workflowsPath = '.github/workflows/'
workflowName = workflowName.startsWith(workflowsPath) workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, "") ? workflowName.replace(workflowsPath, '')
: workflowName; : workflowName
return workflowName.replace(/ /g, "_"); return workflowName.replace(/ /g, '_')
} }
export function getNormalizedPath(pathValue: string) { export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) { if (!isHttpUrl(pathValue)) {
//if it is not an http url then convert to link from current repo and commit //if it is not an http url then convert to link from current repo and commit
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`; return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`
} }
return pathValue; return pathValue
} }
export function isHttpUrl(url: string) { export function isHttpUrl(url: string) {
return /^https?:\/\/.*$/.test(url); return /^https?:\/\/.*$/.test(url)
} }
+54 -54
View File
@@ -1,61 +1,61 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import { ExecOutput } from "@actions/exec"; import {ExecOutput} from '@actions/exec'
import { checkForErrors } from "./kubectlUtils"; import {checkForErrors} from './kubectlUtils'
describe("Kubectl utils", () => { describe('Kubectl utils', () => {
it("checks for errors", () => { it('checks for errors', () => {
const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 }; const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0}
const successWithStderr: ExecOutput = { const successWithStderr: ExecOutput = {
stderr: "error", stderr: 'error',
stdout: "", stdout: '',
exitCode: 0, exitCode: 0
}; }
const failWithExitCode: ExecOutput = { const failWithExitCode: ExecOutput = {
stderr: "", stderr: '',
stdout: "", stdout: '',
exitCode: 1, exitCode: 1
}; }
const failWithExitWithStderr: ExecOutput = { const failWithExitWithStderr: ExecOutput = {
stderr: "error", stderr: 'error',
stdout: "", stdout: '',
exitCode: 2, exitCode: 2
}; }
// with throw behavior // with throw behavior
expect(() => checkForErrors([success])).not.toThrow(); expect(() => checkForErrors([success])).not.toThrow()
expect(() => checkForErrors([successWithStderr])).not.toThrow(); expect(() => checkForErrors([successWithStderr])).not.toThrow()
expect(() => checkForErrors([success, successWithStderr])).not.toThrow(); expect(() => checkForErrors([success, successWithStderr])).not.toThrow()
expect(() => checkForErrors([failWithExitCode])).toThrow(); expect(() => checkForErrors([failWithExitCode])).toThrow()
expect(() => checkForErrors([failWithExitWithStderr])).toThrow(); expect(() => checkForErrors([failWithExitWithStderr])).toThrow()
expect(() => checkForErrors([success, failWithExitCode])).toThrow(); expect(() => checkForErrors([success, failWithExitCode])).toThrow()
expect(() => expect(() =>
checkForErrors([successWithStderr, failWithExitCode]) checkForErrors([successWithStderr, failWithExitCode])
).toThrow(); ).toThrow()
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode]) checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow(); ).toThrow()
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr]) checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow(); ).toThrow()
// with warn behavior // with warn behavior
jest.spyOn(core, "warning").mockImplementation(() => {}); jest.spyOn(core, 'warning').mockImplementation(() => {})
let warningCalls = 0; let warningCalls = 0
expect(() => checkForErrors([success], true)).not.toThrow(); expect(() => checkForErrors([success], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(warningCalls); expect(core.warning).toBeCalledTimes(warningCalls)
expect(() => checkForErrors([successWithStderr], true)).not.toThrow(); expect(() => checkForErrors([successWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls); expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => expect(() =>
checkForErrors([success, successWithStderr], true) checkForErrors([success, successWithStderr], true)
).not.toThrow(); ).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls); expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow(); expect(() => checkForErrors([failWithExitCode], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls); expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow(); expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls); expect(core.warning).toBeCalledTimes(++warningCalls)
}); })
}); })
+70 -66
View File
@@ -1,82 +1,86 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import { ExecOutput } from "@actions/exec"; import {ExecOutput} from '@actions/exec'
import { Kubectl } from "../types/kubectl"; import {Kubectl} from '../types/kubectl'
export function checkForErrors( export function checkForErrors(
execResults: ExecOutput[], execResults: ExecOutput[],
warnIfError?: boolean warnIfError?: boolean
) { ) {
let stderr = ""; let stderr = ''
execResults.forEach((result) => { execResults.forEach((result) => {
if (result?.exitCode !== 0) { if (result?.exitCode !== 0) {
stderr += result?.stderr + " \n"; stderr += result?.stderr + ' \n'
} else if (result?.stderr) { } else if (result?.stderr) {
core.warning(result.stderr); core.warning(result.stderr)
} }
}); })
if (stderr.length > 0) { if (stderr.length > 0) {
if (warnIfError) { if (warnIfError) {
core.warning(stderr.trim()); core.warning(stderr.trim())
} else { } else {
throw new Error(stderr.trim()); throw new Error(stderr.trim())
} }
} }
} }
export async function getLastSuccessfulRunSha( export async function getLastSuccessfulRunSha(
kubectl: Kubectl, kubectl: Kubectl,
namespaceName: string, namespaceName: string,
annotationKey: string annotationKey: string
): Promise<string> { ): Promise<string> {
try { try {
const result = await kubectl.getResource("namespace", namespaceName); const result = await kubectl.getResource('namespace', namespaceName)
if (result?.stderr) { if (result?.stderr) {
core.warning(result.stderr); core.warning(result.stderr)
return process.env.GITHUB_SHA; return process.env.GITHUB_SHA
} else if (result?.stdout) { } else if (result?.stdout) {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations; const annotationsSet = JSON.parse(result.stdout).metadata.annotations
if (annotationsSet && annotationsSet[annotationKey]) { if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"')) return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit; .commit
} else { } else {
return "NA"; return 'NA'
}
} }
} } catch (ex) {
} catch (ex) { core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`)
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`); return ''
return ""; }
}
} }
export async function annotateChildPods( export async function annotateChildPods(
kubectl: Kubectl, kubectl: Kubectl,
resourceType: string, resourceType: string,
resourceName: string, resourceName: string,
annotationKeyValStr: string, annotationKeyValStr: string,
allPods allPods
): Promise<ExecOutput[]> { ): Promise<ExecOutput[]> {
let owner = resourceName; let owner = resourceName
if (resourceType.toLowerCase().indexOf("deployment") > -1) { if (resourceType.toLowerCase().indexOf('deployment') > -1) {
owner = await kubectl.getNewReplicaSet(resourceName); owner = await kubectl.getNewReplicaSet(resourceName)
} }
const commandExecutionResults = []; const commandExecutionResults = []
if (allPods?.items && allPods.items?.length > 0) { if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => { allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences; const owners = pod?.metadata?.ownerReferences
if (owners) { if (owners) {
for (const ownerRef of owners) { for (const ownerRef of owners) {
if (ownerRef.name === owner) { if (ownerRef.name === owner) {
commandExecutionResults.push( commandExecutionResults.push(
kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr) kubectl.annotate(
); 'pod',
break; pod.metadata.name,
} annotationKeyValStr
} )
} )
}); break
} }
}
}
})
}
return await Promise.all(commandExecutionResults); return await Promise.all(commandExecutionResults)
} }
+35 -31
View File
@@ -1,44 +1,48 @@
import { KubernetesWorkload } from "../types/kubernetesTypes"; import {KubernetesWorkload} from '../types/kubernetesTypes'
export function getImagePullSecrets(inputObject: any) { export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null; if (!inputObject?.spec) return null
if ( if (
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase() inputObject.kind.toLowerCase() ===
) KubernetesWorkload.CRON_JOB.toLowerCase()
return inputObject?.spec?.jobTemplate?.spec?.template?.spec )
?.imagePullSecrets; return inputObject?.spec?.jobTemplate?.spec?.template?.spec
?.imagePullSecrets
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets; return inputObject.spec.imagePullSecrets
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets; return inputObject.spec.template.spec.imagePullSecrets
} }
} }
export function setImagePullSecrets( export function setImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: any newImagePullSecrets: any
) { ) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return; if (!inputObject || !inputObject.spec || !newImagePullSecrets) return
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) { if (
inputObject.spec.imagePullSecrets = newImagePullSecrets; inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
return; ) {
} inputObject.spec.imagePullSecrets = newImagePullSecrets
return
}
if ( if (
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase() inputObject.kind.toLowerCase() ===
) { KubernetesWorkload.CRON_JOB.toLowerCase()
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec) ) {
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
newImagePullSecrets; inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
return; newImagePullSecrets
} return
}
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets; inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets
return; return
} }
} }
+47 -45
View File
@@ -1,71 +1,73 @@
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError, NullInputObjectError
} from "../types/kubernetesTypes"; } from '../types/kubernetesTypes'
export function updateSpecLabels( export function updateSpecLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError; if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) throw InputObjectKindNotDefinedError; if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (!newLabels) return; if (!newLabels) return
let existingLabels = getSpecLabels(inputObject); let existingLabels = getSpecLabels(inputObject)
if (override) { if (override) {
existingLabels = newLabels; existingLabels = newLabels
} else { } else {
existingLabels = existingLabels || new Map<string, string>(); existingLabels = existingLabels || new Map<string, string>()
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
); )
} }
setSpecLabels(inputObject, existingLabels); setSpecLabels(inputObject, existingLabels)
} }
function getSpecLabels(inputObject: any) { function getSpecLabels(inputObject: any) {
if (!inputObject) return null; if (!inputObject) return null
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels; return inputObject.metadata.labels
if (inputObject?.spec?.template?.metadata) if (inputObject?.spec?.template?.metadata)
return inputObject.spec.template.metadata.labels; return inputObject.spec.template.metadata.labels
return null; return null
} }
function setSpecLabels(inputObject: any, newLabels: any) { function setSpecLabels(inputObject: any, newLabels: any) {
if (!inputObject || !newLabels) return null; if (!inputObject || !newLabels) return null
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) { if (
inputObject.metadata.labels = newLabels; inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
return; ) {
} inputObject.metadata.labels = newLabels
return
}
if (inputObject?.spec?.template?.metatada) { if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels; inputObject.spec.template.metatada.labels = newLabels
return; return
} }
} }
export function getSpecSelectorLabels(inputObject: any) { export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector; if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector
else return inputObject.spec.selector.matchLabels; else return inputObject.spec.selector.matchLabels
} }
} }
export function setSpecSelectorLabels(inputObject: any, newLabels: any) { export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels; inputObject.spec.selector = newLabels
else inputObject.spec.selector.matchLabels = newLabels; else inputObject.spec.selector.matchLabels = newLabels
} }
} }
+147 -142
View File
@@ -1,184 +1,189 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as KubernetesConstants from "../types/kubernetesTypes"; import * as KubernetesConstants from '../types/kubernetesTypes'
import { Kubectl, Resource } from "../types/kubectl"; import {Kubectl, Resource} from '../types/kubectl'
import { checkForErrors } from "./kubectlUtils"; import {checkForErrors} from './kubectlUtils'
import { sleep } from "./timeUtils"; import {sleep} from './timeUtils'
export async function checkManifestStability( export async function checkManifestStability(
kubectl: Kubectl, kubectl: Kubectl,
resources: Resource[] resources: Resource[]
): Promise<void> { ): Promise<void> {
let rolloutStatusHasErrors = false; let rolloutStatusHasErrors = false
for (let i = 0; i < resources.length; i++) { for (let i = 0; i < resources.length; i++) {
const resource = resources[i]; const resource = resources[i]
if ( if (
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf( KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
resource.type.toLowerCase() resource.type.toLowerCase()
) >= 0 ) >= 0
) { ) {
try { try {
const result = await kubectl.checkRolloutStatus( const result = await kubectl.checkRolloutStatus(
resource.type, resource.type,
resource.name resource.name
); )
checkForErrors([result]); checkForErrors([result])
} catch (ex) { } catch (ex) {
core.error(ex); core.error(ex)
await kubectl.describe(resource.type, resource.name); await kubectl.describe(resource.type, resource.name)
rolloutStatusHasErrors = true; rolloutStatusHasErrors = true
}
} }
}
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) { if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
try { try {
await checkPodStatus(kubectl, resource.name); await checkPodStatus(kubectl, resource.name)
} catch (ex) { } catch (ex) {
core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`); core.warning(
await kubectl.describe(resource.type, resource.name); `Could not determine pod status: ${JSON.stringify(ex)}`
)
await kubectl.describe(resource.type, resource.name)
}
} }
} if (
if ( resource.type ==
resource.type == KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE ) {
) { try {
try { const service = await getService(kubectl, resource.name)
const service = await getService(kubectl, resource.name); const {spec, status} = service
const { spec, status } = service; if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) { if (!isLoadBalancerIPAssigned(status)) {
if (!isLoadBalancerIPAssigned(status)) { await waitForServiceExternalIPAssignment(
await waitForServiceExternalIPAssignment(kubectl, resource.name); kubectl,
} else { resource.name
core.info( )
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}` } else {
); core.info(
} `ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
} )
} catch (ex) { }
core.warning( }
`Could not determine service status of: ${resource.name} Error: ${ex}` } catch (ex) {
); core.warning(
await kubectl.describe(resource.type, resource.name); `Could not determine service status of: ${resource.name} Error: ${ex}`
)
await kubectl.describe(resource.type, resource.name)
}
} }
} }
}
if (rolloutStatusHasErrors) { if (rolloutStatusHasErrors) {
throw new Error("Rollout status error"); throw new Error('Rollout status error')
} }
} }
export async function checkPodStatus( export async function checkPodStatus(
kubectl: Kubectl, kubectl: Kubectl,
podName: string podName: string
): Promise<void> { ): Promise<void> {
const sleepTimeout = 10 * 1000; // 10 seconds const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout
let podStatus; let podStatus
let kubectlDescribeNeeded = false; let kubectlDescribeNeeded = false
for (let i = 0; i < iterations; i++) { for (let i = 0; i < iterations; i++) {
await sleep(sleepTimeout); await sleep(sleepTimeout)
core.debug(`Polling for pod status: ${podName}`); core.debug(`Polling for pod status: ${podName}`)
podStatus = await getPodStatus(kubectl, podName); podStatus = await getPodStatus(kubectl, podName)
if ( if (
podStatus && podStatus &&
podStatus?.phase !== "Pending" && podStatus?.phase !== 'Pending' &&
podStatus?.phase !== "Unknown" podStatus?.phase !== 'Unknown'
) { ) {
break; break
}
}
podStatus = await getPodStatus(kubectl, podName);
switch (podStatus.phase) {
case "Succeeded":
case "Running":
if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`);
} else {
kubectlDescribeNeeded = true;
} }
break; }
case "Pending":
if (!isPodReady(podStatus)) {
core.warning(`pod/${podName} rollout status check timed out`);
kubectlDescribeNeeded = true;
}
break;
case "Failed":
core.error(`pod/${podName} rollout failed`);
kubectlDescribeNeeded = true;
break;
default:
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
}
if (kubectlDescribeNeeded) { podStatus = await getPodStatus(kubectl, podName)
await kubectl.describe("pod", podName); switch (podStatus.phase) {
} case 'Succeeded':
case 'Running':
if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`)
} else {
kubectlDescribeNeeded = true
}
break
case 'Pending':
if (!isPodReady(podStatus)) {
core.warning(`pod/${podName} rollout status check timed out`)
kubectlDescribeNeeded = true
}
break
case 'Failed':
core.error(`pod/${podName} rollout failed`)
kubectlDescribeNeeded = true
break
default:
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`)
}
if (kubectlDescribeNeeded) {
await kubectl.describe('pod', podName)
}
} }
async function getPodStatus(kubectl: Kubectl, podName: string) { async function getPodStatus(kubectl: Kubectl, podName: string) {
const podResult = await kubectl.getResource("pod", podName); const podResult = await kubectl.getResource('pod', podName)
checkForErrors([podResult]); checkForErrors([podResult])
return JSON.parse(podResult.stdout).status; return JSON.parse(podResult.stdout).status
} }
function isPodReady(podStatus: any): boolean { function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true; let allContainersAreReady = true
podStatus.containerStatuses.forEach((container) => { podStatus.containerStatuses.forEach((container) => {
if (container.ready === false) { if (container.ready === false) {
core.info( core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}` `'${container.name}' status: ${JSON.stringify(container.state)}`
); )
allContainersAreReady = false; allContainersAreReady = false
} }
}); })
if (!allContainersAreReady) { if (!allContainersAreReady) {
core.warning("All containers not in ready state"); core.warning('All containers not in ready state')
} }
return allContainersAreReady; return allContainersAreReady
} }
async function getService(kubectl: Kubectl, serviceName) { async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource( const serviceResult = await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE, KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
serviceName serviceName
); )
checkForErrors([serviceResult]); checkForErrors([serviceResult])
return JSON.parse(serviceResult.stdout); return JSON.parse(serviceResult.stdout)
} }
async function waitForServiceExternalIPAssignment( async function waitForServiceExternalIPAssignment(
kubectl: Kubectl, kubectl: Kubectl,
serviceName: string serviceName: string
): Promise<void> { ): Promise<void> {
const sleepTimeout = 10 * 1000; // 10 seconds const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
for (let i = 0; i < iterations; i++) { for (let i = 0; i < iterations; i++) {
core.info(`Wait for service ip assignment : ${serviceName}`); core.info(`Wait for service ip assignment : ${serviceName}`)
await sleep(sleepTimeout); await sleep(sleepTimeout)
const status = (await getService(kubectl, serviceName)).status; const status = (await getService(kubectl, serviceName)).status
if (isLoadBalancerIPAssigned(status)) { if (isLoadBalancerIPAssigned(status)) {
core.info( core.info(
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}` `ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
); )
return; return
} }
} }
core.warning(`Wait for service ip assignment timed out${serviceName}`); core.warning(`Wait for service ip assignment timed out${serviceName}`)
} }
function isLoadBalancerIPAssigned(status: any) { function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0; return status?.loadBalancer?.ingress?.length > 0
} }
+217 -214
View File
@@ -1,103 +1,103 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
import * as fs from "fs"; import * as fs from 'fs'
import * as yaml from "js-yaml"; import * as yaml from 'js-yaml'
import * as path from "path"; import * as path from 'path'
import * as fileHelper from "./fileUtils"; import * as fileHelper from './fileUtils'
import { getTempDirectory } from "./fileUtils"; import {getTempDirectory} from './fileUtils'
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError, InputObjectMetadataNotDefinedError,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError, NullInputObjectError
} from "../types/kubernetesTypes"; } from '../types/kubernetesTypes'
import { import {
getSpecSelectorLabels, getSpecSelectorLabels,
setSpecSelectorLabels, setSpecSelectorLabels
} from "./manifestSpecLabelUtils"; } from './manifestSpecLabelUtils'
import { import {
getImagePullSecrets, getImagePullSecrets,
setImagePullSecrets, setImagePullSecrets
} from "./manifestPullSecretUtils"; } from './manifestPullSecretUtils'
import { Resource } from "../types/kubectl"; import {Resource} from '../types/kubectl'
export function updateManifestFiles(manifestFilePaths: string[]) { export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) { if (manifestFilePaths?.length === 0) {
throw new Error("Manifest files not provided"); throw new Error('Manifest files not provided')
} }
// update container images // update container images
const containers: string[] = core.getInput("images").split("\n"); const containers: string[] = core.getInput('images').split('\n')
const manifestFiles = updateContainerImagesInManifestFiles( const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths, manifestFilePaths,
containers containers
); )
// update pull secrets // update pull secrets
const imagePullSecrets: string[] = core const imagePullSecrets: string[] = core
.getInput("imagepullsecrets") .getInput('imagepullsecrets')
.split("\n") .split('\n')
.filter((secret) => secret.trim().length > 0); .filter((secret) => secret.trim().length > 0)
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets); return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets)
} }
export function UnsetClusterSpecificDetails(resource: any) { export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) { if (!resource) {
return; return
} }
// Unset cluster specific details in the object // Unset cluster specific details in the object
if (!!resource) { if (!!resource) {
const { metadata, status } = resource; const {metadata, status} = resource
if (!!metadata) { if (!!metadata) {
resource.metadata = { resource.metadata = {
annotations: metadata.annotations, annotations: metadata.annotations,
labels: metadata.labels, labels: metadata.labels,
name: metadata.name, name: metadata.name
}; }
} }
if (!!status) { if (!!status) {
resource.status = {}; resource.status = {}
} }
} }
} }
function updateContainerImagesInManifestFiles( function updateContainerImagesInManifestFiles(
filePaths: string[], filePaths: string[],
containers: string[] containers: string[]
): string[] { ): string[] {
if (filePaths?.length <= 0) return filePaths; if (filePaths?.length <= 0) return filePaths
const newFilePaths = []; const newFilePaths = []
// update container images // update container images
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString(); let contents = fs.readFileSync(filePath).toString()
containers.forEach((container: string) => { containers.forEach((container: string) => {
let [imageName] = container.split(":"); let [imageName] = container.split(':')
if (imageName.indexOf("@") > 0) { if (imageName.indexOf('@') > 0) {
imageName = imageName.split("@")[0]; imageName = imageName.split('@')[0]
} }
if (contents.indexOf(imageName) > 0) if (contents.indexOf(imageName) > 0)
contents = substituteImageNameInSpecFile( contents = substituteImageNameInSpecFile(
contents, contents,
imageName, imageName,
container container
); )
}); })
// write updated files // write updated files
const tempDirectory = getTempDirectory(); const tempDirectory = getTempDirectory()
const fileName = path.join(tempDirectory, path.basename(filePath)); const fileName = path.join(tempDirectory, path.basename(filePath))
fs.writeFileSync(path.join(fileName), contents); fs.writeFileSync(path.join(fileName), contents)
newFilePaths.push(fileName); newFilePaths.push(fileName)
}); })
return newFilePaths; return newFilePaths
} }
/* /*
@@ -112,199 +112,202 @@ function updateContainerImagesInManifestFiles(
`image: "example/example-image:identifiertag"` `image: "example/example-image:identifiertag"`
*/ */
export function substituteImageNameInSpecFile( export function substituteImageNameInSpecFile(
spec: string, spec: string,
imageName: string, imageName: string,
imageNameWithNewTag: string imageNameWithNewTag: string
) { ) {
if (spec.indexOf(imageName) < 0) return spec; if (spec.indexOf(imageName) < 0) return spec
return spec.split("\n").reduce((acc, line) => { return spec.split('\n').reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/); const imageKeyword = line.match(/^ *-? *image:/)
if (imageKeyword) { if (imageKeyword) {
let [currentImageName] = line let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards .substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim() .trim()
.replace(/[',"]/g, "") // replace allowed quotes with nothing .replace(/[',"]/g, '') // replace allowed quotes with nothing
.split(":"); .split(':')
if (currentImageName?.indexOf(" ") > 0) { if (currentImageName?.indexOf(' ') > 0) {
currentImageName = currentImageName.split(" ")[0]; // remove comments currentImageName = currentImageName.split(' ')[0] // remove comments
}
if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`
}
} }
if (currentImageName === imageName) { return acc + line + '\n'
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`; }, '')
}
}
return acc + line + "\n";
}, "");
} }
export function getReplicaCount(inputObject: any): any { export function getReplicaCount(inputObject: any): any {
if (!inputObject) throw NullInputObjectError; if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) { if (!inputObject.kind) {
throw InputObjectKindNotDefinedError; throw InputObjectKindNotDefinedError
} }
const { kind } = inputObject; const {kind} = inputObject
if ( if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
) )
return inputObject.spec.replicas; return inputObject.spec.replicas
return 0; return 0
} }
export function updateObjectLabels( export function updateObjectLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean = false override: boolean = false
) { ) {
if (!inputObject) throw NullInputObjectError; if (!inputObject) throw NullInputObjectError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError; if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!newLabels) return; if (!newLabels) return
if (override) { if (override) {
inputObject.metadata.labels = newLabels; inputObject.metadata.labels = newLabels
} else { } else {
let existingLabels = let existingLabels =
inputObject.metadata.labels || new Map<string, string>(); inputObject.metadata.labels || new Map<string, string>()
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
); )
inputObject.metadata.labels = existingLabels; inputObject.metadata.labels = existingLabels
} }
} }
export function updateObjectAnnotations( export function updateObjectAnnotations(
inputObject: any, inputObject: any,
newAnnotations: Map<string, string>, newAnnotations: Map<string, string>,
override: boolean = false override: boolean = false
) { ) {
if (!inputObject) throw NullInputObjectError; if (!inputObject) throw NullInputObjectError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError; if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!newAnnotations) return; if (!newAnnotations) return
if (override) { if (override) {
inputObject.metadata.annotations = newAnnotations; inputObject.metadata.annotations = newAnnotations
} else { } else {
const existingAnnotations = const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>(); inputObject.metadata.annotations || new Map<string, string>()
Object.keys(newAnnotations).forEach( Object.keys(newAnnotations).forEach(
(key) => (existingAnnotations[key] = newAnnotations[key]) (key) => (existingAnnotations[key] = newAnnotations[key])
); )
inputObject.metadata.annotations = existingAnnotations; inputObject.metadata.annotations = existingAnnotations
} }
} }
export function updateImagePullSecrets( export function updateImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: string[], newImagePullSecrets: string[],
override: boolean = false override: boolean = false
) { ) {
if (!inputObject?.spec || !newImagePullSecrets) return; if (!inputObject?.spec || !newImagePullSecrets) return
const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => { const newImagePullSecretsObjects = Array.from(
return { name }; newImagePullSecrets,
}); (name) => {
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject); return {name}
}
)
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
if (override) { if (override) {
existingImagePullSecretObjects = newImagePullSecretsObjects; existingImagePullSecretObjects = newImagePullSecretsObjects
} else { } else {
existingImagePullSecretObjects = existingImagePullSecretObjects || []; existingImagePullSecretObjects = existingImagePullSecretObjects || []
existingImagePullSecretObjects = existingImagePullSecretObjects.concat( existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
newImagePullSecretsObjects newImagePullSecretsObjects
); )
} }
setImagePullSecrets(inputObject, existingImagePullSecretObjects); setImagePullSecrets(inputObject, existingImagePullSecretObjects)
} }
export function updateSelectorLabels( export function updateSelectorLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError; if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) throw InputObjectKindNotDefinedError; if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (!newLabels) return; if (!newLabels) return
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return; return
let existingLabels = getSpecSelectorLabels(inputObject); let existingLabels = getSpecSelectorLabels(inputObject)
if (override) { if (override) {
existingLabels = newLabels; existingLabels = newLabels
} else { } else {
existingLabels = existingLabels || new Map<string, string>(); existingLabels = existingLabels || new Map<string, string>()
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
); )
} }
setSpecSelectorLabels(inputObject, existingLabels); setSpecSelectorLabels(inputObject, existingLabels)
} }
export function getResources( export function getResources(
filePaths: string[], filePaths: string[],
filterResourceTypes: string[] filterResourceTypes: string[]
): Resource[] { ): Resource[] {
if (!filePaths) return []; if (!filePaths) return []
const resources: Resource[] = []; const resources: Resource[] = []
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
const inputObjectKind = inputObject?.kind || ""; const inputObjectKind = inputObject?.kind || ''
if ( if (
filterResourceTypes.filter( filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase() (type) => inputObjectKind.toLowerCase() === type.toLowerCase()
).length > 0 ).length > 0
) { ) {
resources.push({ resources.push({
type: inputObject.kind, type: inputObject.kind,
name: inputObject.metadata.name, name: inputObject.metadata.name
}); })
} }
}); })
}); })
return resources; return resources
} }
function updateImagePullSecretsInManifestFiles( function updateImagePullSecretsInManifestFiles(
filePaths: string[], filePaths: string[],
imagePullSecrets: string[] imagePullSecrets: string[]
): string[] { ): string[] {
if (imagePullSecrets?.length <= 0) return filePaths; if (imagePullSecrets?.length <= 0) return filePaths
const newObjectsList = []; const newObjectsList = []
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString(); const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject: any) => { yaml.safeLoadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) { if (inputObject?.kind) {
const { kind } = inputObject; const {kind} = inputObject
if (isWorkloadEntity(kind)) { if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets); updateImagePullSecrets(inputObject, imagePullSecrets)
} }
newObjectsList.push(inputObject); newObjectsList.push(inputObject)
} }
}); })
}); })
return fileHelper.writeObjectsToFile(newObjectsList); return fileHelper.writeObjectsToFile(newObjectsList)
} }
+2 -2
View File
@@ -1,7 +1,7 @@
export function sleep(timeout: number) { export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout)); return new Promise((resolve) => setTimeout(resolve, timeout))
} }
export function getCurrentTime(): number { export function getCurrentTime(): number {
return new Date().getTime(); return new Date().getTime()
} }
+11 -11
View File
@@ -1,18 +1,18 @@
import { Kubectl } from "../types/kubectl"; import {Kubectl} from '../types/kubectl'
const trafficSplitAPIVersionPrefix = "split.smi-spec.io"; const trafficSplitAPIVersionPrefix = 'split.smi-spec.io'
export async function getTrafficSplitAPIVersion( export async function getTrafficSplitAPIVersion(
kubectl: Kubectl kubectl: Kubectl
): Promise<string> { ): Promise<string> {
const result = await kubectl.executeCommand("api-versions"); const result = await kubectl.executeCommand('api-versions')
const trafficSplitAPIVersion = result.stdout const trafficSplitAPIVersion = result.stdout
.split("\n") .split('\n')
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix)); .find((version) => version.startsWith(trafficSplitAPIVersionPrefix))
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
throw new Error("Unable to find traffic split api version"); throw new Error('Unable to find traffic split api version')
} }
return trafficSplitAPIVersion; return trafficSplitAPIVersion
} }
@@ -0,0 +1,33 @@
import {
cleanLabel,
prefixObjectKeys
} from '../utilities/workflowAnnotationUtils'
describe('WorkflowAnnotationUtils', () => {
describe('prefixObjectKeys', () => {
it('should prefix an object with a given prefix', () => {
const obj = {
foo: 'bar',
baz: 'qux'
}
const prefix = 'prefix.'
const expected = {
'prefix.foo': 'bar',
'prefix.baz': 'qux'
}
expect(prefixObjectKeys(obj, prefix)).toEqual(expected)
})
})
describe('cleanLabel', () => {
it('should clean label', () => {
const alreadyClean = 'alreadyClean'
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
'withS0MEinvalidchars'
)
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
})
})
})
+52 -28
View File
@@ -1,36 +1,60 @@
import { DeploymentConfig } from "../types/deploymentConfig"; import {DeploymentConfig} from '../types/deploymentConfig'
const ANNOTATION_PREFIX = 'actions.github.com/'
export function prefixObjectKeys(obj: any, prefix: string): any {
return Object.keys(obj).reduce((newObj, key) => {
newObj[prefix + key] = obj[key]
return newObj
}, {})
}
export function getWorkflowAnnotations( export function getWorkflowAnnotations(
lastSuccessRunSha: string, lastSuccessRunSha: string,
workflowFilePath: string, workflowFilePath: string,
deploymentConfig: DeploymentConfig deploymentConfig: DeploymentConfig
): string { ): string {
const annotationObject = { const annotationObject = {
run: process.env.GITHUB_RUN_ID, run: process.env.GITHUB_RUN_ID,
repository: process.env.GITHUB_REPOSITORY, repository: process.env.GITHUB_REPOSITORY,
workflow: process.env.GITHUB_WORKFLOW, workflow: process.env.GITHUB_WORKFLOW,
workflowFileName: workflowFilePath.replace(".github/workflows/", ""), workflowFileName: workflowFilePath.replace('.github/workflows/', ''),
jobName: process.env.GITHUB_JOB, jobName: process.env.GITHUB_JOB,
createdBy: process.env.GITHUB_ACTOR, createdBy: process.env.GITHUB_ACTOR,
runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`, runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`,
commit: process.env.GITHUB_SHA, commit: process.env.GITHUB_SHA,
lastSuccessRunCommit: lastSuccessRunSha, lastSuccessRunCommit: lastSuccessRunSha,
branch: process.env.GITHUB_REF, branch: process.env.GITHUB_REF,
deployTimestamp: Date.now(), deployTimestamp: Date.now(),
dockerfilePaths: deploymentConfig.dockerfilePaths, dockerfilePaths: deploymentConfig.dockerfilePaths,
manifestsPaths: deploymentConfig.manifestFilePaths, manifestsPaths: deploymentConfig.manifestFilePaths,
helmChartPaths: deploymentConfig.helmChartFilePaths, helmChartPaths: deploymentConfig.helmChartFilePaths,
provider: "GitHub", provider: 'GitHub'
}; }
return JSON.stringify(annotationObject); const prefixedAnnotationObject = prefixObjectKeys(
annotationObject,
ANNOTATION_PREFIX
)
return JSON.stringify(prefixedAnnotationObject)
} }
export function getWorkflowAnnotationKeyLabel( export function getWorkflowAnnotationKeyLabel(
workflowFilePath: string workflowFilePath: string
): string { ): string {
const hashKey = require("crypto") const hashKey = require('crypto')
.createHash("MD5") .createHash('MD5')
.update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`) .update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`)
.digest("hex"); .digest('hex')
return `githubWorkflow_${hashKey}`; return `githubWorkflow_${hashKey}`
}
/**
* Cleans label to match valid kubernetes label specification by removing invalid characters
* @param label
* @returns cleaned label
*/
export function cleanLabel(label: string): string {
const removedInvalidChars = label.replace(/[^-A-Za-z0-9_.]/gi, '')
const regex = /([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]/
return regex.exec(removedInvalidChars)[0] || ''
} }
+38 -38
View File
@@ -1,52 +1,52 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx app: nginx
template: spec:
metadata: replicas: 1
labels: selector:
app: nginx matchLabels:
spec: app: nginx
containers: template:
- name: nginx metadata:
image: nginx:1.14.2 labels:
ports: app: nginx
- containerPort: 80 spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
--- ---
apiVersion: networking.k8s.io/v1beta1 apiVersion: networking.k8s.io/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: nginx-ingress name: nginx-ingress
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /
spec: spec:
rules: rules:
- http: - http:
paths: paths:
- path: /testpath - path: /testpath
backend: backend:
serviceName: nginx-service serviceName: nginx-service
servicePort: 80 servicePort: 80
- path: /testpath2 - path: /testpath2
backend: backend:
serviceName: unrouted-service serviceName: unrouted-service
servicePort: 80 servicePort: 80
+24 -24
View File
@@ -1,33 +1,33 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx app: nginx
template: spec:
metadata: replicas: 1
labels: selector:
app: nginx matchLabels:
spec: app: nginx
containers: template:
- name: nginx metadata:
image: nginx:1.14.2 labels:
ports: app: nginx
- containerPort: 80 spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
@@ -1,21 +1,21 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx app: nginx
template: spec:
metadata: replicas: 1
labels: selector:
app: nginx matchLabels:
spec: app: nginx
containers: template:
- name: nginx metadata:
image: nginx:1.14.2 labels:
ports: app: nginx
- containerPort: 80 spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
@@ -1,18 +1,18 @@
apiVersion: networking.k8s.io/v1beta1 apiVersion: networking.k8s.io/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: nginx-ingress name: nginx-ingress
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /
spec: spec:
rules: rules:
- http: - http:
paths: paths:
- path: /testpath - path: /testpath
backend: backend:
serviceName: nginx-service serviceName: nginx-service
servicePort: 80 servicePort: 80
- path: /testpath2 - path: /testpath2
backend: backend:
serviceName: unrouted-service serviceName: unrouted-service
servicePort: 80 servicePort: 80
@@ -1,11 +1,11 @@
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
+46 -42
View File
@@ -5,59 +5,63 @@
replicaCount: 1 replicaCount: 1
image: image:
repository: nginx repository: nginx
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
imagePullSecrets: [] imagePullSecrets: []
nameOverride: "" nameOverride: ''
fullnameOverride: "" fullnameOverride: ''
serviceAccount: serviceAccount:
# Specifies whether a service account should be created # Specifies whether a service account should be created
create: true create: true
# The name of the service account to use. # The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template # If not set and create is true, a name is generated using the fullname template
name: name:
podSecurityContext: {} podSecurityContext:
# fsGroup: 2000 {}
# fsGroup: 2000
securityContext: {} securityContext:
# capabilities: {}
# drop: # capabilities:
# - ALL # drop:
# readOnlyRootFilesystem: true # - ALL
# runAsNonRoot: true # readOnlyRootFilesystem: true
# runAsUser: 1000 # runAsNonRoot: true
# runAsUser: 1000
service: service:
type: ClusterIP type: ClusterIP
port: 80 port: 80
ingress: ingress:
enabled: false enabled: false
annotations: {} annotations:
# kubernetes.io/ingress.class: nginx {}
# kubernetes.io/tls-acme: "true" # kubernetes.io/ingress.class: nginx
hosts: # kubernetes.io/tls-acme: "true"
- host: chart-example.local hosts:
paths: [] - host: chart-example.local
tls: [] paths: []
# - secretName: chart-example-tls tls: []
# hosts: # - secretName: chart-example-tls
# - chart-example.local # hosts:
# - chart-example.local
resources: {} resources:
# We usually recommend not to specify default resources and to leave this as a conscious {}
# choice for the user. This also increases chances charts run on environments with little # We usually recommend not to specify default resources and to leave this as a conscious
# resources, such as Minikube. If you do want to specify resources, uncomment the following # choice for the user. This also increases chances charts run on environments with little
# lines, adjust them as necessary, and remove the curly braces after 'resources:'. # resources, such as Minikube. If you do want to specify resources, uncomment the following
# limits: # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
# cpu: 100m # limits:
# memory: 128Mi # cpu: 100m
# requests: # memory: 128Mi
# cpu: 100m # requests:
# memory: 128Mi # cpu: 100m
# memory: 128Mi
nodeSelector: {} nodeSelector: {}
@@ -0,0 +1 @@
weaker than the average human?
+52
View File
@@ -0,0 +1,52 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: nginx-ingress
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- http:
paths:
- path: /testpath
backend:
serviceName: nginx-service
servicePort: 80
- path: /testpath2
backend:
serviceName: unrouted-service
servicePort: 80
+33
View File
@@ -0,0 +1,33 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
+5 -5
View File
@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES6", "target": "ES6",
"module": "commonjs" "module": "commonjs"
}, },
"exclude": ["node_modules", "test", "src/**/*.test.ts"] "exclude": ["node_modules", "test", "src/**/*.test.ts"]
} }