Compare commits

...

21 Commits

Author SHA1 Message Date
asgayle 0b282a825d Added support message 2022-10-17 11:15:16 -04:00
Jaiveer Katariya d64c205796 Resolved issue with Canary deploy (#247) 2022-10-14 12:25:27 -04:00
Kenta Nakase c8f050230d Fix description about baseline-and-canary-replicas (#241) 2022-09-28 14:21:08 -04:00
Kenta Nakase a0b037b13e Fix issue form (#238) 2022-09-15 11:23:38 -04:00
Vidya Reddy 7fd0e52a8b Add the bug report and feature request form (#237)
* Added the bug report and feature request form

* updated the url
2022-09-06 13:10:29 -04:00
Oliver King 659bbb3802 Add permissions to README.md (#236)
* Add permissions to README.md

* remove space

* prettier

* remove extra changes

* fix spacing
2022-08-31 10:19:52 -04:00
dependabot[bot] 3c0579b484 Bump @actions/core from 1.9.0 to 1.9.1 (#233)
Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.9.0 to 1.9.1.
- [Release notes](https://github.com/actions/toolkit/releases)
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core)

---
updated-dependencies:
- dependency-name: "@actions/core"
  dependency-type: direct:production
...

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

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-08-22 14:00:31 -04:00
Oliver King b11eda66ea Fix README.md typo (#235) 2022-08-22 11:07:47 -04:00
Alexander Bartsch c117b29f9e consider slashes while cleaning labels (#231)
fix prettier format check errors
2022-08-16 14:28:12 -04:00
Jaiveer Katariya 01a65512ea Blue/Green Refactor (#229)
* fresh new branch

* Added coverage to gitignore

Signed-off-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MBP.lan>

* reverted package-lock.json

Signed-off-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MBP.lan>
Co-authored-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MBP.lan>
2022-08-12 15:47:05 -04:00
Jaiveer Katariya 531cfdcc3d Fixed Blue/Green Strategy Ingress Route-Method Glitch (#217)
* 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

* removed conflict on readme

* Added tests for bluegreen helper and resolved issue with ingress not being read correctly, still have to figure out why new services aren't showing up

* resolved services name issue

* looks functional, beginning refactor now

* refactored deploy methods for type error

* Removed refactor comments

* prettier

* implemented Oliver's feedback

* prettier

* added optional chaining operator

* removed refactor comment

Co-authored-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MacBook-Pro.local>
Co-authored-by: Oliver King <oking3@uncc.edu>
Co-authored-by: Jaiveer Katariya <jaiveerkatariya@Jaiveers-MBP.lan>
2022-07-29 10:58:58 -04:00
Marcus-Hines 0b5795551a Private Cluster functionality (#214) 2022-07-28 17:14:02 -04:00
Vidya Reddy bb0278db72 Swap annotation key to actions.github.com prefix (#216) 2022-07-27 13:53:57 -04:00
Vidya Reddy 71e93a71d4 Added Traffic split annotations (#215)
* Added Traffic split annotations

* traffic split - blueGreen deployment

* traffic split - canary deployment

* Traffic split annotations - canary deployment

* updated Readme and action.yml

* Traffic split - canary deployment

* clean code

* Clean code

* Clean code

* Create annotation object

* Updated Readme and action.yml

* Spelling correction

Co-authored-by: Vidya Reddy <vidyareddy@microsoft.com>
2022-07-25 13:43:13 -04:00
Oliver King 19d66d6bdb add clean function (#211) 2022-07-06 16:15:31 -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
95 changed files with 18234 additions and 16019 deletions
+36
View File
@@ -0,0 +1,36 @@
name: Bug Report
description: File a bug report specifying all inputs you provided for the action, we will respond to this thread with any questions.
title: 'Bug: '
labels: ['bug', 'triage']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: What-happened
attributes:
label: What happened?
description: Tell us what happened and how is it different from the expected?
placeholder: Tell us what you see!
validations:
required: true
- type: checkboxes
id: Version
attributes:
label: Version
options:
- label: I am using the latest version
required: true
- type: input
id: Runner
attributes:
label: Runner
description: What runner are you using?
placeholder: Mention the runner info (self-hosted, operating system)
validations:
required: true
- type: textarea
id: Logs
attributes:
label: Relevant log output
description: Run in debug mode for the most verbose logs. Please feel free to attach a screenshot of the logs
validations:
required: true
+6
View File
@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Action "k8s-deploy" Support
url: https://github.com/Azure/k8s-deploy
security: https://github.com/Azure/k8s-deploy/blob/main/SECURITY.md
about: Please ask and answer questions here.
@@ -0,0 +1,13 @@
name: Feature Request
description: File a Feature Request form, we will respond to this thread with any questions.
title: 'Feature Request: '
labels: ['Feature']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: Feature_request
attributes:
label: Feature request
description: Provide example functionality and links to relevant docs
validations:
required: true
+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:
# Initializes the CodeQL tools for scanning. # languages: go, javascript, csharp, python, cpp, java
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
# Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below) # If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild - name: Autobuild
uses: github/codeql-action/autobuild@v1 uses: github/codeql-action/autobuild@v1
# ️ Command-line programs to run using the OS shell. # ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl # 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project # and modify them (or add more) to build your code if your project
# uses a compiled language # uses a compiled language
#- run: | #- run: |
# make bootstrap # make bootstrap
# make release # make release
- name: Perform CodeQL Analysis - name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1 uses: github/codeql-action/analyze@v1
+28 -29
View File
@@ -1,36 +1,35 @@
name: setting-default-labels 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
- uses: actions/stale@v3 name: Setting issue as idle
name: Setting issue 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-issue-message: 'This issue is idle because it has been open for 14 days with no activity.' stale-issue-label: 'idle'
stale-issue-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'
exempt-issue-labels: 'backlog'
- uses: actions/stale@v3
- uses: actions/stale@v3 name: Setting PR as idle
name: Setting PR as idle with:
with: repo-token: ${{ secrets.GITHUB_TOKEN }}
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-message: 'This PR is idle because it has been open for 14 days with no activity.' stale-pr-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
+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 }}
+184 -184
View File
@@ -1,215 +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: Install dependencies - name: Install dependencies
run: | run: |
rm -rf node_modules/ rm -rf node_modules/
npm install npm install
- name: Install ncc - name: Install ncc
run: npm i -g @vercel/ncc run: npm i -g @vercel/ncc
- name: Build - name: Build
run: ncc build src/run.ts -o lib run: ncc build src/run.ts -o lib
- name: Set name of ns - name: Set name of ns
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)" run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
shell: bash shell: bash
id: ns id: ns
- uses: Azure/setup-kubectl@v1 - uses: Azure/setup-kubectl@v1
name: Install Kubectl name: Install Kubectl
- id: setup-minikube - id: setup-minikube
name: Setup Minikube name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2 uses: manusa/actions-setup-minikube@v2.4.2
with: with:
minikube version: "v1.24.0" minikube version: 'v1.24.0'
kubernetes version: "v1.17.8" kubernetes version: 'v1.17.8'
driver: "none" driver: 'none'
timeout-minutes: 3 timeout-minutes: 3
- name: Create namespace to run tests - name: Create namespace to run tests
run: kubectl create ns test-${{ steps.ns.outputs.name }} run: kubectl create ns test-${{ steps.ns.outputs.name }}
- uses: actions/setup-python@v2 - uses: actions/setup-python@v2
name: Install Python name: Install Python
with: with:
python-version: "3.x" python-version: '3.x'
- name: Cleaning any previously created items - name: Cleaning any previously created items
run: | run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }}
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-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 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
- name: Executing deploy action - name: Executing deploy action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: deploy action: deploy
- name: Checking if deploments and services were created with green labels - name: Checking if deploments and services were created with green labels
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action - name: Executing promote action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: promote action: promote
- name: Checking if deploments and services were created with none labels after promote - name: Checking if deploments and services were created with none labels after promote
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ 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 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action on - name: Executing deploy action on
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: deploy action: deploy
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy - name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ 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 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
- name: Executing reject action - name: Executing reject action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: reject action: reject
- name: Checking if deploments and services were routed back to none labels after reject - name: Checking if deploments and services were routed back to none labels after reject
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ 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 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Cleaning up current set up - name: Cleaning up current set up
run: | run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ 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 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress - name: Executing deploy action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: deploy action: deploy
- name: Checking if deploments, services and ingresses were created with green labels - name: Checking if deploments, services and ingresses were created with green labels
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action for ingress - name: Executing promote action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: promote action: promote
- name: Checking if deploments, services and ingresses were created with none labels after promote - name: Checking if deploments, services and ingresses were created with none labels after promote
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ 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 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress - name: Executing deploy action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: deploy action: deploy
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists - name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ 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 '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 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing reject action for ingress - name: Executing reject action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: reject action: reject
- name: Checking if deploments, services and ingresses were created with none labels after reject - name: Checking if deploments, services and ingresses were created with none labels after reject
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ 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 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' '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: Delete created namespace name: Delete created namespace
run: kubectl delete ns test-${{ steps.ns.outputs.name }} run: kubectl delete ns test-${{ steps.ns.outputs.name }}
- if: ${{ always() }} - if: ${{ always() }}
name: Posting result back to PR name: Posting result back to PR
run: | 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 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 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:
- main - main
- "releases/*" - 'releases/*'
push: push:
branches: branches:
- main - 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
+3 -1
View File
@@ -2,4 +2,6 @@ node_modules
.DS_Store .DS_Store
.idea .idea
lib/ lib/
coverage/
+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
}
+9 -9
View File
@@ -1,9 +1,9 @@
# Microsoft Open Source Code of Conduct # Microsoft Open Source Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
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
+477 -434
View File
@@ -1,434 +1,477 @@
# Deploy manifests action for Kubernetes # Deploy manifests action for Kubernetes
This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action). This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action).
If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
## Action capabilities This action requires the following permissions from your workflow:
Following are the key capabilities of this action: ```yaml
permissions:
- **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. id-token: write
contents: read
- **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. actions: read
```
- **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.
## Action capabilities
- **Deployment strategy** Supports both canary and blue-green deployment strategies
Following are the key capabilities of this action:
- **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). - **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.
- **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: - **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.
- **Service route-method**: Identified services are configured to target the green deployments. - **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.
- **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. - **Deployment strategy** Supports both canary and blue-green deployment strategies
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. - **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).
## Action inputs - **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:
<table>
<thead> - **Service route-method**: Identified services are configured to target the green deployments.
<tr> - **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.
<th>Action inputs</th> - **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.
<th>Description</th>
</tr> 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.
</thead>
<tr> ## Action inputs
<td>action </br></br>(Required)</td>
<td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td> <table>
</tr> <thead>
<tr> <tr>
<td>manifests </br></br>(Required)</td> <th>Action inputs</th>
<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> <th>Description</th>
</tr> </tr>
<tr> </thead>
<td>namespace </br></br>(Optional) <tr>
<td>Namespace within the cluster to deploy to.</td> <td>action </br></br>(Required)</td>
</tr> <td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td>
<tr> </tr>
<td>images </br></br>(Optional)</td> <tr>
<td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br> <td>manifests </br></br>(Required)</td>
<code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br> <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>
In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td> </tr>
</tr> <tr>
<tr> <td>strategy </br></br>(Required)</td>
<td>imagepullsecrets </br></br>(Optional)</td> <td>Acceptable values: basic/canary/blue-green. <br>
<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> Default value: basic
</tr> <br>Deployment strategy to be used while applying manifest files on the cluster.
<tr> <br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
<td>pull-images</br></br>(Optional)</td> <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>
<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> </tr>
</tr> <tr>
<tr> <td>namespace </br></br>(Optional)
<td>strategy </br></br>(Optional)</td> <td>Namespace within the cluster to deploy to.</td>
<td>Acceptable values: none/canary/blue-green. <br> </tr>
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> <td>images </br></br>(Optional)</td>
<tr> <td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br>
<td>traffic-split-method </br></br>(Optional)</td> <code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br>
<td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td> In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td>
</tr> </tr>
<tr> <tr>
<td>percentage </br></br>(Optional but required if strategy is canary)</td> <td>imagepullsecrets </br></br>(Optional)</td>
<td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</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>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</td> <td>pull-images</br></br>(Optional)</td>
<td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td> <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>
</tr> </tr>
<tr> <tr>
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>traffic-split-method </br></br>(Optional)</td>
<td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input. <td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>
<br>Service: Service selector labels are updated to target '-green' workloads. </tr>
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments. <tr>
<br>SMI: A <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> object is created for each required service to route traffic to new workloads.</td> <td>traffic-split-annotations </br></br>(Optional)</td>
</tr> <td>Annotations in the form of key/value pair to be added to TrafficSplit.</td>
<tr> <tr>
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>percentage </br></br>(Optional but required if strategy is canary)</td>
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td> <td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td>
</tr> </tr>
<tr> <tr>
<td>force </br></br>(Optional)</td> <td>baseline-and-canary-replicas </br></br> (Optional and relevant only if strategy is canary and traffic-split-method is smi)</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>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas each, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td>
</tr> </tr>
<tr> <tr>
<td>annotate-namespace</br></br>(Optional)</td> <td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td> <td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
</tr> <br>Service: Service selector labels are updated to target '-green' workloads.
</table> <br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
<br>SMI: A <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> object is created for each required service to route traffic to new workloads.</td>
## Usage Examples </tr>
<tr>
### Basic deployment (without any deployment strategy) <td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
```yaml </tr>
- uses: Azure/k8s-deploy@v3.1 <tr>
with: <td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td>
namespace: "myapp" <td>Acceptable values: true, false</br>Default value: false.</td>
manifests: | </tr>
dir/manifestsDirectory <tr>
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" <td>force </br></br>(Optional)</td>
imagepullsecrets: | <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>
image-pull-secret1 </tr>
image-pull-secret2 <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>
### Canary deployment without service mesh </tr>
</table>
```yaml
- uses: Azure/k8s-deploy@v3.1 ## Usage Examples
with:
namespace: "myapp" ### Basic deployment (without any deployment strategy)
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | ```yaml
image-pull-secret1 - uses: Azure/k8s-deploy@v3.1
image-pull-secret2 with:
manifests: | namespace: 'myapp'
deployment.yaml manifests: |
service.yaml dir/manifestsDirectory
dir/manifestsDirectory images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
strategy: canary imagepullsecrets: |
action: deploy image-pull-secret1
percentage: 20 image-pull-secret2
``` ```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: ### Private cluster deployment
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v4
with: with:
namespace: "myapp" resource-group: yourResourceGroup
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" name: yourClusterName
imagepullsecrets: | action: deploy
image-pull-secret1 strategy: basic
image-pull-secret2
manifests: | private-cluster: true
deployment.yaml manifests: |
service.yaml manifests/azure-vote-backend-deployment.yaml
dir/manifestsDirectory manifests/azure-vote-backend-service.yaml
strategy: canary manifests/azure-vote-frontend-deployment.yaml
action: promote # substitute reject if you want to reject manifests/azure-vote-frontend-service.yaml
``` images: |
registry.azurecr.io/containername
### Canary deployment based on Service Mesh Interface ```
```yaml ### Canary deployment without service mesh
- uses: Azure/k8s-deploy@v3.1
with: ```yaml
namespace: "myapp" - uses: Azure/k8s-deploy@v3.1
images: "contoso.azurecr.io/myapp:${{ event.run_id }}" with:
imagepullsecrets: | namespace: 'myapp'
image-pull-secret1 images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
image-pull-secret2 imagepullsecrets: |
manifests: | image-pull-secret1
deployment.yaml image-pull-secret2
service.yaml manifests: |
dir/manifestsDirectory deployment.yaml
strategy: canary service.yaml
action: deploy dir/manifestsDirectory
traffic-split-method: smi strategy: canary
percentage: 20 action: deploy
baseline-and-canary-replicas: 1 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@v3.1 - 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
dir/manifestsDirectory dir/manifestsDirectory
strategy: canary strategy: canary
traffic-split-method: smi action: promote # substitute reject if you want to reject
action: reject # substitute reject if you want to reject ```
```
### Canary deployment based on Service Mesh Interface
### Blue-Green deployment with different route methods
```yaml
```yaml - uses: Azure/k8s-deploy@v3.1
- 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 dir/manifestsDirectory
ingress.yml strategy: canary
strategy: blue-green action: deploy
action: deploy traffic-split-method: smi
route-method: ingress # substitute with service/smi as per need percentage: 20
version-switch-buffer: 15 baseline-and-canary-replicas: 1
``` ```
To promote/reject the green workload 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@v3.1 - 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 dir/manifestsDirectory
strategy: blue-green strategy: canary
route-method: ingress # should be the same as the value when action was deploy traffic-split-method: smi
action: promote # substitute reject if you want to reject action: reject # substitute promote if you want to promote
``` ```
## End to end workflows ### Blue-Green deployment with different route methods
Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters: ```yaml
- uses: Azure/k8s-deploy@v3.1
### Build container image and deploy to Azure Kubernetes Service cluster with:
namespace: 'myapp'
```yaml images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
on: [push] imagepullsecrets: |
image-pull-secret1
jobs: image-pull-secret2
build: manifests: |
runs-on: ubuntu-latest deployment.yaml
steps: service.yaml
- uses: actions/checkout@master ingress.yml
strategy: blue-green
- uses: Azure/docker-login@v1 action: deploy
with: route-method: ingress # substitute with service/smi as per need
login-server: contoso.azurecr.io version-switch-buffer: 15
username: ${{ secrets.REGISTRY_USERNAME }} ```
password: ${{ secrets.REGISTRY_PASSWORD }}
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
- run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} ```yaml
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} - uses: Azure/k8s-deploy@v3.1
with:
- uses: azure/setup-kubectl@v2.0 namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
# Set the target AKS cluster. imagepullsecrets: |
- uses: Azure/aks-set-context@v1 image-pull-secret1
with: image-pull-secret2
creds: "${{ secrets.AZURE_CREDENTIALS }}" manifests: |
cluster-name: contoso deployment.yaml
resource-group: contoso-rg service.yaml
ingress.yml
- uses: Azure/k8s-create-secret@v1.1 strategy: blue-green
with: route-method: ingress # should be the same as the value when action was deploy
container-registry-url: contoso.azurecr.io action: promote # substitute reject if you want to reject
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} ```
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret ## End to end workflows
- uses: Azure/k8s-deploy@v3.1 Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters:
with:
action: deploy ### Build container image and deploy to Azure Kubernetes Service cluster
manifests: |
manifests/deployment.yml ```yaml
manifests/service.yml on: [push]
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} jobs:
imagepullsecrets: | build:
demo-k8s-secret runs-on: ubuntu-latest
``` steps:
- uses: actions/checkout@master
### Build container image and deploy to any Azure Kubernetes Service cluster
- uses: Azure/docker-login@v1
```yaml with:
on: [push] login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
jobs: password: ${{ secrets.REGISTRY_PASSWORD }}
build:
runs-on: ubuntu-latest - run: |
steps: docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: actions/checkout@master docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: Azure/docker-login@v1 - uses: azure/setup-kubectl@v2.0
with:
login-server: contoso.azurecr.io # Set the target AKS cluster.
username: ${{ secrets.REGISTRY_USERNAME }} - uses: Azure/aks-set-context@v1
password: ${{ secrets.REGISTRY_PASSWORD }} with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
- run: | cluster-name: contoso
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} resource-group: contoso-rg
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: Azure/k8s-create-secret@v1.1
- uses: azure/setup-kubectl@v2.0 with:
container-registry-url: contoso.azurecr.io
- uses: Azure/k8s-set-context@v2 container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
with: container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
kubeconfig: ${{ secrets.KUBE_CONFIG }} secret-name: demo-k8s-secret
- uses: Azure/k8s-create-secret@v1.1 - uses: Azure/k8s-deploy@v3.1
with: with:
container-registry-url: contoso.azurecr.io action: deploy
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} manifests: |
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} manifests/deployment.yml
secret-name: demo-k8s-secret manifests/service.yml
images: |
- uses: Azure/k8s-deploy@v3.1 demo.azurecr.io/k8sdemo:${{ github.sha }}
with: imagepullsecrets: |
action: deploy demo-k8s-secret
manifests: | ```
manifests/deployment.yml
manifests/service.yml ### Build container image and deploy to any Azure Kubernetes Service cluster
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} ```yaml
imagepullsecrets: | on: [push]
demo-k8s-secret
``` jobs:
build:
### Build image and add `dockerfile-path` label to it runs-on: ubuntu-latest
steps:
We can use this image in other workflows once built. - uses: actions/checkout@master
```yaml - uses: Azure/docker-login@v1
on: [push] with:
env: login-server: contoso.azurecr.io
NAMESPACE: demo-ns2 username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
jobs:
build: - run: |
runs-on: ubuntu-latest docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
steps: docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: actions/checkout@master
- uses: azure/setup-kubectl@v2.0
- uses: Azure/docker-login@v1
with: - uses: Azure/k8s-set-context@v2
login-server: contoso.azurecr.io with:
username: ${{ secrets.REGISTRY_USERNAME }} kubeconfig: ${{ secrets.KUBE_CONFIG }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- uses: Azure/k8s-create-secret@v1.1
- run: | with:
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile container-registry-url: contoso.azurecr.io
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
``` container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret
### Use bake action to get manifests deploying to a Kubernetes cluster
- uses: Azure/k8s-deploy@v3.1
```yaml with:
on: [push] action: deploy
env: manifests: |
NAMESPACE: demo-ns2 manifests/deployment.yml
manifests/service.yml
jobs: images: |
deploy: demo.azurecr.io/k8sdemo:${{ github.sha }}
runs-on: ubuntu-latest imagepullsecrets: |
steps: demo-k8s-secret
- uses: actions/checkout@master ```
- uses: Azure/docker-login@v1 ### Build image and add `dockerfile-path` label to it
with:
login-server: contoso.azurecr.io We can use this image in other workflows once built.
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} ```yaml
on: [push]
- uses: azure/setup-kubectl@v2.0 env:
NAMESPACE: demo-ns2
# Set the target AKS cluster.
- uses: Azure/aks-set-context@v1 jobs:
with: build:
creds: "${{ secrets.AZURE_CREDENTIALS }}" runs-on: ubuntu-latest
cluster-name: contoso steps:
resource-group: contoso-rg - uses: actions/checkout@master
- uses: Azure/k8s-create-secret@v1.1 - uses: Azure/docker-login@v1
with: with:
namespace: ${{ env.NAMESPACE }} login-server: contoso.azurecr.io
container-registry-url: contoso.azurecr.io username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} password: ${{ secrets.REGISTRY_PASSWORD }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret - run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
- uses: azure/k8s-bake@v2 docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
with: ```
renderEngine: "helm"
helmChart: "./aks-helloworld/" ### Use bake action to get manifests deploying to a Kubernetes cluster
overrideFiles: "./aks-helloworld/values-override.yaml"
overrides: | ```yaml
replicas:2 on: [push]
helm-version: "latest" env:
id: bake NAMESPACE: demo-ns2
- uses: Azure/k8s-deploy@v1.2 jobs:
with: deploy:
action: deploy runs-on: ubuntu-latest
manifests: ${{ steps.bake.outputs.manifestsBundle }} steps:
images: | - uses: actions/checkout@master
contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | - uses: Azure/docker-login@v1
demo-k8s-secret with:
``` login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
## Traceability Fields Support password: ${{ secrets.REGISTRY_PASSWORD }}
- 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. - uses: azure/setup-kubectl@v2.0
- 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. # Set the target AKS cluster.
- uses: Azure/aks-set-context@v1
## Contributing with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
This project welcomes contributions and suggestions. Most contributions require you to agree to a cluster-name: contoso
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us resource-group: contoso-rg
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
- uses: Azure/k8s-create-secret@v1.1
When you submit a pull request, a CLA bot will automatically determine whether you need to provide with:
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions namespace: ${{ env.NAMESPACE }}
provided by the bot. You will only need to do this once across all repos using our CLA. container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or secret-name: demo-k8s-secret
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
- uses: azure/k8s-bake@v2
with:
renderEngine: 'helm'
helmChart: './aks-helloworld/'
overrideFiles: './aks-helloworld/values-override.yaml'
overrides: |
replicas:2
helm-version: 'latest'
id: bake
- uses: Azure/k8s-deploy@v1.2
with:
action: deploy
manifests: ${{ steps.bake.outputs.manifestsBundle }}
images: |
contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
demo-k8s-secret
```
## 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.
- 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.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Support
k8s-deploy is an open source project that is [**not** covered by the Microsoft Azure support policy](https://support.microsoft.com/en-us/help/2941892/support-for-linux-and-open-source-technology-in-azure). [Please search open issues here](https://github.com/Azure/k8s-deploy/issues), and if your issue isn't already represented please [open a new one](https://github.com/Azure/k8s-deploy/issues/new/choose). The project maintainers will respond to the best of their abilities.
+35 -35
View File
@@ -1,35 +1,35 @@
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK --> <!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
## Security ## Security
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.
## Preferred Languages ## Preferred Languages
We prefer all communications to be in English. We prefer all communications to be in English.
## Policy ## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
<!-- END MICROSOFT SECURITY.MD BLOCK --> <!-- END MICROSOFT SECURITY.MD BLOCK -->
+80 -67
View File
@@ -1,67 +1,80 @@
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
pull-images: pull-images:
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" 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: true default: true
strategy: strategy:
description: "Deployment strategy to be used. Allowed values are none, canary and blue-green" description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
required: false required: true
default: "none" default: 'basic'
route-method: route-method:
description: "Route based on service, ingress or SMI for blue-green strategy" description: 'Route based on service, ingress or SMI for blue-green strategy'
required: false required: false
default: "service" default: 'service'
version-switch-buffer: version-switch-buffer:
description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)" 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: 0 default: 0
traffic-split-method: traffic-split-method:
description: "Traffic split method to be used. Allowed values are pod and smi" description: 'Traffic split method to be used. Allowed values are pod and smi'
required: false required: false
default: "pod" default: 'pod'
baseline-and-canary-replicas: traffic-split-annotations:
description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)" description: 'Annotations in the form of key/value pair to be added to TrafficSplit. Relevant only if deployement strategy is blue-green or canary'
required: false required: false
default: 0 baseline-and-canary-replicas:
percentage: description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)'
description: "Percentage of traffic redirect to canary deployment" required: false
required: false default: ''
default: 0 percentage:
action: description: 'Percentage of traffic redirect to canary deployment'
description: "deploy, promote, or reject" required: false
required: true default: 0
default: "deploy" action:
force: description: 'deploy, promote, or reject'
description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command" required: true
required: false default: 'deploy'
default: false force:
token: description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command'
description: "Github token" required: false
default: ${{ github.token }} default: false
required: true token:
annotate-namespace: description: 'Github token'
description: "Annotate the target namespace" default: ${{ github.token }}
required: false required: true
default: true annotate-namespace:
description: 'Annotate the target namespace'
branding: required: false
color: "green" default: true
runs: private-cluster:
using: "node16" description: 'True if cluster is AKS private cluster'
main: "lib/index.js" required: false
default: false
resource-group:
description: 'Name of resource group - Only required if using private cluster'
required: false
name:
description: 'Resource group name - Only required if using private cluster'
required: false
branding:
color: 'green'
runs:
using: 'node16'
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
} }
+11322 -10831
View File
File diff suppressed because it is too large Load Diff
+32 -28
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",
}, "coverage": "jest --coverage=true",
"dependencies": { "format": "prettier --write .",
"@actions/core": "^1.2.6", "format-check": "prettier --check ."
"@actions/exec": "^1.0.0", },
"@actions/io": "^1.0.0", "dependencies": {
"@actions/tool-cache": "1.1.2", "@actions/core": "^1.9.1",
"@octokit/core": "^3.5.1", "@actions/exec": "^1.0.0",
"@octokit/plugin-retry": "^3.0.9", "@actions/io": "^1.0.0",
"@types/minipass": "^3.1.2", "@actions/tool-cache": "1.1.2",
"js-yaml": "3.13.1" "@octokit/core": "^3.5.1",
}, "@octokit/plugin-retry": "^3.0.9",
"devDependencies": { "@types/minipass": "^3.1.2",
"@types/jest": "^26.0.0", "js-yaml": "3.13.1"
"@types/js-yaml": "^3.12.7", },
"@types/node": "^12.20.41", "devDependencies": {
"jest": "^26.0.0", "@types/jest": "^26.0.0",
"ts-jest": "^26.0.0", "@types/js-yaml": "^3.12.7",
"typescript": "3.9.5" "@types/node": "^12.20.41",
} "jest": "^26.0.0",
} "prettier": "^2.7.1",
"ts-jest": "^26.0.0",
"typescript": "3.9.5"
}
}
+69 -75
View File
@@ -1,85 +1,79 @@
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 { 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";
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.debug(`Deployed manifest files: ${deployedManifestFiles}`)
core.endGroup()
// 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) { // print ingresses
core.info("Routing blue green"); core.startGroup('Printing ingresses')
const routeStrategy = parseRouteStrategy( const ingressResources: Resource[] = getResources(deployedManifestFiles, [
core.getInput("route-method", { required: true }) KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
); ])
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy); for (const ingressResource of ingressResources) {
} await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name
)
}
core.endGroup()
// print ingresses // annotate resources
core.info("Printing ingresses"); core.startGroup('Annotating resources')
const ingressResources: Resource[] = getResources(deployedManifestFiles, [ let allPods
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, try {
]); allPods = JSON.parse((await kubectl.getAllPods()).stdout)
for (const ingressResource of ingressResources) { } catch (e) {
await kubectl.getResource( core.debug(`Unable to parse pods: ${e}`)
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS, }
ingressResource.name await annotateAndLabelResources(
); deployedManifestFiles,
} kubectl,
resourceTypes,
// annotate resources allPods
core.info("Annotating resources"); )
let allPods; core.endGroup()
try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout);
} catch (e) {
core.debug("Unable to parse pods: " + e);
}
await annotateAndLabelResources(
deployedManifestFiles,
kubectl,
resourceTypes,
allPods
);
} }
+189 -172
View File
@@ -1,172 +1,189 @@
import * as core from "@actions/core"; import * as core from '@actions/core'
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 * as PodCanaryHelper from '../strategyHelpers/canary/podCanaryHelper'
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, deleteGreenObjects,
deleteWorkloadsAndServicesWithLabel, getManifestObjects,
deleteWorkloadsWithLabel, NONE_LABEL_VALUE
getManifestObjects, } from '../strategyHelpers/blueGreen/blueGreenHelper'
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE, import {BlueGreenManifests} from '../types/blueGreenTypes'
} from "../strategyHelpers/blueGreen/blueGreenHelper";
import { import {
promoteBlueGreenService, promoteBlueGreenIngress,
routeBlueGreenService, promoteBlueGreenService,
} from "../strategyHelpers/blueGreen/serviceBlueGreenHelper"; promoteBlueGreenSMI
import { } from '../strategyHelpers/blueGreen/promote'
promoteBlueGreenIngress,
routeBlueGreenIngress, import {
} from "../strategyHelpers/blueGreen/ingressBlueGreenHelper"; routeBlueGreenService,
import { routeBlueGreenIngressUnchanged,
cleanupSMI, routeBlueGreenSMI
promoteBlueGreenSMI, } from '../strategyHelpers/blueGreen/route'
routeBlueGreenSMI,
} from "../strategyHelpers/blueGreen/smiBlueGreenHelper"; import {cleanupSMI} 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 manifestFilesForDeployment: string[] = updateManifestFiles(manifests)
core.getInput("traffic-split-method", { required: true })
); const trafficSplitMethod = parseTrafficSplitMethod(
if (trafficSplitMethod == TrafficSplitMethod.SMI) { core.getInput('traffic-split-method', {required: true})
includeServices = true; )
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to includeServices = true
// canary deployment, then update stable deployment and then redirect traffic to stable deployment
core.info("Redirecting traffic to canary deployment"); // In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment( // canary deployment, then update stable deployment and then redirect traffic to stable deployment
kubectl, core.startGroup('Redirecting traffic to canary deployment')
manifests await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
); kubectl,
manifests
core.info("Deploying input manifests with SMI canary strategy"); )
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY); core.endGroup()
core.info("Redirecting traffic to stable deployment"); core.startGroup(
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( 'Deploying input manifests with SMI canary strategy from promote'
kubectl, )
manifests await SMICanaryDeploymentHelper.deploySMICanary(
); manifestFilesForDeployment,
} else { kubectl,
core.info("Deploying input manifests"); true
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY); )
} core.endGroup()
core.info("Deleting canary and baseline workloads"); core.startGroup('Redirecting traffic to stable deployment')
try { await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
await canaryDeploymentHelper.deleteCanaryDeployment( kubectl,
kubectl, manifests
manifests, )
includeServices core.endGroup()
); } else {
} catch (ex) { core.startGroup('Deploying input manifests from promote')
core.warning( await PodCanaryHelper.deployPodCanary(
"Exception occurred while deleting canary and baseline workloads: " + ex manifestFilesForDeployment,
); kubectl,
} true
} )
core.endGroup()
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) { }
// update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests); core.startGroup('Deleting canary and baseline workloads')
const manifestObjects: BlueGreenManifests = try {
getManifestObjects(inputManifestFiles); await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
const routeStrategy = parseRouteStrategy( manifests,
core.getInput("route-method", { required: true }) includeServices
); )
} catch (ex) {
core.info("Deleting old deployment and making new one"); core.warning(
let result; `Exception occurred while deleting canary and baseline workloads: ${ex}`
if (routeStrategy == RouteStrategy.INGRESS) { )
result = await promoteBlueGreenIngress(kubectl, manifestObjects); }
} else if (routeStrategy == RouteStrategy.SMI) { core.endGroup()
result = await promoteBlueGreenSMI(kubectl, manifestObjects); }
} else {
result = await promoteBlueGreenService(kubectl, manifestObjects); async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
} // update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests)
// checking stability of newly created deployments const manifestObjects: BlueGreenManifests =
core.info("Checking manifest stability"); getManifestObjects(inputManifestFiles)
const deployedManifestFiles = result.newFilePaths;
const resources: Resource[] = getResources( const routeStrategy = parseRouteStrategy(
deployedManifestFiles, core.getInput('route-method', {required: true})
models.DEPLOYMENT_TYPES.concat([ )
models.DiscoveryAndLoadBalancerResource.SERVICE,
]) core.startGroup('Deleting old deployment and making new stable deployment')
);
await KubernetesManifestUtility.checkManifestStability(kubectl, resources); const {deployResult} = await (async () => {
switch (routeStrategy) {
core.info( case RouteStrategy.INGRESS:
"Routing to new deployments and deleting old workloads and services" return await promoteBlueGreenIngress(kubectl, manifestObjects)
); case RouteStrategy.SMI:
if (routeStrategy == RouteStrategy.INGRESS) { return await promoteBlueGreenSMI(kubectl, manifestObjects)
await routeBlueGreenIngress( default:
kubectl, return await promoteBlueGreenService(kubectl, manifestObjects)
null, }
manifestObjects.serviceNameMap, })()
manifestObjects.ingressEntityList
); core.endGroup()
await deleteWorkloadsAndServicesWithLabel(
kubectl, // checking stability of newly created deployments
GREEN_LABEL_VALUE, core.startGroup('Checking manifest stability')
manifestObjects.deploymentEntityList, const deployedManifestFiles = deployResult.manifestFiles
manifestObjects.serviceEntityList const resources: Resource[] = getResources(
); deployedManifestFiles,
} else if (routeStrategy == RouteStrategy.SMI) { models.DEPLOYMENT_TYPES.concat([
await routeBlueGreenSMI( models.DiscoveryAndLoadBalancerResource.SERVICE
kubectl, ])
NONE_LABEL_VALUE, )
manifestObjects.serviceEntityList await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
); core.endGroup()
await deleteWorkloadsWithLabel(
kubectl, core.startGroup(
GREEN_LABEL_VALUE, 'Routing to new deployments and deleting old workloads and services'
manifestObjects.deploymentEntityList )
); if (routeStrategy == RouteStrategy.INGRESS) {
await cleanupSMI(kubectl, manifestObjects.serviceEntityList); await routeBlueGreenIngressUnchanged(
} else { kubectl,
await routeBlueGreenService( manifestObjects.serviceNameMap,
kubectl, manifestObjects.ingressEntityList
NONE_LABEL_VALUE, )
manifestObjects.serviceEntityList
); await deleteGreenObjects(
await deleteWorkloadsWithLabel( kubectl,
kubectl, [].concat(
GREEN_LABEL_VALUE, manifestObjects.deploymentEntityList,
manifestObjects.deploymentEntityList manifestObjects.serviceEntityList
); )
} )
} } else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
} else {
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
}
core.endGroup()
}
+77 -68
View File
@@ -1,68 +1,77 @@
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 {BlueGreenManifests} from '../types/blueGreenTypes'
import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper"; import {
import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper"; rejectBlueGreenIngress,
import { DeploymentStrategy } from "../types/deploymentStrategy"; rejectBlueGreenService,
import { rejectBlueGreenSMI
parseTrafficSplitMethod, } from '../strategyHelpers/blueGreen/reject'
TrafficSplitMethod, import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper'
} from "../types/trafficSplitMethod"; import {DeploymentStrategy} from '../types/deploymentStrategy'
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy"; import {
parseTrafficSplitMethod,
export async function reject( TrafficSplitMethod
kubectl: Kubectl, } from '../types/trafficSplitMethod'
manifests: string[], import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
deploymentStrategy: DeploymentStrategy
) { export async function reject(
switch (deploymentStrategy) { kubectl: Kubectl,
case DeploymentStrategy.CANARY: manifests: string[],
await rejectCanary(kubectl, manifests); deploymentStrategy: DeploymentStrategy
break; ) {
case DeploymentStrategy.BLUE_GREEN: switch (deploymentStrategy) {
await rejectBlueGreen(kubectl, manifests); case DeploymentStrategy.CANARY:
break; await rejectCanary(kubectl, manifests)
default: break
throw "Invalid delete deployment strategy"; case DeploymentStrategy.BLUE_GREEN:
} await rejectBlueGreen(kubectl, manifests)
} break
default:
async function rejectCanary(kubectl: Kubectl, manifests: string[]) { throw 'Invalid delete deployment strategy'
let includeServices = false; }
}
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true }) async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
); let includeServices = false
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
core.info("Rejecting deployment with SMI canary strategy"); const trafficSplitMethod = parseTrafficSplitMethod(
includeServices = true; core.getInput('traffic-split-method', {required: true})
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( )
kubectl, if (trafficSplitMethod == TrafficSplitMethod.SMI) {
manifests core.startGroup('Rejecting deployment with SMI canary strategy')
); includeServices = true
} await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
core.info("Deleting baseline and canary workloads"); manifests
await canaryDeploymentHelper.deleteCanaryDeployment( )
kubectl, core.endGroup()
manifests, }
includeServices
); core.startGroup('Deleting baseline and canary workloads')
} await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) { manifests,
core.info("Rejecting deployment with blue green strategy"); includeServices
)
const routeStrategy = parseRouteStrategy( core.endGroup()
core.getInput("route-method", { required: true }) }
);
if (routeStrategy == RouteStrategy.INGRESS) { async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
await rejectBlueGreenIngress(kubectl, manifests); const routeStrategy = parseRouteStrategy(
} else if (routeStrategy == RouteStrategy.SMI) { core.getInput('route-method', {required: true})
await rejectBlueGreenSMI(kubectl, manifests); )
} else { core.startGroup('Rejecting deployment with blue green strategy')
await rejectBlueGreenService(kubectl, manifests); core.info(`using routeMethod ${routeStrategy}`)
} const manifestObjects: BlueGreenManifests = getManifestObjects(manifests)
}
if (routeStrategy == RouteStrategy.INGRESS) {
await rejectBlueGreenIngress(kubectl, manifestObjects)
} else if (routeStrategy == RouteStrategy.SMI) {
await rejectBlueGreenSMI(kubectl, manifestObjects)
} else {
await rejectBlueGreenService(kubectl, manifestObjects)
}
core.endGroup()
}
+16
View File
@@ -0,0 +1,16 @@
import * as core from '@actions/core'
import {parseAnnotations} from './types/annotations'
export const inputAnnotations = parseAnnotations(
core.getInput('annotations', {required: false})
)
export function getBufferTime(): number {
const inputBufferTime = parseInt(
core.getInput('version-switch-buffer') || '0'
)
if (inputBufferTime < 0 || inputBufferTime > 300)
throw Error('Version switch buffer must be between 0 and 300 (inclusive)')
return inputBufferTime
}
+69 -56
View File
@@ -1,56 +1,69 @@
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"; import {getFilesFromDirectories} from './utilities/fileUtils'
import {PrivateKubectl} from './types/privatekubectl'
export async function run() {
// verify kubeconfig is set export async function run() {
if (!process.env["KUBECONFIG"]) // verify kubeconfig is set
core.warning( if (!process.env['KUBECONFIG'])
"KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action." core.warning(
); 'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.'
)
// get inputs
const action: Action | undefined = parseAction( // get inputs
core.getInput("action", { required: true }) const action: Action | undefined = parseAction(
); core.getInput('action', {required: true})
const strategy = parseDeploymentStrategy(core.getInput("strategy")); )
const manifestsInput = core.getInput("manifests", { required: true }); const strategy = parseDeploymentStrategy(core.getInput('strategy'))
const manifestFilePaths = manifestsInput const manifestsInput = core.getInput('manifests', {required: true})
.split(/[\n,;]+/) // split into each individual manifest const manifestFilePaths = manifestsInput
.map((manifest) => manifest.trim()) // remove surrounding whitespace .split(/[\n,;]+/) // split into each individual manifest
.filter((manifest) => manifest.length > 0); // remove any blanks .map((manifest) => manifest.trim()) // remove surrounding whitespace
.filter((manifest) => manifest.length > 0) // remove any blanks
const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
// create kubectl const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
const kubectlPath = await getKubectlPath(); const kubectlPath = await getKubectlPath()
const namespace = core.getInput("namespace") || "default"; const namespace = core.getInput('namespace') || 'default'
const kubectl = new Kubectl(kubectlPath, namespace, true); const isPrivateCluster =
core.getInput('private-cluster').toLowerCase() === 'true'
// run action const resourceGroup = core.getInput('resource-group') || ''
switch (action) { const resourceName = core.getInput('name') || ''
case Action.DEPLOY: {
await deploy(kubectl, fullManifestFilePaths, strategy); const kubectl = isPrivateCluster
break; ? new PrivateKubectl(
} kubectlPath,
case Action.PROMOTE: { namespace,
await promote(kubectl, fullManifestFilePaths, strategy); true,
break; resourceGroup,
} resourceName
case Action.REJECT: { )
await reject(kubectl, fullManifestFilePaths, strategy); : new Kubectl(kubectlPath, namespace, true)
break;
} // run action
default: { switch (action) {
throw Error( case Action.DEPLOY: {
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".' await deploy(kubectl, fullManifestFilePaths, strategy)
); break
} }
} case Action.PROMOTE: {
} await promote(kubectl, fullManifestFilePaths, strategy)
break
run().catch(core.setFailed); }
case Action.REJECT: {
await reject(kubectl, fullManifestFilePaths, strategy)
break
}
default: {
throw Error(
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
)
}
}
}
run().catch(core.setFailed)
@@ -0,0 +1,196 @@
import {
deployWithLabel,
deleteGreenObjects,
fetchResource,
getDeploymentMatchLabels,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
isServiceRouted
} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import {K8sObject} from '../../types/k8sObject'
import * as manifestUpdateUtils from '../../utilities/manifestUpdateUtils'
import {ExecOutput} from '@actions/exec'
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('bluegreenhelper functions', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(['test/unit/manifests/test-ingress.yml'])
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly deletes services and workloads according to label', async () => {
jest.spyOn(bgHelper, 'deleteObjects').mockReturnValue({} as Promise<void>)
const value = await deleteGreenObjects(
kubectl,
[].concat(
testObjects.deploymentEntityList,
testObjects.serviceEntityList
)
)
expect(value).toHaveLength(2)
expect(value).toContainEqual({
name: 'nginx-service-green',
kind: 'Service'
})
expect(value).toContainEqual({
name: 'nginx-deployment-green',
kind: 'Deployment'
})
})
test('parses objects correctly from one file (getManifestObjects)', () => {
expect(testObjects.deploymentEntityList[0].kind).toBe('Deployment')
expect(testObjects.serviceEntityList[0].kind).toBe('Service')
expect(testObjects.ingressEntityList[0].kind).toBe('Ingress')
expect(
testObjects.deploymentEntityList[0].spec.selector.matchLabels.app
).toBe('nginx')
})
test('parses other kinds of objects (getManifestObjects)', () => {
const otherObjectsCollection = getManifestObjects([
'test/unit/manifests/anomaly-objects-test.yml'
])
expect(
otherObjectsCollection.unroutedServiceEntityList[0].metadata.name
).toBe('unrouted-service')
expect(otherObjectsCollection.otherObjects[0].metadata.name).toBe(
'foobar-rollout'
)
})
test('correctly classifies routed services', () => {
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(true)
testObjects.serviceEntityList[0].spec.selector.app = 'fakeapp'
expect(
isServiceRouted(
testObjects.serviceEntityList[0],
testObjects.deploymentEntityList
)
).toBe(false)
})
test('correctly makes labeled workloads', async () => {
const cwlResult: BlueGreenDeployment = await deployWithLabel(
kubectl,
testObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
expect(cwlResult.deployResult.manifestFiles[0]).toBe('')
})
test('correctly makes new blue green object (getNewBlueGreenObject and addBlueGreenLabelsAndAnnotations)', () => {
const modifiedDeployment = getNewBlueGreenObject(
testObjects.deploymentEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedDeployment.metadata.name).toBe('nginx-deployment-green')
expect(modifiedDeployment.metadata.labels['k8s.deploy.color']).toBe(
'green'
)
const modifiedSvc = getNewBlueGreenObject(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(modifiedSvc.metadata.name).toBe('nginx-service-green')
expect(modifiedSvc.metadata.labels['k8s.deploy.color']).toBe('green')
})
test('correctly fetches k8s objects', async () => {
const mockExecOutput = {
stderr: '',
stdout: JSON.stringify(testObjects.deploymentEntityList[0]),
exitCode: 0
}
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
const fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched.metadata.name).toBe('nginx-deployment')
})
test('exits when fails to fetch k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(kubectl, 'getResource')
.mockImplementation(() => Promise.resolve(mockExecOutput))
let fetched = await fetchResource(
kubectl,
'nginx-deployment',
'Deployment'
)
expect(fetched).toBe(null)
jest.spyOn(kubectl, 'getResource').mockImplementation()
fetched = await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
expect(fetched).toBe(null)
})
test('returns null when fetch fails to unset k8s objects', async () => {
const mockExecOutput = {
stdout: 'this should not matter',
exitCode: 0,
stderr: 'this is a fake error'
} as ExecOutput
jest
.spyOn(manifestUpdateUtils, 'UnsetClusterSpecificDetails')
.mockImplementation(() => {
throw new Error('test error')
})
expect(
await fetchResource(kubectl, 'nginx-deployment', 'Deployment')
).toBe(null)
})
test('gets deployment labels', () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
const mockPodObject: K8sObject = {
kind: 'Pod',
metadata: {name: 'testPod', labels: mockLabels},
spec: {}
}
expect(
getDeploymentMatchLabels(mockPodObject)[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(GREEN_LABEL_VALUE)
expect(
getDeploymentMatchLabels(testObjects.deploymentEntityList[0])['app']
).toBe('nginx')
})
})
+210 -299
View File
@@ -1,355 +1,266 @@
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 {DeployResult} from '../../types/deployResult'
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
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 { routeBlueGreenService } from "./serviceBlueGreenHelper";
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
import { import {
UnsetClusterSpecificDetails, BlueGreenDeployment,
updateObjectLabels, BlueGreenManifests
updateSelectorLabels, } from '../../types/blueGreenTypes'
} from "../../utilities/manifestUpdateUtils"; import * as fileHelper from '../../utilities/fileUtils'
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 {
import { RouteStrategy } from "../../types/routeStrategy"; UnsetClusterSpecificDetails,
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
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 async function deleteGreenObjects(
serviceEntityList: any[]; kubectl: Kubectl,
serviceNameMap: Map<string, string>; toDelete: K8sObject[]
unroutedServiceEntityList: any[]; ): Promise<K8sDeleteObject[]> {
deploymentEntityList: any[]; // const resourcesToDelete: K8sDeleteObject[] = []
ingressEntityList: any[]; const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => {
otherObjects: any[]; return {
name: getBlueGreenResourceName(obj.metadata.name, GREEN_SUFFIX),
kind: obj.kind
}
})
core.debug(`deleting green objects: ${JSON.stringify(resourcesToDelete)}`)
await deleteObjects(kubectl, resourcesToDelete)
return resourcesToDelete
} }
export async function routeBlueGreen( export async function deleteObjects(
kubectl: Kubectl, kubectl: Kubectl,
inputManifestFiles: string[], deleteList: K8sDeleteObject[]
routeStrategy: RouteStrategy
) { ) {
// sleep for buffer time // delete services and deployments
const bufferTime: number = parseInt( for (const delObject of deleteList) {
core.getInput("version-switch-buffer") || "0" try {
); const result = await kubectl.delete([delObject.kind, delObject.name])
if (bufferTime < 0 || bufferTime > 300) checkForErrors([result])
throw Error("Version switch buffer must be between 0 and 300 (inclusive)"); } catch (ex) {
const startSleepDate = new Date(); core.debug(`failed to delete object ${delObject.name}: ${ex}`)
core.info( }
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}` }
);
await sleep(bufferTime * 1000 * 60);
const endSleepDate = new Date();
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
);
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles);
core.debug("Manifest objects: " + JSON.stringify(manifestObjects));
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
} else {
await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
}
}
export async function deleteWorkloadsWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[]
) {
const resourcesToDelete = [];
deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete new green deployments
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteWorkloadsAndServicesWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[],
serviceEntityList: any[]
) {
// need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
const resourcesToDelete = [];
deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete green labels
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// delete services and deployments
for (const delObject of deleteList) {
try {
const result = await kubectl.delete([delObject.kind, delObject.name]);
checkForErrors([result]);
} catch (ex) {
// 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: K8sObject[] = []
const routedServiceEntityList = []; const routedServiceEntityList: K8sObject[] = []
const unroutedServiceEntityList = []; const unroutedServiceEntityList: K8sObject[] = []
const ingressEntityList = []; const ingressEntityList: K8sObject[] = []
const otherEntitiesList = []; const otherEntitiesList: K8sObject[] = []
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; const serviceSelector: any = getServiceSelector(serviceObject)
const serviceSelector: any = getServiceSelector(serviceObject);
if (serviceSelector) {
if (
deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject);
return (
matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
);
})
) {
shouldBeRouted = true;
}
}
return shouldBeRouted; return (
serviceSelector &&
deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject)
return (
matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
)
})
)
} }
export async function createWorkloadsWithLabel( export async function deployWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deploymentObjectList: any[], deploymentObjectList: any[],
nextLabel: string nextLabel: string
) { ): Promise<BlueGreenDeployment> {
const newObjectsList = []; const newObjectsList = deploymentObjectList.map((inputObject) =>
deploymentObjectList.forEach((inputObject) => { getNewBlueGreenObject(inputObject, nextLabel)
// creating deployment with label )
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel);
core.debug(
"New blue-green object is: " + JSON.stringify(newBlueGreenObject)
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); core.debug(
const result = await kubectl.apply(manifestFiles); `objects deployed with label are ${JSON.stringify(newObjectsList)}`
)
return { result: result, newFilePaths: manifestFiles }; const deployResult = await deployObjects(kubectl, newObjectsList)
return {deployResult, objects: newObjectsList}
} }
export function getNewBlueGreenObject( export function getNewBlueGreenObject(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): object { ): K8sObject {
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 not 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
) { ): Promise<K8sObject> {
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) as K8sObject
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}`
); )
} }
} }
}
export async function deployObjects(
kubectl: Kubectl,
objectsList: any[]
): Promise<DeployResult> {
const manifestFiles = fileHelper.writeObjectsToFile(objectsList)
const execResult = await kubectl.apply(manifestFiles)
return {execResult, manifestFiles}
} }
@@ -0,0 +1,75 @@
import {getManifestObjects} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployBlueGreen, deployBlueGreenIngress} from './deploy'
import * as routeTester from './route'
import {Kubectl} from '../../types/kubectl'
import {RouteStrategy} from '../../types/routeStrategy'
import * as TSutils from '../../utilities/trafficSplitUtils'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
describe('deploy tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('correctly determines deploy type and acts accordingly', async () => {
const kubectl = new Kubectl('')
const mockBgDeployment: BlueGreenDeployment = {
deployResult: {
execResult: {exitCode: 0, stderr: '', stdout: ''},
manifestFiles: []
},
objects: []
}
jest
.spyOn(routeTester, 'routeBlueGreenForDeploy')
.mockImplementation(() => Promise.resolve(mockBgDeployment))
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(2)
const result = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(result.objects.length).toBe(2)
const smiResult = await deployBlueGreen(
kubectl,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects.length).toBe(3)
})
test('correctly deploys blue/green ingress', async () => {
const kc = new Kubectl('')
const value = await deployBlueGreenIngress(kc, ingressFilepath)
const nol = value.objects.map((obj) => {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service-green')
}
if (obj.kind === 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment-green')
}
})
})
})
+136
View File
@@ -0,0 +1,136 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {RouteStrategy} from '../../types/routeStrategy'
import {
deployWithLabel,
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {setupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenForDeploy} from './route'
export async function deployBlueGreen(
kubectl: Kubectl,
files: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
const blueGreenDeployment = await (async () => {
switch (routeStrategy) {
case RouteStrategy.INGRESS:
return await deployBlueGreenIngress(kubectl, files)
case RouteStrategy.SMI:
return await deployBlueGreenSMI(kubectl, files)
default:
return await deployBlueGreenService(kubectl, files)
}
})()
core.startGroup('Routing blue green')
await routeBlueGreenForDeploy(kubectl, files, routeStrategy)
core.endGroup()
return blueGreenDeployment
}
export async function deployBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create services and other objects
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.serviceEntityList,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, newObjectsList)
// make extraservices and trafficsplit
await setupSMI(kubectl, manifestObjects.serviceEntityList)
// create new deloyments
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
return {
deployResult: blueGreenDeployment.deployResult,
objects: [].concat(blueGreenDeployment.objects, newObjectsList)
}
}
export async function deployBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const servicesAndDeployments = [].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
const workloadDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
servicesAndDeployments,
GREEN_LABEL_VALUE
)
const otherObjects = [].concat(
manifestObjects.otherObjects,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, otherObjects)
core.debug(
`new objects after processing services and other objects: \n
${JSON.stringify(servicesAndDeployments)}`
)
return {
deployResult: workloadDeployment.deployResult,
objects: [].concat(workloadDeployment.objects, otherObjects)
}
}
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
): Promise<BlueGreenDeployment> {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths)
// create deployments with green label value
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
)
// create other non deployment and non service entities
const newObjectsList = [].concat(
manifestObjects.otherObjects,
manifestObjects.ingressEntityList,
manifestObjects.unroutedServiceEntityList
)
await deployObjects(kubectl, newObjectsList)
// returning deployment details to check for rollout stability
return {
deployResult: blueGreenDeployment.deployResult,
objects: [].concat(blueGreenDeployment.objects, newObjectsList)
}
}
@@ -0,0 +1,123 @@
import {getManifestObjects, GREEN_LABEL_VALUE} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted,
validateIngresses
} from './ingressBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
const betaFilepath = ['test/unit/manifests/test-ingress.yml']
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('ingress blue green helpers', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('it should correctly classify ingresses', () => {
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
testObjects.ingressEntityList[0].spec.rules[0].http.paths = {}
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(false)
expect(
isIngressRouted(
getManifestObjects(betaFilepath).ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
})
test('it should correctly update ingresses', () => {
const updatedIng = getUpdatedBlueGreenIngress(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.name).toBe('nginx-ingress')
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
const oldIngObjects = getManifestObjects(betaFilepath)
const oldIng = getUpdatedBlueGreenIngress(
oldIngObjects.ingressEntityList[0],
oldIngObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
})
test('it should validate ingresses', async () => {
// what if nothing gets returned from fetchResource?
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
let validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test valid ingress
let mockIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service-green'
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
mockIngress.metadata.labels = mockLabels
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockIngress))
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(true)
// test invalid labels
mockIngress.metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL] =
bgHelper.NONE_LABEL_VALUE
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service'
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test missing fields
mockIngress = {}
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
})
})
@@ -1,229 +1,120 @@
import { Kubectl } from "../../types/kubectl"; import * as core from '@actions/core'
import * as fileHelper from "../../utilities/fileUtils"; import {K8sIngress} from '../../types/k8sObject'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests, GREEN_LABEL_VALUE,
createWorkloadsWithLabel, fetchResource
deleteWorkloadsAndServicesWithLabel, } from './blueGreenHelper'
fetchResource, import {Kubectl} from '../../types/kubectl'
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
import * as core from "@actions/core";
const BACKEND = "BACKEND"; const BACKEND = 'backend'
export async function deployBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create new services and other objects
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function promoteBlueGreenIngress(
kubectl: Kubectl,
manifestObjects
) {
//checking if anything to promote
if (
!validateIngressesState(
kubectl,
manifestObjects.ingressEntityList,
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
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route ingress to stables services
await routeBlueGreenIngress(
kubectl,
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
// delete green services and deployments
await deleteWorkloadsAndServicesWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
);
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
nextLabel: string,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
) {
let newObjectsList = [];
if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
);
} else {
ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
inputObject,
serviceNameMap,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenIngressObject);
} else {
newObjectsList.push(inputObject);
}
});
}
core.debug("New objects: " + JSON.stringify(newObjectsList));
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
export function validateIngressesState(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): boolean {
let areIngressesTargetingNewServices: boolean = true;
ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
);
if (!!existingIngress) {
const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL];
// if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false;
} else {
// no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false;
}
}
});
return areIngressesTargetingNewServices;
}
function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false;
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
if (key === "serviceName" && serviceNameMap.has(value)) {
isIngressRouted = true;
}
return value;
});
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 { ): K8sIngress {
if (!type) { const newObject = JSON.parse(JSON.stringify(inputObject))
return inputObject; // add green labels and values
} addBlueGreenLabelsAndAnnotations(newObject, type)
const newObject = JSON.parse(JSON.stringify(inputObject)); // update ingress labels
// add green labels and values if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') {
addBlueGreenLabelsAndAnnotations(newObject, type); return updateIngressBackendBetaV1(newObject, serviceNameMap)
}
return updateIngressBackend(newObject, serviceNameMap)
}
// update ingress labels export function updateIngressBackendBetaV1(
return updateIngressBackend(newObject, serviceNameMap); inputObject: any,
serviceNameMap: Map<string, string>
): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if (key.toLowerCase() === BACKEND) {
const {serviceName} = value
if (serviceNameMap.has(serviceName)) {
// update service name with corresponding bluegreen name only if service is provied in given manifests
value.serviceName = serviceNameMap.get(serviceName)
}
}
return value
})
return inputObject
} }
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 (
const { serviceName } = value; key.toLowerCase() === BACKEND &&
if (serviceNameMap.has(serviceName)) { serviceNameMap.has(value.service.name)
// update service name with corresponding bluegreen name only if service is provied in given manifests ) {
value.serviceName = serviceNameMap.get(serviceName); value.service.name = serviceNameMap.get(value.service.name)
} }
} return value
})
return value; return inputObject
}); }
return inputObject; export function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
isIngressRouted =
isIngressRouted ||
(key === 'service' &&
value.hasOwnProperty('name') &&
serviceNameMap.has(value.name))
isIngressRouted =
isIngressRouted || (key === 'serviceName' && serviceNameMap.has(value))
return value
})
return isIngressRouted
}
export async function validateIngresses(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): Promise<{areValid: boolean; invalidIngresses: string[]}> {
let areValid: boolean = true
const invalidIngresses = []
for (const inputObject of ingressEntityList) {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
)
const isValid =
!!existingIngress &&
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL] ===
GREEN_LABEL_VALUE
if (!isValid) {
core.debug(
`Invalid ingress detected (must be in green state): ${JSON.stringify(
inputObject
)}`
)
invalidIngresses.push(inputObject.metadata.name)
}
// to be valid, ingress should exist and should be green
areValid = areValid && isValid
}
}
return {areValid, invalidIngresses}
} }
@@ -0,0 +1,158 @@
import * as core from '@actions/core'
import {getManifestObjects} from './blueGreenHelper'
import {
promoteBlueGreenIngress,
promoteBlueGreenService,
promoteBlueGreenSMI
} from './promote'
import {TrafficSplitObject} from '../../types/k8sObject'
import * as servicesTester from './serviceBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {MAX_VAL, MIN_VAL, TRAFFIC_SPLIT_OBJECT} from './smiBlueGreenHelper'
import * as smiTester from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('promote tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('promote blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
const value = await promoteBlueGreenIngress(kubectl, testObjects)
const objects = value.objects
expect(objects).toHaveLength(2)
for (const obj of objects) {
if (obj.kind === 'Service') {
expect(obj.metadata.name).toBe('nginx-service')
} else if (obj.kind == 'Deployment') {
expect(obj.metadata.name).toBe('nginx-deployment')
}
expect(obj.metadata.labels['k8s.deploy.color']).toBe('None')
}
})
test('fail to promote invalid blue/green ingress', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Ingress',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
await expect(
promoteBlueGreenIngress(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockLabels},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
let value = await promoteBlueGreenService(kubectl, testObjects)
expect(value.objects).toHaveLength(1)
expect(
value.objects[0].metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL]
).toBe(bgHelper.NONE_LABEL_VALUE)
expect(value.objects[0].metadata.name).toBe('nginx-deployment')
})
test('fail to promote invalid blue/green service', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {},
metadata: {labels: mockLabels, name: 'nginx-ingress-green'}
})
)
jest
.spyOn(servicesTester, 'validateServicesState')
.mockImplementationOnce(() => Promise.resolve(false))
await expect(
promoteBlueGreenService(kubectl, testObjects)
).rejects.toThrowError()
})
test('promote blue/green SMI', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
const deployResult = await promoteBlueGreenSMI(kubectl, testObjects)
expect(deployResult.objects).toHaveLength(1)
expect(deployResult.objects[0].metadata.name).toBe('nginx-deployment')
expect(
deployResult.objects[0].metadata.labels[
bgHelper.BLUE_GREEN_VERSION_LABEL
]
).toBe(bgHelper.NONE_LABEL_VALUE)
})
test('promote blue/green SMI with bad trafficsplit', async () => {
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = bgHelper.NONE_LABEL_VALUE
jest
.spyOn(smiTester, 'validateTrafficSplitsState')
.mockImplementation(() => Promise.resolve(false))
expect(promoteBlueGreenSMI(kubectl, testObjects)).rejects.toThrowError()
})
})
+81
View File
@@ -0,0 +1,81 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {deployWithLabel, NONE_LABEL_VALUE} from './blueGreenHelper'
import {validateIngresses} from './ingressBlueGreenHelper'
import {validateServicesState} from './serviceBlueGreenHelper'
import {validateTrafficSplitsState} from './smiBlueGreenHelper'
export async function promoteBlueGreenIngress(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
//checking if anything to promote
const {areValid, invalidIngresses} = await validateIngresses(
kubectl,
manifestObjects.ingressEntityList,
manifestObjects.serviceNameMap
)
if (!areValid) {
throw new Error(
`Ingresses are not in promote state: ${invalidIngresses.toString()}`
)
}
// create stable deployments with new configuration
const result: BlueGreenDeployment = await deployWithLabel(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
),
NONE_LABEL_VALUE
)
// create stable services with new configuration
return result
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw new Error('Found services not in promote state')
}
// creating stable deployments with new configurations
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
export async function promoteBlueGreenSMI(
kubectl: Kubectl,
manifestObjects
): Promise<BlueGreenDeployment> {
// checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl,
manifestObjects.serviceEntityList
))
) {
throw Error('Not in promote state SMI')
}
// create stable deployments with new configuration
return await deployWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
)
}
@@ -0,0 +1,66 @@
import {getManifestObjects} from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {BlueGreenRejectResult} from '../../types/blueGreenTypes'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {
rejectBlueGreenIngress,
rejectBlueGreenService,
rejectBlueGreenSMI
} from './reject'
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('reject tests', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('reject blue/green ingress', async () => {
const value = await rejectBlueGreenIngress(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(2)
for (const obj of deleteResult) {
if (obj.kind == 'Service') {
expect(obj.name).toBe('nginx-service-green')
}
if (obj.kind == 'Deployment') {
expect(obj.name).toBe('nginx-deployment-green')
}
}
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-ingress')
})
test('reject blue/green service', async () => {
const value = await rejectBlueGreenService(kubectl, testObjects)
const bgDeployment = value.routeResult
const deleteResult = value.deleteResult
expect(deleteResult).toHaveLength(1)
expect(deleteResult[0].name).toBe('nginx-deployment-green')
expect(bgDeployment.objects).toHaveLength(1)
expect(bgDeployment.objects[0].metadata.name).toBe('nginx-service')
})
test('reject blue/green SMI', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const rejectResult = await rejectBlueGreenSMI(kubectl, testObjects)
expect(rejectResult.deleteResult).toHaveLength(4)
})
})
+81
View File
@@ -0,0 +1,81 @@
import {K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests,
BlueGreenRejectResult
} from '../../types/blueGreenTypes'
import {deleteGreenObjects, NONE_LABEL_VALUE} from './blueGreenHelper'
import {routeBlueGreenSMI} from './route'
import {cleanupSMI} from './smiBlueGreenHelper'
import {routeBlueGreenIngressUnchanged, routeBlueGreenService} from './route'
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// get all kubernetes objects defined in manifest files
// route ingress to stables services
const routeResult = await routeBlueGreenIngressUnchanged(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
// delete green services and deployments
const deleteResult = await deleteGreenObjects(
kubectl,
[].concat(
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
)
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route to stable objects
const routeResult = await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete new deployments with green suffix
const deleteResult = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
return {routeResult, deleteResult}
}
export async function rejectBlueGreenSMI(
kubectl: Kubectl,
manifestObjects: BlueGreenManifests
): Promise<BlueGreenRejectResult> {
// route trafficsplit to stable deployments
const routeResult = await routeBlueGreenSMI(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
)
// delete rejected new bluegreen deployments
const deletedObjects = await deleteGreenObjects(
kubectl,
manifestObjects.deploymentEntityList
)
// delete trafficsplit and extra services
const cleanupResult = await cleanupSMI(
kubectl,
manifestObjects.serviceEntityList
)
return {routeResult, deleteResult: [].concat(deletedObjects, cleanupResult)}
}
+119
View File
@@ -0,0 +1,119 @@
import * as core from '@actions/core'
import {K8sIngress, TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {getBufferTime} from '../../inputUtils'
import * as inputUtils from '../../inputUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import {
routeBlueGreenIngress,
routeBlueGreenService,
routeBlueGreenForDeploy
} from './route'
jest.mock('../../types/kubectl')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kc = new Kubectl('')
describe('route function tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('correctly prepares blue/green ingresses for deployment', async () => {
const unroutedIngCopy: K8sIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
unroutedIngCopy.metadata.name = 'nginx-ingress-unrouted'
unroutedIngCopy.spec.rules[0].http.paths[0].backend.service.name =
'fake-service'
testObjects.ingressEntityList.push(unroutedIngCopy)
const value = await routeBlueGreenIngress(
kc,
testObjects.serviceNameMap,
testObjects.ingressEntityList
)
expect(value.objects).toHaveLength(2)
expect(value.objects[0].metadata.name).toBe('nginx-ingress')
expect(
(value.objects[0] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('nginx-service-green')
expect(value.objects[1].metadata.name).toBe('nginx-ingress-unrouted')
// unrouted services shouldn't get their service name changed
expect(
(value.objects[1] as K8sIngress).spec.rules[0].http.paths[0].backend
.service.name
).toBe('fake-service')
})
test('correctly prepares blue/green services for deployment', async () => {
const value = await routeBlueGreenService(
kc,
GREEN_LABEL_VALUE,
testObjects.serviceEntityList
)
expect(value.objects).toHaveLength(1)
expect(value.objects[0].metadata.name).toBe('nginx-service')
expect(value.objects[0].metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('correctly identifies route pattern and acts accordingly', async () => {
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve('v1alpha3'))
const ingressResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.INGRESS
)
expect(ingressResult.objects.length).toBe(1)
expect(ingressResult.objects[0].metadata.name).toBe('nginx-ingress')
const serviceResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SERVICE
)
expect(serviceResult.objects.length).toBe(1)
expect(serviceResult.objects[0].metadata.name).toBe('nginx-service')
const smiResult = await routeBlueGreenForDeploy(
kc,
ingressFilepath,
RouteStrategy.SMI
)
expect(smiResult.objects).toHaveLength(1)
expect(smiResult.objects[0].metadata.name).toBe(
'nginx-service-trafficsplit'
)
expect(
(smiResult.objects as TrafficSplitObject[])[0].spec.backends
).toHaveLength(2)
})
})
+141
View File
@@ -0,0 +1,141 @@
import {sleep} from '../../utilities/timeUtils'
import {RouteStrategy} from '../../types/routeStrategy'
import {Kubectl} from '../../types/kubectl'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import {
getManifestObjects,
GREEN_LABEL_VALUE,
deployObjects
} from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted
} from './ingressBlueGreenHelper'
import {getUpdatedBlueGreenService} from './serviceBlueGreenHelper'
import {createTrafficSplitObject} from './smiBlueGreenHelper'
import * as core from '@actions/core'
import {K8sObject, TrafficSplitObject} from '../../types/k8sObject'
import {getBufferTime} from '../../inputUtils'
export async function routeBlueGreenForDeploy(
kubectl: Kubectl,
inputManifestFiles: string[],
routeStrategy: RouteStrategy
): Promise<BlueGreenDeployment> {
// sleep for buffer time
const bufferTime: number = getBufferTime()
const startSleepDate = new Date()
core.info(
`Starting buffer time of ${bufferTime} minute(s) at ${startSleepDate.toISOString()}`
)
await sleep(bufferTime * 1000 * 60)
const endSleepDate = new Date()
core.info(
`Stopping buffer time of ${bufferTime} minute(s) at ${endSleepDate.toISOString()}`
)
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles)
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
return await routeBlueGreenIngress(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
} else if (routeStrategy == RouteStrategy.SMI) {
return await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
} else {
return await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
)
}
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
// const newObjectsList = []
const newObjectsList: K8sObject[] = ingressEntityList.map((obj) => {
if (isIngressRouted(obj, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
obj,
serviceNameMap,
GREEN_LABEL_VALUE
)
return newBlueGreenIngressObject
} else {
core.debug(`unrouted ingress detected ${obj.metadata.name}`)
return obj
}
})
const deployResult = await deployObjects(kubectl, newObjectsList)
return {deployResult, objects: newObjectsList}
}
export async function routeBlueGreenIngressUnchanged(
kubectl: Kubectl,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
const objects = serviceEntityList.map((serviceObject) =>
getUpdatedBlueGreenService(serviceObject, nextLabel)
)
const deployResult = await deployObjects(kubectl, objects)
return {deployResult, objects}
}
export async function routeBlueGreenSMI(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
// let tsObjects: TrafficSplitObject[] = []
const tsObjects: TrafficSplitObject[] = await Promise.all(
serviceEntityList.map(async (serviceObject) => {
const tsObject: TrafficSplitObject = await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
)
return tsObject
})
)
const deployResult = await deployObjects(kubectl, tsObjects)
return {deployResult, objects: tsObjects}
}
@@ -0,0 +1,65 @@
import * as core from '@actions/core'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {
getServiceSpecLabel,
getUpdatedBlueGreenService,
validateServicesState
} from './serviceBlueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('blue/green service helper tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('getUpdatedBlueGreenService', () => {
const newService = getUpdatedBlueGreenService(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(newService.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
expect(newService.spec.selector[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateServicesState', async () => {
const mockLabels = new Map<string, string>()
mockLabels[BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
const mockSelectors = new Map<string, string>()
mockSelectors[BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockSelectors},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
expect(
await validateServicesState(kubectl, testObjects.serviceEntityList)
).toBe(true)
})
test('getServiceSpecLabel', () => {
testObjects.serviceEntityList[0].spec.selector[BLUE_GREEN_VERSION_LABEL] =
GREEN_LABEL_VALUE
expect(getServiceSpecLabel(testObjects.serviceEntityList[0])).toBe(
GREEN_LABEL_VALUE
)
})
})
@@ -1,146 +1,49 @@
import { Kubectl } from "../../types/kubectl"; import * as core from '@actions/core'
import * as fileHelper from "../../utilities/fileUtils"; import {K8sServiceObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
BlueGreenManifests, fetchResource,
createWorkloadsWithLabel, GREEN_LABEL_VALUE
deleteWorkloadsWithLabel, } from './blueGreenHelper'
fetchResource,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create other non deployment and non service entities
const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
if (manifestFiles.length > 0) await kubectl.apply(manifestFiles);
// returning deployment details to check for rollout stability
return result;
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
) {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw "Not inP promote state";
}
// creating stable deployments with new configurations
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route to stable objects
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
);
// delete new deployments with green suffix
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
) {
const newObjectsList = [];
serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject,
nextLabel
);
newObjectsList.push(newBlueGreenServiceObject);
});
// configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
// add green labels to configure existing service // add green labels to configure existing service
function getUpdatedBlueGreenService( export function getUpdatedBlueGreenService(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): object { ): K8sServiceObject {
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) { let isServiceGreen =
const currentLabel: string = getServiceSpecLabel(existingService); !!existingService &&
if (currentLabel != GREEN_LABEL_VALUE) { getServiceSpecLabel(existingService as K8sServiceObject) ==
// service should be targeting deployments with green label GREEN_LABEL_VALUE
areServicesGreen = false; areServicesGreen = areServicesGreen && isServiceGreen
} }
} else {
// service targeting deployment doesn't exist
areServicesGreen = false;
}
}
return areServicesGreen; return areServicesGreen
} }
export function getServiceSpecLabel(inputObject: any): string { export function getServiceSpecLabel(inputObject: K8sServiceObject): string {
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 "";
} }
@@ -0,0 +1,203 @@
import * as core from '@actions/core'
import {TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
import {
cleanupSMI,
createTrafficSplitObject,
getGreenSMIServiceResource,
getStableSMIServiceResource,
MAX_VAL,
MIN_VAL,
setupSMI,
TRAFFIC_SPLIT_OBJECT,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX,
validateTrafficSplitsState
} from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
jest.mock('../../types/kubectl')
const kc = new Kubectl('')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
describe('SMI Helper tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve(''))
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('setupSMI tests', async () => {
const smiResults = await setupSMI(kc, testObjects.serviceEntityList)
let found = 0
for (const obj of smiResults.objects) {
if (obj.metadata.name === 'nginx-service-stable') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(obj.spec.selector.app).toBe('nginx')
found++
}
if (obj.metadata.name === 'nginx-service-green') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
found++
}
if (obj.metadata.name === 'nginx-service-trafficsplit') {
found++
// expect stable weight to be max val
const casted = obj as TrafficSplitObject
expect(casted.spec.backends).toHaveLength(2)
for (const be of casted.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
}
}
expect(found).toBe(3)
})
test('createTrafficSplitObject tests', async () => {
const noneTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
NONE_LABEL_VALUE
)
expect(noneTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (let be of noneTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
const greenTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
GREEN_LABEL_VALUE
)
expect(greenTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (const be of greenTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MIN_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MAX_VAL)
}
}
})
test('getSMIServiceResource test', () => {
const stableResult = getStableSMIServiceResource(
testObjects.serviceEntityList[0]
)
const greenResult = getGreenSMIServiceResource(
testObjects.serviceEntityList[0]
)
expect(stableResult.metadata.name).toBe('nginx-service-stable')
expect(stableResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(greenResult.metadata.name).toBe('nginx-service-green')
expect(greenResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateTrafficSplitsState', async () => {
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
let valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(true)
const mockTsCopy = JSON.parse(JSON.stringify(mockTsObject))
mockTsCopy.spec.backends[0].weight = MAX_VAL
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsCopy))
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
})
test('cleanupSMI test', async () => {
const deleteObjects = await cleanupSMI(kc, testObjects.serviceEntityList)
expect(deleteObjects).toHaveLength(3)
expect(deleteObjects[0].name).toBe('nginx-service-trafficsplit')
expect(deleteObjects[1].name).toBe('nginx-service-green')
expect(deleteObjects[1].kind).toBe('Service')
expect(deleteObjects[2].name).toBe('nginx-service-stable')
expect(deleteObjects[2].kind).toBe('Service')
})
})
@@ -1,272 +1,210 @@
import { Kubectl } from "../../types/kubectl"; import * as core from '@actions/core'
import * as kubectlUtils from "../../utilities/trafficSplitUtils"; import {Kubectl} from '../../types/kubectl'
import * as fileHelper from "../../utilities/fileUtils"; import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import { import {
BlueGreenManifests, deleteObjects,
createWorkloadsWithLabel, deployObjects,
deleteObjects, fetchResource,
deleteWorkloadsWithLabel, getBlueGreenResourceName,
fetchResource, getNewBlueGreenObject,
getBlueGreenResourceName, GREEN_LABEL_VALUE,
getManifestObjects, GREEN_SUFFIX,
getNewBlueGreenObject, NONE_LABEL_VALUE,
GREEN_LABEL_VALUE, STABLE_SUFFIX
GREEN_SUFFIX, } from './blueGreenHelper'
NONE_LABEL_VALUE, import {BlueGreenDeployment} from '../../types/blueGreenTypes'
STABLE_SUFFIX, import {
} from "./blueGreenHelper"; K8sDeleteObject,
K8sObject,
TrafficSplitObject
} from '../../types/k8sObject'
import {DeployResult} from '../../types/deployResult'
import {inputAnnotations} from '../../inputUtils'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit"; export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit'
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit"; export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
const MIN_VAL = 0; export const MIN_VAL = 0
const MAX_VAL = 100; export const MAX_VAL = 100
export async function deployBlueGreenSMI( export async function setupSMI(
kubectl: Kubectl, kubectl: Kubectl,
filePaths: string[] serviceEntityList: any[]
) { ): Promise<BlueGreenDeployment> {
// get all kubernetes objects defined in manifest files const newObjectsList = []
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths); const trafficObjectList = []
// create services and other objects serviceEntityList.forEach((serviceObject) => {
const newObjectsList = manifestObjects.otherObjects // create a trafficsplit for service
.concat(manifestObjects.serviceEntityList) trafficObjectList.push(serviceObject)
.concat(manifestObjects.ingressEntityList) // set up the services for trafficsplit
.concat(manifestObjects.unroutedServiceEntityList); const newStableService = getStableSMIServiceResource(serviceObject)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); const newGreenService = getGreenSMIServiceResource(serviceObject)
await kubectl.apply(manifestFiles); newObjectsList.push(newStableService)
newObjectsList.push(newGreenService)
})
// make extraservices and trafficsplit const tsObjects: TrafficSplitObject[] = []
await setupSMI(kubectl, manifestObjects.serviceEntityList); // route to stable service
for (const svc of trafficObjectList) {
const tsObject = await createTrafficSplitObject(
kubectl,
svc.metadata.name,
NONE_LABEL_VALUE
)
tsObjects.push(tsObject as TrafficSplitObject)
}
// create new deloyments const objectsToDeploy = [].concat(newObjectsList, tsObjects)
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
}
export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) { // create services
// checking if there is something to promote const smiDeploymentResult: DeployResult = await deployObjects(
if (
!(await validateTrafficSplitsState(
kubectl, kubectl,
manifestObjects.serviceEntityList objectsToDeploy
)) )
) {
throw Error("Not in promote state SMI");
}
// create stable deployments with new configuration return {
return await createWorkloadsWithLabel( objects: objectsToDeploy,
kubectl, deployResult: smiDeploymentResult
manifestObjects.deploymentEntityList, }
NONE_LABEL_VALUE
);
} }
export async function rejectBlueGreenSMI( let trafficSplitAPIVersion = ''
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route trafficsplit to stable deploymetns export async function createTrafficSplitObject(
await routeBlueGreenSMI( kubectl: Kubectl,
kubectl, name: string,
NONE_LABEL_VALUE, nextLabel: string
manifestObjects.serviceEntityList ): Promise<TrafficSplitObject> {
); // cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
// delete rejected new bluegreen deployments // retrieve annotations for TS object
await deleteWorkloadsWithLabel( const annotations = inputAnnotations
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
// delete trafficsplit and extra services // decide weights based on nextlabel
await cleanupSMI(kubectl, manifestObjects.serviceEntityList); const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL
const trafficSplitObject: TrafficSplitObject = {
apiVersion: trafficSplitAPIVersion,
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
annotations: annotations,
labels: new Map<string, string>()
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight
}
]
}
}
return trafficSplitObject
} }
export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) { export function getStableSMIServiceResource(inputObject: K8sObject): K8sObject {
const newObjectsList = []; const newObject = JSON.parse(JSON.stringify(inputObject))
const trafficObjectList = []; // adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName(
serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service
trafficObjectList.push(serviceObject);
// set up the services for trafficsplit
const newStableService = getSMIServiceResource(
serviceObject,
STABLE_SUFFIX
);
const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX);
newObjectsList.push(newStableService);
newObjectsList.push(newGreenService);
});
// create services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// route to stable service
trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject(
kubectl,
inputObject.metadata.name,
NONE_LABEL_VALUE
);
});
}
let trafficSplitAPIVersion = "";
async function createTrafficSplitObject(
kubectl: Kubectl,
name: string,
nextLabel: string
): Promise<any> {
// cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
);
// decide weights based on nextlabel
const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL;
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL;
const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: "TrafficSplit",
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight,
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight,
},
],
},
});
// create traffic split object
const trafficSplitManifestFile = fileHelper.writeManifestToFile(
trafficSplitObject,
TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
);
await kubectl.apply(trafficSplitManifestFile);
}
export function getSMIServiceResource(
inputObject: any,
suffix: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject));
if (suffix === STABLE_SUFFIX) {
// adding stable suffix to service name
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 {
// green label will be added for these
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE);
}
} }
export async function routeBlueGreenSMI( export function getGreenSMIServiceResource(inputObject: K8sObject): K8sObject {
kubectl: Kubectl, const newObject = JSON.parse(JSON.stringify(inputObject))
nextLabel: string, return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE)
serviceEntityList: any[]
) {
for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label
await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
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)
); )
core.debug(
if (!trafficSplitObject) { `ts object extracted was ${JSON.stringify(trafficSplitObject)}`
// no traffic split exits )
trafficSplitsInRightState = false; if (!trafficSplitObject) {
} core.debug(`no traffic split exits for ${name}`)
trafficSplitsInRightState = false
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject)); continue
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.spec.backends.forEach((element) => {
if (element.weight != MIN_VAL) trafficSplitsInRightState = false; // checking if trafficsplit in right state to deploy
} if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
}); trafficSplitsInRightState =
} trafficSplitsInRightState && element.weight == MAX_VAL
}
return trafficSplitsInRightState; if (
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MIN_VAL
}
})
}
return trafficSplitsInRightState
} }
export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) { export async function cleanupSMI(
const deleteList = []; kubectl: Kubectl,
serviceEntityList: any[]
): Promise<K8sDeleteObject[]> {
const deleteList: K8sDeleteObject[] = []
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)
return deleteList
} }
+222 -196
View File
@@ -1,196 +1,222 @@
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 {ExecOutput} from '@actions/exec'
isDeploymentEntity, import {
isServiceEntity, isDeploymentEntity,
KubernetesWorkload, isServiceEntity,
} from "../../types/kubernetesTypes"; KubernetesWorkload
import * as utils from "../../utilities/manifestUpdateUtils"; } from '../../types/kubernetesTypes'
import { import * as utils from '../../utilities/manifestUpdateUtils'
updateObjectAnnotations, import {
updateObjectLabels, updateObjectAnnotations,
updateSelectorLabels, updateObjectLabels,
} from "../../utilities/manifestUpdateUtils"; updateSelectorLabels
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils"; } from '../../utilities/manifestUpdateUtils'
import { checkForErrors } from "../../utilities/kubectlUtils"; import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
export const CANARY_VERSION_LABEL = "workflow/version";
const BASELINE_SUFFIX = "-baseline"; export const CANARY_VERSION_LABEL = 'workflow/version'
export const BASELINE_LABEL_VALUE = "baseline"; const BASELINE_SUFFIX = '-baseline'
const CANARY_SUFFIX = "-canary"; export const BASELINE_LABEL_VALUE = 'baseline'
export const CANARY_LABEL_VALUE = "canary"; const CANARY_SUFFIX = '-canary'
export const STABLE_SUFFIX = "-stable"; export const CANARY_LABEL_VALUE = 'canary'
export const STABLE_LABEL_VALUE = "stable"; export const STABLE_SUFFIX = '-stable'
export const STABLE_LABEL_VALUE = 'stable'
export async function deleteCanaryDeployment(
kubectl: Kubectl, export async function deleteCanaryDeployment(
manifestFilePaths: string[], kubectl: Kubectl,
includeServices: boolean manifestFilePaths: string[],
) { includeServices: boolean
if (manifestFilePaths == null || manifestFilePaths.length == 0) { ) {
throw new Error("Manifest file not found"); if (manifestFilePaths == null || manifestFilePaths.length == 0) {
} throw new Error('Manifest files for deleting canary deployment not found')
}
await cleanUpCanary(kubectl, manifestFilePaths, includeServices);
} await cleanUpCanary(kubectl, manifestFilePaths, includeServices)
}
export function markResourceAsStable(inputObject: any): object {
if (isResourceMarkedAsStable(inputObject)) { export function markResourceAsStable(inputObject: any): object {
return inputObject; if (isResourceMarkedAsStable(inputObject)) {
} return inputObject
}
const newObject = JSON.parse(JSON.stringify(inputObject));
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE); const newObject = JSON.parse(JSON.stringify(inputObject))
return newObject; addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE)
} return newObject
}
export function isResourceMarkedAsStable(inputObject: any): boolean {
return ( export function isResourceMarkedAsStable(inputObject: any): boolean {
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE return (
); inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
} )
}
export function getStableResource(inputObject: any): object {
const replicaCount = specContainsReplicas(inputObject.kind) export function getStableResource(inputObject: any): object {
? inputObject.metadata.replicas const replicaCount = specContainsReplicas(inputObject.kind)
: 0; ? inputObject.spec.replicas
: 0
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
} return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE)
}
export function getNewBaselineResource(
stableObject: any, export function getNewBaselineResource(
replicas?: number stableObject: any,
): object { replicas?: number
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE); ): object {
} return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE)
}
export function getNewCanaryResource(
inputObject: any, export function getNewCanaryResource(
replicas?: number inputObject: any,
): object { replicas?: number
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE); ): object {
} return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE)
}
export async function fetchResource(
kubectl: Kubectl, export async function fetchResource(
kind: string, kubectl: Kubectl,
name: string kind: string,
) { name: string
const result = await kubectl.getResource(kind, name); ) {
let result: ExecOutput
if (!result || result?.stderr) { try {
return null; result = await kubectl.getResource(kind, name)
} } catch (e) {
core.debug(`detected error while fetching resources: ${e}`)
if (result.stdout) { }
const resource = JSON.parse(result.stdout);
if (!result || result?.stderr) {
try { return null
utils.UnsetClusterSpecificDetails(resource); }
return resource;
} catch (ex) { if (result.stdout) {
core.debug( const resource = JSON.parse(result.stdout)
`Exception occurred while Parsing ${resource} in JSON object: ${ex}`
); try {
} utils.UnsetClusterSpecificDetails(resource)
} return resource
} } catch (ex) {
core.debug(
export function getCanaryResourceName(name: string) { `Exception occurred while parsing ${resource} in JSON object: ${ex}`
return name + CANARY_SUFFIX; )
} }
}
export function getBaselineResourceName(name: string) { }
return name + BASELINE_SUFFIX;
} export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX
export function getStableResourceName(name: string) { }
return name + STABLE_SUFFIX;
} export function getBaselineResourceName(name: string) {
return name + BASELINE_SUFFIX
function getNewCanaryObject( }
inputObject: any,
replicas: number, export function getStableResourceName(name: string) {
type: string return name + STABLE_SUFFIX
): object { }
const newObject = JSON.parse(JSON.stringify(inputObject));
export function getBaselineDeploymentFromStableDeployment(
// Updating name inputObject: any,
if (type === CANARY_LABEL_VALUE) { replicaCount: number
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name); ): object {
} else if (type === STABLE_LABEL_VALUE) { // TODO: REFACTOR TO MAKE EVERYTHING TYPE SAFE
newObject.metadata.name = getStableResourceName(inputObject.metadata.name); const oldName = inputObject.metadata.name
} else { const newName =
newObject.metadata.name = getBaselineResourceName( oldName.substring(0, oldName.length - STABLE_SUFFIX.length) +
inputObject.metadata.name BASELINE_SUFFIX
);
} const newObject = getNewCanaryObject(
inputObject,
addCanaryLabelsAndAnnotations(newObject, type); replicaCount,
BASELINE_LABEL_VALUE
if (specContainsReplicas(newObject.kind)) { ) as any
newObject.spec.replicas = replicas; newObject.metadata.name = newName
}
return newObject
return newObject; }
}
function getNewCanaryObject(
function specContainsReplicas(kind: string) { inputObject: any,
return ( replicas: number,
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && type: string
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() && ): object {
!isServiceEntity(kind) const newObject = JSON.parse(JSON.stringify(inputObject))
);
} // Updating name
if (type === CANARY_LABEL_VALUE) {
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) { newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name)
const newLabels = new Map<string, string>(); } else if (type === STABLE_LABEL_VALUE) {
newLabels[CANARY_VERSION_LABEL] = type; newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
} else {
updateObjectLabels(inputObject, newLabels, false); newObject.metadata.name = getBaselineResourceName(
updateObjectAnnotations(inputObject, newLabels, false); inputObject.metadata.name
updateSelectorLabels(inputObject, newLabels, false); )
}
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false); addCanaryLabelsAndAnnotations(newObject, type)
}
} if (specContainsReplicas(newObject.kind)) {
newObject.spec.replicas = replicas
async function cleanUpCanary( }
kubectl: Kubectl,
files: string[], return newObject
includeServices: boolean }
) {
const deleteObject = async function (kind, name) { function specContainsReplicas(kind: string) {
try { return (
const result = await kubectl.delete([kind, name]); kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
checkForErrors([result]); kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
} catch (ex) { !isServiceEntity(kind)
// Ignore failures of delete if it doesn't exist )
} }
};
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
for (const filePath of files) { const newLabels = new Map<string, string>()
const fileContents = fs.readFileSync(filePath).toString(); newLabels[CANARY_VERSION_LABEL] = type
const parsedYaml = yaml.safeLoadAll(fileContents); updateObjectLabels(inputObject, newLabels, false)
for (const inputObject of parsedYaml) { updateObjectAnnotations(inputObject, newLabels, false)
const name = inputObject.metadata.name; updateSelectorLabels(inputObject, newLabels, false)
const kind = inputObject.kind;
if (!isServiceEntity(inputObject.kind)) {
if ( updateSpecLabels(inputObject, newLabels, false)
isDeploymentEntity(kind) || }
(includeServices && isServiceEntity(kind)) }
) {
const canaryObjectName = getCanaryResourceName(name); async function cleanUpCanary(
const baselineObjectName = getBaselineResourceName(name); kubectl: Kubectl,
files: string[],
await deleteObject(kind, canaryObjectName); includeServices: boolean
await deleteObject(kind, baselineObjectName); ) {
} const deleteObject = async function (kind, name) {
} try {
} const result = await kubectl.delete([kind, name])
} checkForErrors([result])
} catch (ex) {
// 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)
}
}
}
}
+84 -90
View File
@@ -1,90 +1,84 @@
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(
const newObjectsList = []; filePaths: string[],
const percentage = parseInt(core.getInput("percentage")); kubectl: Kubectl,
onlyDeployStable: boolean = false
if (percentage < 0 || percentage > 100) ) {
throw Error("Percentage must be between 0 and 100"); const newObjectsList = []
const percentage = parseInt(core.getInput('percentage', {required: true}))
for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString(); if (percentage < 0 || percentage > 100)
const parsedYaml = yaml.safeLoadAll(fileContents); throw Error('Percentage must be between 0 and 100')
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name; for (const filePath of filePaths) {
const kind = inputObject.kind; const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
if (isDeploymentEntity(kind)) { for (const inputObject of parsedYaml) {
core.debug("Calculating replica count for canary"); const name = inputObject.metadata.name
const canaryReplicaCount = calculateReplicaCountForCanary( const kind = inputObject.kind
inputObject,
percentage if (!onlyDeployStable && isDeploymentEntity(kind)) {
); core.debug('Calculating replica count for canary')
core.debug("Replica count is " + canaryReplicaCount); const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject,
// Get stable object percentage
core.debug("Querying stable object"); )
const stableObject = await canaryDeploymentHelper.fetchResource( core.debug('Replica count is ' + canaryReplicaCount)
kubectl,
kind, const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
name inputObject,
); canaryReplicaCount
)
if (!stableObject) { newObjectsList.push(newCanaryObject)
core.debug("Stable object not found. Creating canary object");
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( // if there's already a stable object, deploy baseline as well
inputObject, const stableObject = await canaryDeploymentHelper.fetchResource(
canaryReplicaCount kubectl,
); kind,
newObjectsList.push(newCanaryObject); name
} else { )
core.debug( if (stableObject) {
"Creating canary and baseline objects. Stable object found: " + core.debug(
JSON.stringify(stableObject) `Stable object found for ${kind} ${name}. Creating baseline objects`
); )
const newBaselineObject =
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( canaryDeploymentHelper.getNewBaselineResource(
inputObject, stableObject,
canaryReplicaCount canaryReplicaCount
); )
core.debug("New canary object: " + JSON.stringify(newCanaryObject)); core.debug(
'New baseline object: ' + JSON.stringify(newBaselineObject)
const newBaselineObject = )
canaryDeploymentHelper.getNewBaselineResource( newObjectsList.push(newBaselineObject)
stableObject, }
canaryReplicaCount } else {
); // deploy non deployment entity or regular deployments for promote as they are
core.debug( newObjectsList.push(inputObject)
"New baseline object: " + JSON.stringify(newBaselineObject) }
); }
}
newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject); core.debug('New objects list: ' + JSON.stringify(newObjectsList))
} const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
} else { const forceDeployment = core.getInput('force').toLowerCase() === 'true'
// update non deployment entity as it is
newObjectsList.push(inputObject); const result = await kubectl.apply(manifestFiles, forceDeployment)
} return {result, newFilePaths: manifestFiles}
} }
}
export function calculateReplicaCountForCanary(
core.debug("New objects list: " + JSON.stringify(newObjectsList)); inputObject: any,
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); percentage: number
const forceDeployment = core.getInput("force").toLowerCase() === "true"; ) {
const inputReplicaCount = getReplicaCount(inputObject)
const result = await kubectl.apply(manifestFiles, forceDeployment); return Math.max(1, Math.round((inputReplicaCount * percentage) / 100))
return { result, newFilePaths: manifestFiles }; }
}
function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
const inputReplicaCount = getReplicaCount(inputObject);
return Math.round((inputReplicaCount * percentage) / 100);
}
+351 -319
View File
@@ -1,319 +1,351 @@
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 * as podCanaryHelper from './podCanaryHelper'
isDeploymentEntity, import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
isServiceEntity, import {checkForErrors} from '../../utilities/kubectlUtils'
} from "../../types/kubernetesTypes"; import {inputAnnotations} from '../../inputUtils'
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(
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) { filePaths: string[],
const canaryReplicaCount = parseInt( kubectl: Kubectl,
core.getInput("baseline-and-canary-replicas") onlyDeployStable: boolean = false
); ) {
if (canaryReplicaCount < 0 || canaryReplicaCount > 100) const canaryReplicasInput = core.getInput('baseline-and-canary-replicas')
throw Error("Baseline-and-canary-replicas must be between 0 and 100"); let canaryReplicaCount
let calculateReplicas = true
const newObjectsList = []; if (canaryReplicasInput !== '') {
filePaths.forEach((filePath: string) => { canaryReplicaCount = parseInt(canaryReplicasInput)
const fileContents = fs.readFileSync(filePath).toString(); calculateReplicas = false
yaml.safeLoadAll(fileContents, (inputObject) => { core.debug(
const name = inputObject.metadata.name; `read replica count ${canaryReplicaCount} from input: ${canaryReplicasInput}`
const kind = inputObject.kind; )
}
if (isDeploymentEntity(kind)) {
const stableObject = canaryDeploymentHelper.fetchResource( if (canaryReplicaCount < 0 && canaryReplicaCount > 100)
kubectl, throw Error('Baseline-and-canary-replicas must be between 0 and 100')
kind,
name const newObjectsList = []
); for await (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString()
if (!stableObject) { const inputObjects = yaml.safeLoadAll(fileContents)
core.debug("Stable object not found. Creating only canary object"); for (const inputObject of inputObjects) {
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( const name = inputObject.metadata.name
inputObject, const kind = inputObject.kind
canaryReplicaCount
); if (!onlyDeployStable && isDeploymentEntity(kind)) {
newObjectsList.push(newCanaryObject); if (calculateReplicas) {
} else { // calculate for each object
if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) { const percentage = parseInt(
throw Error(`StableSpecSelectorNotExist : ${name}`); core.getInput('percentage', {required: true})
} )
canaryReplicaCount =
core.debug( podCanaryHelper.calculateReplicaCountForCanary(
"Stable object found. Creating canary and baseline objects" inputObject,
); percentage
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( )
inputObject, core.debug(`calculated replica count ${canaryReplicaCount}`)
canaryReplicaCount }
);
const newBaselineObject = core.debug('Creating canary object')
canaryDeploymentHelper.getNewBaselineResource( const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
stableObject, inputObject,
canaryReplicaCount canaryReplicaCount
); )
newObjectsList.push(newCanaryObject); newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject);
} const stableObject = await canaryDeploymentHelper.fetchResource(
} else { kubectl,
// Update non deployment entity as it is kind,
newObjectsList.push(inputObject); canaryDeploymentHelper.getStableResourceName(name)
} )
}); if (stableObject) {
}); core.debug(
`Stable object found for ${kind} ${name}. Creating baseline objects`
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList); )
const forceDeployment = core.getInput("force").toLowerCase() === "true"; const newBaselineObject =
const result = await kubectl.apply(newFilePaths, forceDeployment); canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment(
await createCanaryService(kubectl, filePaths); stableObject,
return { result, newFilePaths }; canaryReplicaCount
} )
newObjectsList.push(newBaselineObject)
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) { }
const newObjectsList = []; } else if (isDeploymentEntity(kind)) {
const trafficObjectsList = []; core.debug(
`creating stable deployment with ${inputObject.spec.replicas} replicas`
for (const filePath of filePaths) { )
const fileContents = fs.readFileSync(filePath).toString(); const stableDeployment =
const parsedYaml = yaml.safeLoadAll(fileContents); canaryDeploymentHelper.getStableResource(inputObject)
for (const inputObject of parsedYaml) { newObjectsList.push(stableDeployment)
const name = inputObject.metadata.name; } else {
const kind = inputObject.kind; // Update non deployment entity or stable deployment as it is
newObjectsList.push(inputObject)
if (isServiceEntity(kind)) { }
const newCanaryServiceObject = }
canaryDeploymentHelper.getNewCanaryResource(inputObject); }
newObjectsList.push(newCanaryServiceObject); core.debug(
`deploying canary objects with SMI: \n ${JSON.stringify(newObjectsList)}`
const newBaselineServiceObject = )
canaryDeploymentHelper.getNewBaselineResource(inputObject); const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList)
newObjectsList.push(newBaselineServiceObject); const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(newFilePaths, forceDeployment)
const stableObject = await canaryDeploymentHelper.fetchResource( await createCanaryService(kubectl, filePaths)
kubectl, return {result, newFilePaths}
kind, }
canaryDeploymentHelper.getStableResourceName(name)
); async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
if (!stableObject) { const newObjectsList = []
const newStableServiceObject = const trafficObjectsList: string[] = []
canaryDeploymentHelper.getStableResource(inputObject);
newObjectsList.push(newStableServiceObject); for (const filePath of filePaths) {
const fileContents = fs.readFileSync(filePath).toString()
core.debug("Creating the traffic object for service: " + name); const parsedYaml = yaml.safeLoadAll(fileContents)
const trafficObject = await createTrafficSplitManifestFile( for (const inputObject of parsedYaml) {
kubectl, const name = inputObject.metadata.name
name, const kind = inputObject.kind
0,
0, if (isServiceEntity(kind)) {
1000 core.debug(`Creating services for ${kind} ${name}`)
); const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject)
trafficObjectsList.push(trafficObject); newObjectsList.push(newCanaryServiceObject)
} else {
let updateTrafficObject = true; const newBaselineServiceObject =
const trafficObject = await canaryDeploymentHelper.fetchResource( canaryDeploymentHelper.getNewBaselineResource(inputObject)
kubectl, newObjectsList.push(newBaselineServiceObject)
TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name) const stableObject = await canaryDeploymentHelper.fetchResource(
); kubectl,
kind,
if (trafficObject) { canaryDeploymentHelper.getStableResourceName(name)
const trafficJObject = JSON.parse(JSON.stringify(trafficObject)); )
if (trafficJObject?.spec?.backends) { if (!stableObject) {
trafficJObject.spec.backends.forEach((s) => { const newStableServiceObject =
if ( canaryDeploymentHelper.getStableResource(inputObject)
s.service === newObjectsList.push(newStableServiceObject)
canaryDeploymentHelper.getCanaryResourceName(name) &&
s.weight === "1000m" core.debug('Creating the traffic object for service: ' + name)
) { const trafficObject = await createTrafficSplitManifestFile(
core.debug("Update traffic objcet not required"); kubectl,
updateTrafficObject = false; name,
} 0,
}); 0,
} 1000
} )
if (updateTrafficObject) { trafficObjectsList.push(trafficObject)
core.debug( } else {
"Stable service object present so updating the traffic object for service: " + let updateTrafficObject = true
name const trafficObject = await canaryDeploymentHelper.fetchResource(
); kubectl,
trafficObjectsList.push(updateTrafficSplitObject(kubectl, name)); TRAFFIC_SPLIT_OBJECT,
} getTrafficSplitResourceName(name)
} )
}
} if (trafficObject) {
} const trafficJObject = JSON.parse(
JSON.stringify(trafficObject)
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList); )
manifestFiles.push(...trafficObjectsList); if (trafficJObject?.spec?.backends) {
const forceDeployment = core.getInput("force").toLowerCase() === "true"; trafficJObject.spec.backends.forEach((s) => {
if (
const result = await kubectl.apply(manifestFiles, forceDeployment); s.service ===
checkForErrors([result]); canaryDeploymentHelper.getCanaryResourceName(
} name
) &&
export async function redirectTrafficToCanaryDeployment( s.weight === '1000m'
kubectl: Kubectl, ) {
manifestFilePaths: string[] core.debug('Update traffic objcet not required')
) { updateTrafficObject = false
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000); }
} })
}
export async function redirectTrafficToStableDeployment( }
kubectl: Kubectl,
manifestFilePaths: string[] if (updateTrafficObject) {
) { core.debug(
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0); 'Stable service object present so updating the traffic object for service: ' +
} name
)
async function adjustTraffic( trafficObjectsList.push(
kubectl: Kubectl, await updateTrafficSplitObject(kubectl, name)
manifestFilePaths: string[], )
stableWeight: number, }
canaryWeight: number }
) { }
if (!manifestFilePaths || manifestFilePaths?.length == 0) { }
return; }
}
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const trafficSplitManifests = []; manifestFiles.push(...trafficObjectsList)
for (const filePath of manifestFilePaths) { const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const fileContents = fs.readFileSync(filePath).toString();
const parsedYaml = yaml.safeLoadAll(fileContents); const result = await kubectl.apply(manifestFiles, forceDeployment)
for (const inputObject of parsedYaml) { checkForErrors([result])
const name = inputObject.metadata.name; }
const kind = inputObject.kind;
export async function redirectTrafficToCanaryDeployment(
if (isServiceEntity(kind)) { kubectl: Kubectl,
trafficSplitManifests.push( manifestFilePaths: string[]
await createTrafficSplitManifestFile( ) {
kubectl, await adjustTraffic(kubectl, manifestFilePaths, 0, 1000)
name, }
stableWeight,
0, export async function redirectTrafficToStableDeployment(
canaryWeight kubectl: Kubectl,
) manifestFilePaths: string[]
); ) {
} await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
} }
}
async function adjustTraffic(
if (trafficSplitManifests.length <= 0) { kubectl: Kubectl,
return; manifestFilePaths: string[],
} stableWeight: number,
canaryWeight: number
const forceDeployment = core.getInput("force").toLowerCase() === "true"; ) {
const result = await kubectl.apply(trafficSplitManifests, forceDeployment); if (!manifestFilePaths || manifestFilePaths?.length == 0) {
checkForErrors([result]); return
} }
async function updateTrafficSplitObject( const trafficSplitManifests = []
kubectl: Kubectl, for (const filePath of manifestFilePaths) {
serviceName: string const fileContents = fs.readFileSync(filePath).toString()
): Promise<string> { const parsedYaml = yaml.safeLoadAll(fileContents)
const percentage = parseInt(core.getInput("percentage")); for (const inputObject of parsedYaml) {
if (percentage < 0 || percentage > 100) const name = inputObject.metadata.name
throw Error("Percentage must be between 0 and 100"); const kind = inputObject.kind
const percentageWithMuliplier = percentage * 10; if (isServiceEntity(kind)) {
const baselineAndCanaryWeight = percentageWithMuliplier / 2; trafficSplitManifests.push(
const stableDeploymentWeight = 1000 - percentageWithMuliplier; await createTrafficSplitManifestFile(
kubectl,
core.debug( name,
"Creating the traffic object with canary weight: " + stableWeight,
baselineAndCanaryWeight + 0,
",baseling weight: " + canaryWeight
baselineAndCanaryWeight + )
",stable: " + )
stableDeploymentWeight }
); }
return await createTrafficSplitManifestFile( }
kubectl,
serviceName, if (trafficSplitManifests.length <= 0) {
stableDeploymentWeight, return
baselineAndCanaryWeight, }
baselineAndCanaryWeight
); const forceDeployment = core.getInput('force').toLowerCase() === 'true'
} const result = await kubectl.apply(trafficSplitManifests, forceDeployment)
checkForErrors([result])
async function createTrafficSplitManifestFile( }
kubectl: Kubectl,
serviceName: string, async function updateTrafficSplitObject(
stableWeight: number, kubectl: Kubectl,
baselineWeight: number, serviceName: string
canaryWeight: number ): Promise<string> {
): Promise<string> { const percentage = parseInt(core.getInput('percentage', {required: true}))
const smiObjectString = await getTrafficSplitObject( if (percentage < 0 || percentage > 100)
kubectl, throw Error('Percentage must be between 0 and 100')
serviceName,
stableWeight, const percentageWithMuliplier = percentage * 10
baselineWeight, const baselineAndCanaryWeight = percentageWithMuliplier / 2
canaryWeight const stableDeploymentWeight = 1000 - percentageWithMuliplier
);
const manifestFile = fileHelper.writeManifestToFile( core.debug(
smiObjectString, 'Creating the traffic object with canary weight: ' +
TRAFFIC_SPLIT_OBJECT, baselineAndCanaryWeight +
serviceName ', baseline weight: ' +
); baselineAndCanaryWeight +
', stable weight: ' +
if (!manifestFile) { stableDeploymentWeight
throw new Error("Unable to create traffic split manifest file"); )
} return await createTrafficSplitManifestFile(
kubectl,
return manifestFile; serviceName,
} stableDeploymentWeight,
baselineAndCanaryWeight,
let trafficSplitAPIVersion = ""; baselineAndCanaryWeight
)
async function getTrafficSplitObject( }
kubectl: Kubectl,
name: string, async function createTrafficSplitManifestFile(
stableWeight: number, kubectl: Kubectl,
baselineWeight: number, serviceName: string,
canaryWeight: number stableWeight: number,
): Promise<string> { baselineWeight: number,
// cached version canaryWeight: number
if (!trafficSplitAPIVersion) { ): Promise<string> {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( const smiObjectString = await getTrafficSplitObject(
kubectl kubectl,
); serviceName,
} stableWeight,
baselineWeight,
return JSON.stringify({ canaryWeight
apiVersion: trafficSplitAPIVersion, )
kind: "TrafficSplit", const manifestFile = fileHelper.writeManifestToFile(
metadata: { smiObjectString,
name: getTrafficSplitResourceName(name), TRAFFIC_SPLIT_OBJECT,
}, serviceName
spec: { )
backends: [
{ if (!manifestFile) {
service: canaryDeploymentHelper.getStableResourceName(name), throw new Error('Unable to create traffic split manifest file')
weight: stableWeight, }
},
{ return manifestFile
service: canaryDeploymentHelper.getBaselineResourceName(name), }
weight: baselineWeight,
}, let trafficSplitAPIVersion = ''
{
service: canaryDeploymentHelper.getCanaryResourceName(name), async function getTrafficSplitObject(
weight: canaryWeight, kubectl: Kubectl,
}, name: string,
], stableWeight: number,
service: name, baselineWeight: number,
}, canaryWeight: number
}); ): Promise<string> {
} // cached version
if (!trafficSplitAPIVersion) {
function getTrafficSplitResourceName(name: string) { trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX; kubectl
} )
}
return JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: 'TrafficSplit',
metadata: {
name: getTrafficSplitResourceName(name),
annotations: inputAnnotations
},
spec: {
backends: [
{
service: canaryDeploymentHelper.getStableResourceName(name),
weight: stableWeight
},
{
service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight
},
{
service: canaryDeploymentHelper.getCanaryResourceName(name),
weight: canaryWeight
}
],
service: name
}
})
}
function getTrafficSplitResourceName(name: string) {
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
}
+230 -218
View File
@@ -1,218 +1,230 @@
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 {
import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper"; deployBlueGreen,
import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper"; deployBlueGreenIngress,
import { DeploymentStrategy } from "../types/deploymentStrategy"; deployBlueGreenService
import * as core from "@actions/core"; } from './blueGreen/deploy'
import { import {deployBlueGreenSMI} from './blueGreen/deploy'
parseTrafficSplitMethod, import {DeploymentStrategy} from '../types/deploymentStrategy'
TrafficSplitMethod, import * as core from '@actions/core'
} from "../types/trafficSplitMethod"; import {
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy"; parseTrafficSplitMethod,
import { ExecOutput } from "@actions/exec"; TrafficSplitMethod
import { } from '../types/trafficSplitMethod'
getWorkflowAnnotationKeyLabel, import {parseRouteStrategy} from '../types/routeStrategy'
getWorkflowAnnotations, import {ExecOutput} from '@actions/exec'
} from "../utilities/workflowAnnotationUtils"; import {
import { getWorkflowAnnotationKeyLabel,
annotateChildPods, getWorkflowAnnotations,
checkForErrors, cleanLabel
getLastSuccessfulRunSha, } from '../utilities/workflowAnnotationUtils'
} from "../utilities/kubectlUtils"; import {
import { annotateChildPods,
getWorkflowFilePath, checkForErrors,
normalizeWorkflowStrLabel, getLastSuccessfulRunSha
} from "../utilities/githubUtils"; } from '../utilities/kubectlUtils'
import { getDeploymentConfig } from "../utilities/dockerUtils"; import {
getWorkflowFilePath,
export async function deployManifests( normalizeWorkflowStrLabel
files: string[], } from '../utilities/githubUtils'
deploymentStrategy: DeploymentStrategy, import {getDeploymentConfig} from '../utilities/dockerUtils'
kubectl: Kubectl,
trafficSplitMethod: TrafficSplitMethod export async function deployManifests(
): Promise<string[]> { files: string[],
switch (deploymentStrategy) { deploymentStrategy: DeploymentStrategy,
case DeploymentStrategy.CANARY: { kubectl: Kubectl,
const { result, newFilePaths } = trafficSplitMethod: TrafficSplitMethod
trafficSplitMethod == TrafficSplitMethod.SMI ): Promise<string[]> {
? await deploySMICanary(files, kubectl) switch (deploymentStrategy) {
: await deployPodCanary(files, kubectl); case DeploymentStrategy.CANARY: {
const {result, newFilePaths} =
checkForErrors([result]); trafficSplitMethod == TrafficSplitMethod.SMI
return newFilePaths; ? await deploySMICanary(files, kubectl)
} : await deployPodCanary(files, kubectl)
case DeploymentStrategy.BLUE_GREEN: { checkForErrors([result])
const routeStrategy = parseRouteStrategy( return newFilePaths
core.getInput("route-method", { required: true }) }
);
case DeploymentStrategy.BLUE_GREEN: {
const { result, newFilePaths } = await Promise.resolve( const routeStrategy = parseRouteStrategy(
(routeStrategy == RouteStrategy.INGRESS && core.getInput('route-method', {required: true})
deployBlueGreenIngress(kubectl, files)) || )
(routeStrategy == RouteStrategy.SMI && const blueGreenDeployment = await deployBlueGreen(
deployBlueGreenSMI(kubectl, files)) || kubectl,
deployBlueGreenService(kubectl, files) files,
); routeStrategy
)
checkForErrors([result]); core.debug(
return newFilePaths; `objects deployed for ${routeStrategy}: ${JSON.stringify(
} blueGreenDeployment.objects
)} `
case undefined: { )
core.warning("Deployment strategy is not recognized.");
} checkForErrors([blueGreenDeployment.deployResult.execResult])
default: { return blueGreenDeployment.deployResult.manifestFiles
const trafficSplitMethod = parseTrafficSplitMethod( }
core.getInput("traffic-split-method", { required: true })
); case DeploymentStrategy.BASIC: {
const trafficSplitMethod = parseTrafficSplitMethod(
const forceDeployment = core.getInput("force").toLowerCase() === "true"; core.getInput('traffic-split-method', {required: true})
if (trafficSplitMethod === TrafficSplitMethod.SMI) { )
const updatedManifests = appendStableVersionLabelToResource(files);
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(updatedManifests, forceDeployment); if (trafficSplitMethod === TrafficSplitMethod.SMI) {
checkForErrors([result]); const updatedManifests = appendStableVersionLabelToResource(files)
} else {
const result = await kubectl.apply(files, forceDeployment); const result = await kubectl.apply(
checkForErrors([result]); updatedManifests,
} forceDeployment
)
return files; checkForErrors([result])
} } else {
} const result = await kubectl.apply(files, forceDeployment)
} checkForErrors([result])
}
function appendStableVersionLabelToResource(files: string[]): string[] {
const manifestFiles = []; return files
const newObjectsList = []; }
files.forEach((filePath: string) => { default: {
const fileContents = fs.readFileSync(filePath).toString(); throw new Error('Deployment strategy is not recognized.')
}
yaml.safeLoadAll(fileContents, function (inputObject) { }
const { kind } = inputObject; }
if (isDeploymentEntity(kind)) { function appendStableVersionLabelToResource(files: string[]): string[] {
const updatedObject = const manifestFiles = []
canaryDeploymentHelper.markResourceAsStable(inputObject); const newObjectsList = []
newObjectsList.push(updatedObject);
} else { files.forEach((filePath: string) => {
manifestFiles.push(filePath); const fileContents = fs.readFileSync(filePath).toString()
}
}); yaml.safeLoadAll(fileContents, function (inputObject) {
}); const {kind} = inputObject
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList); if (isDeploymentEntity(kind)) {
manifestFiles.push(...updatedManifestFiles); const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject)
return manifestFiles; newObjectsList.push(updatedObject)
} } else {
manifestFiles.push(filePath)
export async function checkManifestStability( }
kubectl: Kubectl, })
resources: Resource[] })
): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(kubectl, resources); const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
} manifestFiles.push(...updatedManifestFiles)
export async function annotateAndLabelResources( return manifestFiles
files: string[], }
kubectl: Kubectl,
resourceTypes: Resource[], export async function checkManifestStability(
allPods: any kubectl: Kubectl,
) { resources: Resource[]
const githubToken = core.getInput("token"); ): Promise<void> {
const workflowFilePath = await getWorkflowFilePath(githubToken); await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
}
const deploymentConfig = await getDeploymentConfig();
const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath); export async function annotateAndLabelResources(
files: string[],
await annotateResources( kubectl: Kubectl,
files, resourceTypes: Resource[],
kubectl, allPods: any
resourceTypes, ) {
allPods, const githubToken = core.getInput('token')
annotationKeyLabel, const workflowFilePath = await getWorkflowFilePath(githubToken)
workflowFilePath,
deploymentConfig const deploymentConfig = await getDeploymentConfig()
); const annotationKeyLabel = getWorkflowAnnotationKeyLabel()
await labelResources(files, kubectl, annotationKeyLabel);
} await annotateResources(
files,
async function annotateResources( kubectl,
files: string[], resourceTypes,
kubectl: Kubectl, allPods,
resourceTypes: Resource[], annotationKeyLabel,
allPods: any, workflowFilePath,
annotationKey: string, deploymentConfig
workflowFilePath: string, )
deploymentConfig: DeploymentConfig await labelResources(files, kubectl, annotationKeyLabel)
) { }
const annotateResults: ExecOutput[] = [];
const namespace = core.getInput("namespace") || "default"; async function annotateResources(
const lastSuccessSha = await getLastSuccessfulRunSha( files: string[],
kubectl, kubectl: Kubectl,
namespace, resourceTypes: Resource[],
annotationKey allPods: any,
); annotationKey: string,
workflowFilePath: string,
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations( deploymentConfig: DeploymentConfig
lastSuccessSha, ) {
workflowFilePath, const annotateResults: ExecOutput[] = []
deploymentConfig const namespace = core.getInput('namespace') || 'default'
)}`; const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl,
const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false"); namespace,
if (annotateNamespace) { annotationKey
annotateResults.push( )
await kubectl.annotate("namespace", namespace, annotationKeyValStr)
); const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
} lastSuccessSha,
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr)); workflowFilePath,
deploymentConfig
for (const resource of resourceTypes) { )}`
if (
resource.type.toLowerCase() !== const annotateNamespace = !(
models.KubernetesWorkload.POD.toLowerCase() core.getInput('annotate-namespace').toLowerCase() === 'false'
) { )
( if (annotateNamespace) {
await annotateChildPods( annotateResults.push(
kubectl, await kubectl.annotate('namespace', namespace, annotationKeyValStr)
resource.type, )
resource.name, }
annotationKeyValStr, annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr))
allPods
) for (const resource of resourceTypes) {
).forEach((execResult) => annotateResults.push(execResult)); if (
} resource.type.toLowerCase() !==
} models.KubernetesWorkload.POD.toLowerCase()
) {
checkForErrors(annotateResults, true); ;(
} await annotateChildPods(
kubectl,
async function labelResources( resource.type,
files: string[], resource.name,
kubectl: Kubectl, annotationKeyValStr,
label: string allPods
) { )
const labels = [ ).forEach((execResult) => annotateResults.push(execResult))
`workflowFriendlyName=${normalizeWorkflowStrLabel( }
process.env.GITHUB_WORKFLOW }
)}`,
`workflow=${label}`, checkForErrors(annotateResults, true)
]; }
checkForErrors([await kubectl.labelFiles(files, labels)], true); async function labelResources(
} files: string[],
kubectl: Kubectl,
label: string
) {
const labels = [
`workflowFriendlyName=${cleanLabel(
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
)}`,
`workflow=${cleanLabel(label)}`
]
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
]; ]
+8
View File
@@ -0,0 +1,8 @@
export function parseAnnotations(str: string) {
if (str == '') {
return new Map<string, string>()
} else {
const annotation = JSON.parse(str)
return new Map<string, string>(annotation)
}
}
+21
View File
@@ -0,0 +1,21 @@
import {DeployResult} from './deployResult'
import {K8sObject, K8sDeleteObject} from './k8sObject'
export interface BlueGreenDeployment {
deployResult: DeployResult
objects: K8sObject[]
}
export interface BlueGreenManifests {
serviceEntityList: K8sObject[]
serviceNameMap: Map<string, string>
unroutedServiceEntityList: K8sObject[]
deploymentEntityList: K8sObject[]
ingressEntityList: K8sObject[]
otherObjects: K8sObject[]
}
export interface BlueGreenRejectResult {
deleteResult: K8sDeleteObject[]
routeResult: BlueGreenDeployment
}
+6
View File
@@ -0,0 +1,6 @@
import {ExecOutput} from '@actions/exec'
export interface DeployResult {
execResult: ExecOutput
manifestFiles: string[]
}
+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()
}); })
}); })
}); })
+32 -32
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
})
)
}
} }
+57
View File
@@ -0,0 +1,57 @@
export interface K8sObject {
metadata: {
name: string
labels: Map<string, string>
}
kind: string
spec: any
}
export interface K8sServiceObject extends K8sObject {
spec: {
selector: Map<string, string>
}
}
export interface K8sDeleteObject {
name: string
kind: string
}
export interface K8sIngress extends K8sObject {
spec: {
rules: [
{
http: {
paths: [
{
backend: {
service: {
name: string
}
}
}
]
}
}
]
}
}
export interface TrafficSplitObject extends K8sObject {
apiVersion: string
metadata: {
name: string
labels: Map<string, string>
annotations: Map<string, string>
}
spec: {
service: string
backends: TrafficSplitBackend[]
}
}
export interface TrafficSplitBackend {
service: string
weight: number
}
+334 -326
View File
@@ -1,359 +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 testNamespace = "testNamespace"; const testNamespace = 'testNamespace'
const defaultNamespace = "default"; const defaultNamespace = 'default'
describe("Kubectl class", () => { describe('Kubectl class', () => {
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
describe("default namespace behavior", () => { beforeEach(() => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace); jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" }; 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
})
})
})
})
describe("omits default namespace from commands", () => { describe('with a success exec return in testNamespace', () => {
it("executes a command without appending --namespace arg", async () => { const kubectl = new Kubectl(kubectlPath, testNamespace)
// no args const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
const command = "command";
expect(await kubectl.executeCommand(command)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command],
{ silent: false }
);
});
});
});
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
describe("with a success exec return in testNamespace", () => { it('applies a configuration with a single config path', async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace); const configPaths = 'configPaths'
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" }; const result = await kubectl.apply(configPaths)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace],
{silent: false}
)
})
beforeEach(() => { it('applies a configuration with multiple config paths', async () => {
jest.spyOn(exec, "getExecOutput").mockImplementation(async () => { const configPaths = ['configPath1', 'configPath2', 'configPath3']
return execReturn; const result = await kubectl.apply(configPaths)
}); expect(result).toBe(execReturn)
}); expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'apply',
'-f',
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--namespace',
testNamespace
],
{silent: false}
)
})
it("applies a configuration with a single config path", async () => { it('applies a configuration with force when specified', async () => {
const configPaths = "configPaths"; const configPaths = ['configPath1', 'configPath2', 'configPath3']
const result = await kubectl.apply(configPaths); const result = await kubectl.apply(configPaths, true)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
["apply", "-f", configPaths, "--namespace", testNamespace], [
{ silent: false } 'apply',
); '-f',
}); configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--force',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("applies a configuration with multiple config paths", async () => { it('describes a resource', async () => {
const configPaths = ["configPath1", "configPath2", "configPath3"]; const resourceType = 'type'
const result = await kubectl.apply(configPaths); const resourceName = 'name'
expect(result).toBe(execReturn); const result = await kubectl.describe(resourceType, resourceName)
expect(exec.getExecOutput).toBeCalledWith( expect(result).toBe(execReturn)
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
"apply", [
"-f", 'describe',
configPaths[0] + "," + configPaths[1] + "," + configPaths[2], resourceType,
"--namespace", resourceName,
testNamespace, '--namespace',
], testNamespace
{ silent: false } ],
); {silent: false}
}); )
})
it("applies a configuration with force when specified", async () => { it('describes a resource silently', async () => {
const configPaths = ["configPath1", "configPath2", "configPath3"]; const resourceType = 'type'
const result = await kubectl.apply(configPaths, true); const resourceName = 'name'
expect(result).toBe(execReturn); const result = await kubectl.describe(resourceType, resourceName, true)
expect(exec.getExecOutput).toBeCalledWith( expect(result).toBe(execReturn)
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
"apply", [
"-f", 'describe',
configPaths[0] + "," + configPaths[1] + "," + configPaths[2], resourceType,
"--force", resourceName,
"--namespace", '--namespace',
testNamespace, testNamespace
], ],
{ silent: false } {silent: true}
); )
}); })
it("describes a resource", async () => { it('annotates resource', async () => {
const resourceType = "type"; const resourceType = 'type'
const resourceName = "name"; const resourceName = 'name'
const result = await kubectl.describe(resourceType, resourceName); const annotation = 'annotation'
expect(result).toBe(execReturn); const result = await kubectl.annotate(
expect(exec.getExecOutput).toBeCalledWith( resourceType,
kubectlPath, resourceName,
["describe", resourceType, resourceName, "--namespace", testNamespace], annotation
{ silent: false } )
); expect(result).toBe(execReturn)
}); expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
resourceType,
resourceName,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("describes a resource silently", async () => { it('annotates files with single file', async () => {
const resourceType = "type"; const file = 'file'
const resourceName = "name"; const annotation = 'annotation'
const result = await kubectl.describe(resourceType, resourceName, true); 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,
["describe", resourceType, resourceName, "--namespace", testNamespace], [
{ silent: true } 'annotate',
); '-f',
}); file,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("annotates resource", async () => { it('annotates files with mulitple files', async () => {
const resourceType = "type"; const files = ['file1', 'file2', 'file3']
const resourceName = "name"; const annotation = 'annotation'
const annotation = "annotation"; const result = await kubectl.annotateFiles(files, annotation)
const result = await kubectl.annotate( expect(result).toBe(execReturn)
resourceType, expect(exec.getExecOutput).toBeCalledWith(
resourceName, kubectlPath,
annotation [
); 'annotate',
expect(result).toBe(execReturn); '-f',
expect(exec.getExecOutput).toBeCalledWith( files.join(','),
kubectlPath, annotation,
[ '--overwrite',
"annotate", '--namespace',
resourceType, testNamespace
resourceName, ],
annotation, {silent: false}
"--overwrite", )
"--namespace", })
testNamespace,
],
{ silent: false }
);
});
it("annotates files with single file", async () => { it('labels files with single file', async () => {
const file = "file"; const file = 'file'
const annotation = "annotation"; const labels = ['label1', 'label2']
const result = await kubectl.annotateFiles(file, annotation); const result = await kubectl.labelFiles(file, labels)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
"annotate", 'label',
"-f", '-f',
file, file,
annotation, ...labels,
"--overwrite", '--overwrite',
"--namespace", '--namespace',
testNamespace, testNamespace
], ],
{ silent: false } {silent: false}
); )
}); })
it("annotates files with mulitple files", async () => { it('labels files with multiple files', async () => {
const files = ["file1", "file2", "file3"]; const files = ['file1', 'file2', 'file3']
const annotation = "annotation"; const labels = ['label1', 'label2']
const result = await kubectl.annotateFiles(files, annotation); const result = await kubectl.labelFiles(files, labels)
expect(result).toBe(execReturn); expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
"annotate", 'label',
"-f", '-f',
files.join(","), files.join(','),
annotation, ...labels,
"--overwrite", '--overwrite',
"--namespace", '--namespace',
testNamespace, testNamespace
], ],
{ silent: false } {silent: false}
); )
}); })
it("labels files with single file", async () => { it('gets all pods', async () => {
const file = "file"; expect(await kubectl.getAllPods()).toBe(execReturn)
const labels = ["label1", "label2"]; expect(exec.getExecOutput).toBeCalledWith(
const result = await kubectl.labelFiles(file, labels); kubectlPath,
expect(result).toBe(execReturn); ['get', 'pods', '-o', 'json', '--namespace', testNamespace],
expect(exec.getExecOutput).toBeCalledWith( {silent: true}
kubectlPath, )
[ })
"label",
"-f",
file,
...labels,
"--overwrite",
"--namespace",
testNamespace,
],
{ silent: false }
);
});
it("labels files with multiple files", async () => { it('checks rollout status', async () => {
const files = ["file1", "file2", "file3"]; const resourceType = 'type'
const labels = ["label1", "label2"]; const name = 'name'
const result = await kubectl.labelFiles(files, labels); expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
expect(result).toBe(execReturn); execReturn
expect(exec.getExecOutput).toBeCalledWith( )
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
"label", [
"-f", 'rollout',
files.join(","), 'status',
...labels, `${resourceType}/${name}`,
"--overwrite", '--namespace',
"--namespace", testNamespace
testNamespace, ],
], {silent: false}
{ silent: false } )
); })
});
it("gets all pods", async () => { it('gets resource', async () => {
expect(await kubectl.getAllPods()).toBe(execReturn); const resourceType = 'type'
expect(exec.getExecOutput).toBeCalledWith( const name = 'name'
kubectlPath, expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
["get", "pods", "-o", "json", "--namespace", testNamespace], expect(exec.getExecOutput).toBeCalledWith(
{ silent: true } kubectlPath,
); [
}); 'get',
`${resourceType}/${name}`,
'-o',
'json',
'--namespace',
testNamespace
],
{silent: false}
)
})
it("checks rollout status", async () => { it('executes a command', async () => {
const resourceType = "type"; // no args
const name = "name"; const command = 'command'
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe( expect(await kubectl.executeCommand(command)).toBe(execReturn)
execReturn expect(exec.getExecOutput).toBeCalledWith(
); kubectlPath,
expect(exec.getExecOutput).toBeCalledWith( [command, '--namespace', testNamespace],
kubectlPath, {silent: false}
[ )
"rollout",
"status",
`${resourceType}/${name}`,
"--namespace",
testNamespace,
],
{ silent: false }
);
});
it("gets resource", async () => { // with args
const resourceType = "type"; const args = 'args'
const name = "name"; expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn); expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, [command, args, '--namespace', testNamespace],
[ {silent: false}
"get", )
`${resourceType}/${name}`, })
"-o",
"json",
"--namespace",
testNamespace,
],
{ silent: false }
);
});
it("executes a command", async () => { it('deletes with single argument', async () => {
// no args const arg = 'argument'
const command = "command"; expect(await kubectl.delete(arg)).toBe(execReturn)
expect(await kubectl.executeCommand(command)).toBe(execReturn); expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, ['delete', arg, '--namespace', testNamespace],
[command, "--namespace", testNamespace], {silent: false}
{ silent: false } )
); })
// with args it('deletes with multiple arguments', async () => {
const args = "args"; const args = ['argument1', 'argument2', 'argument3']
expect(await kubectl.executeCommand(command, args)).toBe(execReturn); expect(await kubectl.delete(args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[command, args, "--namespace", testNamespace], ['delete', ...args, '--namespace', testNamespace],
{ silent: false } {silent: false}
); )
}); })
})
it("deletes with single argument", async () => { it('gets new replica sets', async () => {
const arg = "argument"; const kubectl = new Kubectl(kubectlPath, testNamespace)
expect(await kubectl.delete(arg)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["delete", arg, "--namespace", testNamespace],
{ silent: false }
);
});
it("deletes with multiple arguments", async () => { const newReplicaSetName = 'newreplicaset'
const args = ["argument1", "argument2", "argument3"]; const name = 'name'
expect(await kubectl.delete(args)).toBe(execReturn); const describeReturn = {
expect(exec.getExecOutput).toBeCalledWith( exitCode: 0,
kubectlPath, stdout: newReplicaSetName + name + ' ' + 'extra',
["delete", ...args, "--namespace", testNamespace], stderr: ''
{ silent: false } }
);
});
});
it("gets new replica sets", async () => { jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace); return describeReturn
})
const newReplicaSetName = "newreplicaset"; const deployment = 'deployment'
const name = "name"; const result = await kubectl.getNewReplicaSet(deployment)
const describeReturn = { expect(result).toBe(name)
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);
});
});
+194 -169
View File
@@ -1,169 +1,194 @@
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'
import {exec} from 'child_process'
export interface Resource {
name: string; export interface Resource {
type: string; name: string
} type: string
}
export class Kubectl {
private readonly kubectlPath: string; export class Kubectl {
private readonly namespace: string; protected readonly kubectlPath: string
private readonly ignoreSSLErrors: boolean; protected readonly namespace: string
protected readonly ignoreSSLErrors: boolean
constructor( protected readonly resourceGroup: string
kubectlPath: string, protected readonly name: string
namespace: string = "default", protected isPrivateCluster: boolean
ignoreSSLErrors: boolean = false
) { constructor(
this.kubectlPath = kubectlPath; kubectlPath: string,
this.ignoreSSLErrors = !!ignoreSSLErrors; namespace: string = 'default',
this.namespace = namespace; ignoreSSLErrors: boolean = false,
} resourceGroup: string = '',
name: string = ''
public async apply( ) {
configurationPaths: string | string[], this.kubectlPath = kubectlPath
force: boolean = false this.ignoreSSLErrors = !!ignoreSSLErrors
): Promise<ExecOutput> { this.namespace = namespace
try { this.resourceGroup = resourceGroup
if (!configurationPaths || configurationPaths?.length === 0) this.name = name
throw Error("Configuration paths must exist"); }
const applyArgs: string[] = [ public async apply(
"apply", configurationPaths: string | string[],
"-f", force: boolean = false
createInlineArray(configurationPaths), ): Promise<ExecOutput> {
]; try {
if (force) applyArgs.push("--force"); if (!configurationPaths || configurationPaths?.length === 0)
throw Error('Configuration paths must exist')
return await this.execute(applyArgs);
} catch (err) { const applyArgs: string[] = [
core.debug("Kubectl apply failed:" + err); 'apply',
} '-f',
} createInlineArray(configurationPaths)
]
public async describe( if (force) applyArgs.push('--force')
resourceType: string,
resourceName: string, return await this.execute(applyArgs)
silent: boolean = false } catch (err) {
): Promise<ExecOutput> { core.debug('Kubectl apply failed:' + err)
return await this.execute(["describe", resourceType, resourceName], silent); }
} }
public async getNewReplicaSet(deployment: string) { public async describe(
const result = await this.describe("deployment", deployment, true); resourceType: string,
resourceName: string,
let newReplicaSet = ""; silent: boolean = false
if (result?.stdout) { ): Promise<ExecOutput> {
const stdout = result.stdout.split("\n"); return await this.execute(
stdout.forEach((line: string) => { ['describe', resourceType, resourceName],
const newreplicaset = "newreplicaset"; silent
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) )
newReplicaSet = line }
.substring(newreplicaset.length)
.trim() public async getNewReplicaSet(deployment: string) {
.split(" ")[0]; const result = await this.describe('deployment', deployment, true)
});
} let newReplicaSet = ''
if (result?.stdout) {
return newReplicaSet; const stdout = result.stdout.split('\n')
} stdout.forEach((line: string) => {
const newreplicaset = 'newreplicaset'
public async annotate( if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
resourceType: string, newReplicaSet = line
resourceName: string, .substring(newreplicaset.length)
annotation: string .trim()
): Promise<ExecOutput> { .split(' ')[0]
const args = [ })
"annotate", }
resourceType,
resourceName, return newReplicaSet
annotation, }
"--overwrite",
]; public async annotate(
return await this.execute(args); resourceType: string,
} resourceName: string,
annotation: string
public async annotateFiles( ): Promise<ExecOutput> {
files: string | string[], const args = [
annotation: string 'annotate',
): Promise<ExecOutput> { resourceType,
const args = [ resourceName,
"annotate", annotation,
"-f", '--overwrite'
createInlineArray(files), ]
annotation, return await this.execute(args)
"--overwrite", }
];
return await this.execute(args); public async annotateFiles(
} files: string | string[],
annotation: string
public async labelFiles( ): Promise<ExecOutput> {
files: string | string[], const args = [
labels: string[] 'annotate',
): Promise<ExecOutput> { '-f',
const args = [ createInlineArray(files),
"label", annotation,
"-f", '--overwrite'
createInlineArray(files), ]
...labels, return await this.execute(args)
"--overwrite", }
];
return await this.execute(args); public async labelFiles(
} files: string | string[],
labels: string[]
public async getAllPods(): Promise<ExecOutput> { ): Promise<ExecOutput> {
return await this.execute(["get", "pods", "-o", "json"], true); const args = [
} 'label',
'-f',
public async checkRolloutStatus( createInlineArray(files),
resourceType: string, ...labels,
name: string '--overwrite'
): Promise<ExecOutput> { ]
return await this.execute(["rollout", "status", `${resourceType}/${name}`]); return await this.execute(args)
} }
public async getResource( public async getAllPods(): Promise<ExecOutput> {
resourceType: string, return await this.execute(['get', 'pods', '-o', 'json'], true)
name: string }
): Promise<ExecOutput> {
return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]); public async checkRolloutStatus(
} resourceType: string,
name: string
public executeCommand(command: string, args?: string) { ): Promise<ExecOutput> {
if (!command) throw new Error("Command must be defined"); return await this.execute([
return args ? this.execute([command, args]) : this.execute([command]); 'rollout',
} 'status',
`${resourceType}/${name}`
public delete(args: string | string[]) { ])
if (typeof args === "string") return this.execute(["delete", args]); }
return this.execute(["delete", ...args]);
} public async getResource(
resourceType: string,
private async execute(args: string[], silent: boolean = false) { name: string,
if (this.ignoreSSLErrors) { silentFailure: boolean = false
args.push("--insecure-skip-tls-verify"); ): Promise<ExecOutput> {
} core.debug(
if (this.namespace && this.namespace != "default") { 'fetching resource of type ' + resourceType + ' and name ' + name
args = args.concat(["--namespace", this.namespace]); )
} return await this.execute(
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`); ['get', `${resourceType}/${name}`, '-o', 'json'],
return await getExecOutput(this.kubectlPath, args, { silent }); silentFailure
} )
} }
export async function getKubectlPath() { public executeCommand(command: string, args?: string) {
const version = core.getInput("kubectl-version"); if (!command) throw new Error('Command must be defined')
const kubectlPath = version return args ? this.execute([command, args]) : this.execute([command])
? toolCache.find("kubectl", version) }
: await io.which("kubectl", true);
if (!kubectlPath) public delete(args: string | string[]) {
throw Error( if (typeof args === 'string') return this.execute(['delete', args])
"kubectl not found. You must install it before running this action" return this.execute(['delete', ...args])
); }
return kubectlPath; protected async execute(args: string[], silent: boolean = false) {
} if (this.ignoreSSLErrors) {
args.push('--insecure-skip-tls-verify')
}
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
})
}
}
export async function getKubectlPath() {
const version = core.getInput('kubectl-version')
const kubectlPath = version
? toolCache.find('kubectl', version)
: await io.which('kubectl', true)
if (!kubectlPath)
throw Error(
'kubectl not found. You must install it before running this action'
)
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)
}); })
}); })
+81 -81
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'
); )
+135
View File
@@ -0,0 +1,135 @@
import {Kubectl} from './kubectl'
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
import * as core from '@actions/core'
import * as os from 'os'
import * as fs from 'fs'
import * as path from 'path'
export class PrivateKubectl extends Kubectl {
protected async execute(args: string[], silent: boolean = false) {
args.unshift('kubectl')
let kubectlCmd = args.join(' ')
let addFileFlag = false
let eo = <ExecOptions>{silent}
if (this.containsFilenames(kubectlCmd)) {
// For private clusters, files will referenced solely by their basename
kubectlCmd = this.replaceFilnamesWithBasenames(kubectlCmd)
addFileFlag = true
}
const privateClusterArgs = [
'aks',
'command',
'invoke',
'--resource-group',
this.resourceGroup,
'--name',
this.name,
'--command',
kubectlCmd
]
if (addFileFlag) {
const filenames = this.extractFilesnames(kubectlCmd).split(' ')
const tempDirectory =
process.env['runner.tempDirectory'] || os.tmpdir() + '/manifests'
eo.cwd = tempDirectory
privateClusterArgs.push(...['--file', '.'])
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
const file = filenamesArr[index]
if (!file) {
continue
}
this.moveFileToTempManifestDir(file)
}
}
core.debug(
`private cluster Kubectl run with invoke command: ${kubectlCmd}`
)
return await getExecOutput('az', privateClusterArgs, eo)
}
private replaceFilnamesWithBasenames(kubectlCmd: string) {
let exFilenames = this.extractFilesnames(kubectlCmd)
let filenames = exFilenames.split(' ')
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
filenamesArr[index] = path.basename(filenamesArr[index])
}
let baseFilenames = filenamesArr.join()
let result = kubectlCmd.replace(exFilenames, baseFilenames)
return result
}
public extractFilesnames(strToParse: string) {
let start = strToParse.indexOf('-filename')
let offset = 7
if (start == -1) {
start = strToParse.indexOf('-f')
if (start == -1) {
return ''
}
offset = 0
}
let temp = strToParse.substring(start + offset)
let end = temp.indexOf(' -')
//End could be case where the -f flag was last, or -f is followed by some additonal flag and it's arguments
return temp.substring(3, end == -1 ? temp.length : end).trim()
}
private containsFilenames(str: string) {
return str.includes('-f ') || str.includes('filename ')
}
private createTempManifestsDirectory() {
const manifestsDir = '/tmp/manifests'
if (!fs.existsSync('/tmp/manifests')) {
fs.mkdirSync('/tmp/manifests', {recursive: true})
}
}
private moveFileToTempManifestDir(file: string) {
this.createTempManifestsDirectory()
if (!fs.existsSync('/tmp/' + file)) {
core.debug(
'/tmp/' +
file +
' does not exist, and therefore cannot be moved to the manifest directory'
)
}
fs.copyFile('/tmp/' + file, '/tmp/manifests/' + file, function (err) {
if (err) {
core.debug(
'Could not rename ' +
'/tmp/' +
file +
' to ' +
'/tmp/manifests/' +
file +
' ERROR: ' +
err
)
return
}
core.debug(
"Successfully moved file '" +
file +
"' from /tmp to /tmp/manifest directory"
)
})
}
}
+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)
}); })
}); })
+6 -6
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()
}); })
}); })
+59 -59
View File
@@ -1,75 +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} = {}
const pullImages = !(core.getInput("pull-images").toLowerCase() === "false"); const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false')
if (pullImages) { if (pullImages) {
//Fetching from image label if available //Fetching from image label if available
for (const image of imageNames) { for (const image of imageNames) {
try { try {
imageDockerfilePathMap[image] = await getDockerfilePath(image); imageDockerfilePathMap[image] = await getDockerfilePath(image)
} catch (ex) { } catch (ex) {
core.warning( core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} ` `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.')
} }
} }
+53 -39
View File
@@ -1,49 +1,63 @@
import { import {getFilesFromDirectories} from './fileUtils'
getFilesFromDirectories
} from "./fileUtils";
import * as path from "path";
describe("File utils", () => { import * as path from 'path'
it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
const testPath = path.join("test", "unit", "manifests") 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 testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = const expectedManifests = [
[ 'test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml',
"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/another_layer/deep-service.yaml", 'test/unit/manifests/manifest_test_dir/nested-test-service.yaml',
"test/unit/manifests/manifest_test_dir/nested-test-service.yaml", 'test/unit/manifests/test-ingress.yml',
"test/unit/manifests/test-ingress.yml", 'test/unit/manifests/test-ingress-new.yml',
"test/unit/manifests/test-service.yml" 'test/unit/manifests/test-service.yml'
] ]
// is there a more efficient way to test equality w random order?
// is there a more efficient way to test equality w random order? expect(testSearch).toHaveLength(7)
expect(testSearch).toHaveLength(5);
expectedManifests.forEach((fileName) => { expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(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'
)
it("crashes when an invalid file is provided", () => { expect(() => {
const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml") getFilesFromDirectories([badPath, goodPath])
const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir") }).toThrowError()
})
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'
)
it("doesn't duplicate files when nested dir included", () => { expect(
const outerPath = path.join("test", "unit", "manifests") getFilesFromDirectories([outerPath, fileAtOuter, innerPath])
const fileAtOuter = path.join("test", "unit", "manifests", "test-service.yml") ).toHaveLength(7)
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
// 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
+116 -109
View File
@@ -1,109 +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) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}` `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( export function getFilesFromDirectories(filePaths: string[]): string[] {
filePaths: string[] const fullPathSet: Set<string> = new Set<string>()
): string[]{
filePaths.forEach((fileName) => {
const fullPathSet: Set<string> = new Set<string>() try {
if (fs.lstatSync(fileName).isDirectory()) {
filePaths.forEach((fileName => { recurisveManifestGetter(fileName).forEach((file) => {
try { fullPathSet.add(file)
if(fs.lstatSync(fileName).isDirectory()){ })
recurisveManifestGetter(fileName).forEach((file) => {fullPathSet.add(file)}) } else if (
} else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){ getFileExtension(fileName) === 'yml' ||
fullPathSet.add(fileName) getFileExtension(fileName) === 'yaml'
} else{ ) {
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` ) fullPathSet.add(fileName)
} } else {
} catch (ex) { core.debug(
throw Error( `Detected non-manifest file, ${fileName}, continuing... `
`Exception occurred while reading the file ${fileName}: ${ex}` )
); }
} } catch (ex) {
})) throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
return Array.from(fullPathSet) )
} }
})
function recurisveManifestGetter(dirName: string): string[]{
const toRet: string[] = [] return Array.from(fullPathSet)
}
fs.readdirSync(dirName).forEach((fileName) => {
const fnwd: string = path.join(dirName, fileName) function recurisveManifestGetter(dirName: string): string[] {
if(fs.lstatSync(fnwd).isDirectory()){ const toRet: string[] = []
toRet.push(...recurisveManifestGetter(fnwd))
} else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){ fs.readdirSync(dirName).forEach((fileName) => {
toRet.push(path.join(dirName, fileName)) const fnwd: string = path.join(dirName, fileName)
} else{ if (fs.lstatSync(fnwd).isDirectory()) {
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` ) toRet.push(...recurisveManifestGetter(fnwd))
} } else if (
}) getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
return toRet ) {
} toRet.push(path.join(dirName, fileName))
} else {
function getFileExtension(fileName: string){ core.debug(`Detected non-manifest file, ${fileName}, continuing... `)
return fileName.slice((fileName.lastIndexOf(".") - 1 >>> 0) + 2) }
} })
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
} }
} }
+189 -184
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 ( }
resource.type == }
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE if (
) { resource.type ==
try { KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
const service = await getService(kubectl, resource.name); ) {
const { spec, status } = service; try {
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) { const service = await getService(kubectl, resource.name)
if (!isLoadBalancerIPAssigned(status)) { const {spec, status} = service
await waitForServiceExternalIPAssignment(kubectl, resource.name); if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
} else { if (!isLoadBalancerIPAssigned(status)) {
core.info( await waitForServiceExternalIPAssignment(
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}` kubectl,
); resource.name
} )
} } else {
} catch (ex) { core.info(
core.warning( `ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
`Could not determine service status of: ${resource.name} Error: ${ex}` )
); }
await kubectl.describe(resource.type, resource.name); }
} } catch (ex) {
} core.warning(
} `Could not determine service status of: ${resource.name} Error: ${ex}`
)
if (rolloutStatusHasErrors) { await kubectl.describe(resource.type, resource.name)
throw new Error("Rollout status error"); }
} }
} }
export async function checkPodStatus( if (rolloutStatusHasErrors) {
kubectl: Kubectl, throw new Error('Rollout status error')
podName: string }
): Promise<void> { }
const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout export async function checkPodStatus(
kubectl: Kubectl,
let podStatus; podName: string
let kubectlDescribeNeeded = false; ): Promise<void> {
for (let i = 0; i < iterations; i++) { const sleepTimeout = 10 * 1000 // 10 seconds
await sleep(sleepTimeout); const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout
core.debug(`Polling for pod status: ${podName}`); let podStatus
podStatus = await getPodStatus(kubectl, podName); let kubectlDescribeNeeded = false
for (let i = 0; i < iterations; i++) {
if ( await sleep(sleepTimeout)
podStatus &&
podStatus?.phase !== "Pending" && core.debug(`Polling for pod status: ${podName}`)
podStatus?.phase !== "Unknown" podStatus = await getPodStatus(kubectl, podName)
) {
break; if (
} podStatus &&
} podStatus?.phase !== 'Pending' &&
podStatus?.phase !== 'Unknown'
podStatus = await getPodStatus(kubectl, podName); ) {
switch (podStatus.phase) { break
case "Succeeded": }
case "Running": }
if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`); podStatus = await getPodStatus(kubectl, podName)
} else { switch (podStatus.phase) {
kubectlDescribeNeeded = true; case 'Succeeded':
} case 'Running':
break; if (isPodReady(podStatus)) {
case "Pending": console.log(`pod/${podName} is successfully rolled out`)
if (!isPodReady(podStatus)) { } else {
core.warning(`pod/${podName} rollout status check timed out`); kubectlDescribeNeeded = true
kubectlDescribeNeeded = true; }
} break
break; case 'Pending':
case "Failed": if (!isPodReady(podStatus)) {
core.error(`pod/${podName} rollout failed`); core.warning(`pod/${podName} rollout status check timed out`)
kubectlDescribeNeeded = true; kubectlDescribeNeeded = true
break; }
default: break
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`); case 'Failed':
} core.error(`pod/${podName} rollout failed`)
kubectlDescribeNeeded = true
if (kubectlDescribeNeeded) { break
await kubectl.describe("pod", podName); default:
} core.warning(`pod/${podName} rollout status: ${podStatus.phase}`)
} }
async function getPodStatus(kubectl: Kubectl, podName: string) { if (kubectlDescribeNeeded) {
const podResult = await kubectl.getResource("pod", podName); await kubectl.describe('pod', podName)
checkForErrors([podResult]); }
}
return JSON.parse(podResult.stdout).status;
} async function getPodStatus(kubectl: Kubectl, podName: string) {
const podResult = await kubectl.getResource('pod', podName)
function isPodReady(podStatus: any): boolean { checkForErrors([podResult])
let allContainersAreReady = true;
podStatus.containerStatuses.forEach((container) => { return JSON.parse(podResult.stdout).status
if (container.ready === false) { }
core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}` function isPodReady(podStatus: any): boolean {
); let allContainersAreReady = true
allContainersAreReady = false; podStatus.containerStatuses.forEach((container) => {
} if (container.ready === false) {
}); core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}`
if (!allContainersAreReady) { )
core.warning("All containers not in ready state"); allContainersAreReady = false
} }
})
return allContainersAreReady;
} if (!allContainersAreReady) {
core.warning('All containers not in ready state')
async function getService(kubectl: Kubectl, serviceName) { }
const serviceResult = await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE, return allContainersAreReady
serviceName }
);
async function getService(kubectl: Kubectl, serviceName) {
checkForErrors([serviceResult]); const serviceResult = await kubectl.getResource(
return JSON.parse(serviceResult.stdout); KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
} serviceName
)
async function waitForServiceExternalIPAssignment(
kubectl: Kubectl, checkForErrors([serviceResult])
serviceName: string return JSON.parse(serviceResult.stdout)
): Promise<void> { }
const sleepTimeout = 10 * 1000; // 10 seconds
const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout async function waitForServiceExternalIPAssignment(
kubectl: Kubectl,
for (let i = 0; i < iterations; i++) { serviceName: string
core.info(`Wait for service ip assignment : ${serviceName}`); ): Promise<void> {
await sleep(sleepTimeout); const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
const status = (await getService(kubectl, serviceName)).status;
if (isLoadBalancerIPAssigned(status)) { for (let i = 0; i < iterations; i++) {
core.info( core.info(`Wait for service ip assignment : ${serviceName}`)
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}` await sleep(sleepTimeout)
);
return; const status = (await getService(kubectl, serviceName)).status
} if (isLoadBalancerIPAssigned(status)) {
} core.info(
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
core.warning(`Wait for service ip assignment timed out${serviceName}`); )
} return
}
function isLoadBalancerIPAssigned(status: any) { }
return status?.loadBalancer?.ingress?.length > 0;
} core.warning(`Wait for service ip assignment timed out${serviceName}`)
}
function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0
}
+313 -310
View File
@@ -1,310 +1,313 @@
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
} }
/* /*
Example: Example:
Input of Input of
currentString: `image: "example/example-image"` currentString: `image: "example/example-image"`
imageName: `example/example-image` imageName: `example/example-image`
imageNameWithNewTag: `example/example-image:identifiertag` imageNameWithNewTag: `example/example-image:identifiertag`
would return would return
`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) { if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`; return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`
} }
} }
return acc + line + "\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}
}
if (override) { )
existingImagePullSecretObjects = newImagePullSecretsObjects; let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
} else {
existingImagePullSecretObjects = existingImagePullSecretObjects || []; if (override) {
existingImagePullSecretObjects = newImagePullSecretsObjects
existingImagePullSecretObjects = existingImagePullSecretObjects.concat( } else {
newImagePullSecretsObjects existingImagePullSecretObjects = existingImagePullSecretObjects || []
);
} existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
newImagePullSecretsObjects
setImagePullSecrets(inputObject, existingImagePullSecretObjects); )
} }
export function updateSelectorLabels( setImagePullSecrets(inputObject, existingImagePullSecretObjects)
inputObject: any, }
newLabels: Map<string, string>,
override: boolean export function updateSelectorLabels(
) { inputObject: any,
if (!inputObject) throw NullInputObjectError; newLabels: Map<string, string>,
override: boolean
if (!inputObject.kind) throw InputObjectKindNotDefinedError; ) {
if (!inputObject) throw NullInputObjectError
if (!newLabels) return;
if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return; if (!newLabels) return
let existingLabels = getSpecSelectorLabels(inputObject); if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
if (override) { return
existingLabels = newLabels;
} else { let existingLabels = getSpecSelectorLabels(inputObject)
existingLabels = existingLabels || new Map<string, string>(); if (override) {
Object.keys(newLabels).forEach( existingLabels = newLabels
(key) => (existingLabels[key] = newLabels[key]) } else {
); existingLabels = existingLabels || new Map<string, string>()
} Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
setSpecSelectorLabels(inputObject, existingLabels); )
} }
export function getResources( setSpecSelectorLabels(inputObject, existingLabels)
filePaths: string[], }
filterResourceTypes: string[]
): Resource[] { export function getResources(
if (!filePaths) return []; filePaths: string[],
filterResourceTypes: string[]
const resources: Resource[] = []; ): Resource[] {
filePaths.forEach((filePath: string) => { if (!filePaths) return []
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => { const resources: Resource[] = []
const inputObjectKind = inputObject?.kind || ""; filePaths.forEach((filePath: string) => {
if ( const fileContents = fs.readFileSync(filePath).toString()
filterResourceTypes.filter( yaml.safeLoadAll(fileContents, (inputObject) => {
(type) => inputObjectKind.toLowerCase() === type.toLowerCase() const inputObjectKind = inputObject?.kind || ''
).length > 0 if (
) { filterResourceTypes.filter(
resources.push({ (type) => inputObjectKind.toLowerCase() === type.toLowerCase()
type: inputObject.kind, ).length > 0
name: inputObject.metadata.name, ) {
}); resources.push({
} type: inputObject.kind,
}); name: inputObject.metadata.name
}); })
}
return resources; })
} })
function updateImagePullSecretsInManifestFiles( return resources
filePaths: string[], }
imagePullSecrets: string[]
): string[] { function updateImagePullSecretsInManifestFiles(
if (imagePullSecrets?.length <= 0) return filePaths; filePaths: string[],
imagePullSecrets: string[]
const newObjectsList = []; ): string[] {
filePaths.forEach((filePath: string) => { if (imagePullSecrets?.length <= 0) return filePaths
const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject: any) => { const newObjectsList = []
if (inputObject?.kind) { filePaths.forEach((filePath: string) => {
const { kind } = inputObject; const fileContents = fs.readFileSync(filePath).toString()
if (isWorkloadEntity(kind)) { yaml.safeLoadAll(fileContents, (inputObject: any) => {
updateImagePullSecrets(inputObject, imagePullSecrets); if (inputObject?.kind) {
} const {kind} = inputObject
newObjectsList.push(inputObject); if (isWorkloadEntity(kind)) {
} updateImagePullSecrets(inputObject, imagePullSecrets)
}); }
}); 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
} }
+19 -17
View File
@@ -1,18 +1,20 @@
import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils"; import {cleanLabel} from '../utilities/workflowAnnotationUtils'
describe("WorkflowAnnotationUtils", () => { describe('WorkflowAnnotationUtils', () => {
describe("prefixObjectKeys", () => { describe('cleanLabel', () => {
it("should prefix an object with a given prefix", () => { it('should clean label', () => {
const obj = { const alreadyClean = 'alreadyClean'
foo: "bar", expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
baz: "qux", expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
}; expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
const prefix = "prefix."; 'withS0MEinvalidchars'
const expected = { )
"prefix.foo": "bar", expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
"prefix.baz": "qux", })
}; it('should remove slashes from label', () => {
expect(prefixObjectKeys(obj, prefix)).toEqual(expected); expect(
}); cleanLabel('Workflow Name / With Slashes / And Spaces')
}); ).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces')
}); })
})
})
+40 -39
View File
@@ -1,46 +1,47 @@
import { DeploymentConfig } from "../types/deploymentConfig"; import {DeploymentConfig} from '../types/deploymentConfig'
const ANNOTATION_PREFIX = "actions.github.com/"; 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'
}; }
const prefixedAnnotationObject = prefixObjectKeys(annotationObject, ANNOTATION_PREFIX); return JSON.stringify(annotationObject)
return JSON.stringify(prefixedAnnotationObject);
} }
export function getWorkflowAnnotationKeyLabel( export function getWorkflowAnnotationKeyLabel(): string {
workflowFilePath: string return `${ANNOTATION_PREFIX}/k8s-deploy`
): string { }
const hashKey = require("crypto")
.createHash("MD5") /**
.update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`) * Cleans label to match valid kubernetes label specification by removing invalid characters
.digest("hex"); * @param label
return `githubWorkflow_${hashKey}`; * @returns cleaned label
*/
export function cleanLabel(label: string): string {
let removedInvalidChars = label
.replace(/\s/gi, '_')
.replace(/[\/\\\|]/gi, '-')
.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] || ''
} }
+42 -42
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
+28 -28
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,23 @@
---
apiVersion: v1
kind: Service
metadata:
name: unrouted-service
spec:
selector:
app: fake-application
ports:
- protocol: TCP
port: 80
targetPort: 80
---
kind: TrafficSplit
metadata:
name: foobar-rollout
spec:
service: foobar
backends:
- service: foobar-v1
weight: 1000
- service: foobar-v2
weight: 500
+50
View File
@@ -0,0 +1,50 @@
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/v1
kind: Ingress
metadata:
name: nginx-ingress
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- http:
paths:
- path: /testpath
backend:
service:
name: nginx-service
port:
number: 80
+42 -42
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
+28 -28
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
+7 -7
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"]
} }