Compare commits

...

95 Commits

Author SHA1 Message Date
Oliver King 4fd4e1ad9d Fix README.md typo 2022-08-22 11:06:05 -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
Vidya 4ebf668e6f upgraded to Node16 (#197)
Co-authored-by: Vidya Reddy <vidyareddy@microsoft.com>
2022-06-16 13:20:04 -04:00
David Gamero 15920eb094 omit namespace arg for default namespace (#195) 2022-06-15 10:01:20 -04:00
David Gamero 507f2d4fc7 prefix for annotations (#191) 2022-06-08 11:39:09 -04:00
Oliver King 06a06b13b9 Remove kubectl version example (#188) 2022-06-06 15:15:43 -04:00
Jaiveer Katariya fa093f2922 Modifying README to include instructions/examples for directory functionality (#183)
* Added some tests, not sure what else to try but gonna think of more examples

* forgot some files

* reverted package-lock.json

* Added empty dir test

* Cleaned up some extra spaces

* Add node modules and compiled JavaScript from main

* forgot to actually include functionality

* removed unnecessary files

* Update .gitignore

* Update .gitignore

* Update .gitignore

* thx david

* renamed searchFilesRec

* integrations test fix

* added examples to README

* added note about depth

* added additional note

* removed ticks

* changed version string

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

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

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

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

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

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

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

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

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-04-11 10:22:24 -04:00
Jan Röhrich 75cb5d47f7 Make namespace annotation switchable (#177) 2022-04-11 10:22:05 -04:00
Jan Röhrich bcdb90f36f Make pulling of images switchable (#178) 2022-04-11 10:20:36 -04:00
Oliver King ee3c5aed75 switch run to index.js (#171) 2022-02-09 17:10:53 -05:00
Oliver King 961b316a51 fix regex bug (#170) 2022-02-09 17:08:07 -05:00
Tommy Barnes 4810ff9a3e Swapped out release-pr.yml and tag-and-release.yml to use reusable github workflows 2022-02-03 16:08:24 -05:00
Oliver King ca8d2604ac Massive refactor (#165) 2022-02-02 09:07:53 -05:00
David Gamero 5cbd4acaca Add Minikube integration testing workflow (#160)
Move integration testing into pull_request action that is isolated to an action runner using minikube

Co-authored-by: David Gamero <davidgamero@microsoft.com>
2021-12-07 16:21:34 -05:00
Oliver King 18ff12030c Build JavaScript (#159)
* build js

* fix missing string template

Co-authored-by: Oliver King <kingoliver@microsoft.com>
2021-12-01 11:08:00 -05:00
Oliver King 8898d95f4f Fix smi weight bug (#150)
Co-authored-by: Oliver King <kingoliver@microsoft.com>
2021-11-29 15:26:58 -05:00
Koushik Dey 33608d18f7 Sending a warning instead of throwing error when KUBECONFIG is missing. (#144) 2021-08-17 16:39:38 +05:30
Koushik Dey acd12a4705 Create defaultLabels.yml (#140) 2021-06-27 08:54:24 +05:30
Koushik Dey 81557b8633 Bump @actions/tool-cache from 1.1.1 to 1.1.2 (#138) 2021-06-18 11:50:08 +05:30
dependabot[bot] e1b9842236 Bump ws from 7.4.4 to 7.4.6 (#137)
Bumps [ws](https://github.com/websockets/ws) from 7.4.4 to 7.4.6.
- [Release notes](https://github.com/websockets/ws/releases)
- [Commits](https://github.com/websockets/ws/compare/7.4.4...7.4.6)

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-15 22:57:14 +05:30
dependabot[bot] 26cb2cdb5f Bump browserslist from 4.16.3 to 4.16.6 (#136)
Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.16.3 to 4.16.6.
- [Release notes](https://github.com/browserslist/browserslist/releases)
- [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md)
- [Commits](https://github.com/browserslist/browserslist/compare/4.16.3...4.16.6)

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-06-15 22:00:46 +05:30
dependabot[bot] 5ebbfbbefe Bump hosted-git-info from 2.8.8 to 2.8.9 (#135)
Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9.
- [Release notes](https://github.com/npm/hosted-git-info/releases)
- [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md)
- [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9)

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

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-26 12:47:36 +05:30
Koushik Dey ac49626466 Fixing label values of workflow names with spaces (#134) 2021-05-05 15:55:02 +05:30
Ganesh S d332939666 Merge pull request #131 from Azure/ganeshrockz/delimiterFix
Supporting both comma and new line as delimiters for manifests
2021-04-15 11:51:30 +05:30
Ganeshrockz 2577009bcb Adding ; as delimiter 2021-04-15 11:35:18 +05:30
Ganeshrockz a58ad23e7f PR comments 2021-04-14 20:05:45 +05:30
Ganeshrockz ee4b5d33e0 Comments 2021-04-14 15:31:19 +05:30
Ganeshrockz 625898f6eb Removing whitespace from manifests 2021-04-14 14:31:04 +05:30
Ganeshrockz 8d257fed50 Supporting both comma and new line as delimiters for manifests 2021-04-14 14:14:06 +05:30
Sundar 4f6b70e29a Updated trigger for L2 tests. (#128) 2021-03-31 17:30:09 +05:30
Deepak Sattiraju 202bacc71b Update integration-tests.yml 2021-03-16 15:54:57 +05:30
Deepak Sattiraju 2c09684db9 Removing js files from main branch (#122) 2021-03-15 14:28:53 +05:30
Gennady Trubach 282a81e1fc Added arch detection to kubectl download (#117) 2021-03-15 12:46:34 +05:30
Deepak Sattiraju ce7c8f066f Fixing depandabot alert node-notifier --> 8.0.2 (#121) 2021-03-12 11:34:20 +05:30
Maxime Guerreiro 25ded46b9d Update readme to use v1.4 (#116)
Version 1.4 was released in December 2020. Update the readme to use this new version.
2021-03-10 13:20:41 +05:30
Jyotsna 56e4abca5e Users/jysin/pm feedback changes for master (#99)
* Changed dockerfile, Manifests, helmcharts links and README
2021-01-07 12:51:44 +05:30
Jyotsna 4bd69f56a9 Bug fix for dockerfile path for default (#96)
* Bug fix for dockerfile path link
2020-12-30 21:55:39 +05:30
Jyotsna 04921d7d06 New traceability fields added to annotations (#90)
* New traceability fields
2020-12-30 15:03:39 +05:30
Jyotsna 51b95a5ca2 Readme updated with traceability changes (#84)
* Updated new features in Readme with sample workflows - updated changes.
2020-12-28 14:50:00 +05:30
Jyotsna 49257c6f33 Updated new features in Readme with sample workflows (#82)
* Updated new changes in Readme for annotations with sample workflows for v1.2
2020-12-11 12:08:11 +05:30
Thomas Seljen Tvedt 895952654c Fixing version in samples (#80)
*editing in github to fix diff?*
Update README.md, changing from Azure/k8s-deploy@v1 to newest version Azure/k8s-deploy@v1.3.

Using @v1 I got an error message "Error: TypeError: Cannot read property 'trim' of null". When I finally realized I was on the wrong version it worked smoothly 🥳

Hopefully this will save someone else some troubleshooting?
2020-11-25 22:50:50 +05:30
Zainudeen V K 0fd84a1b0d Update integration-tests.yml 2020-11-09 13:49:00 +05:30
Ajinkya d35174fe93 Fixing issues found in bug bash. (#71) 2020-10-30 13:10:27 +05:30
Koushik Dey f80ed6c460 Merge pull request #66 from Azure/dependabot/npm_and_yarn/actions/core-1.2.6
Bump @actions/core from 1.1.0 to 1.2.6
2020-10-06 12:16:02 +05:30
Koushik Dey 72bc167726 BumpUp @actions/core, fixed failing test case 2020-10-05 18:45:39 +05:30
dependabot[bot] 21d3af2857 Bump @actions/core from 1.1.0 to 1.2.6
Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.1.0 to 1.2.6.
- [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)

Signed-off-by: dependabot[bot] <support@github.com>
2020-10-01 17:20:23 +00:00
Koushik Dey a80355209a Merge pull request #64 from Azure/users/koushdey/workflowAnnotations-master
(M)Annotation and Label changes to handle multiple workflows across branches
2020-09-21 14:53:50 +05:30
Koushik Dey 92589546e8 Annotation and Label changes to handle multiple workflows across branches(master) 2020-09-21 14:30:51 +05:30
Ajinkya b9146889f3 Update issue templates (#58)
* Update issue templates

* Add label as well
2020-09-17 14:04:13 +05:30
Sundar 29552c24a9 Blue green strategy - Refined some details. (#51)
* Refined some details.

* addressed comments

* updates readme

* Readme cleanup (#1)

* Small updates to readme

* added identified service terminology

* Adressed PR comments

* Added workflow to trigger L2 tests

* Renamed workflow file name

* Trigger integration tests through script and disable post check-in trigger.

Co-authored-by: Anirudh Raghunath <46741940+anraghun@users.noreply.github.com>
Co-authored-by: ajinkya599 <11447401+ajinkya599@users.noreply.github.com>
2020-09-17 12:22:14 +05:30
koushdey d394c2bba2 Merge pull request #52 from Azure/users/koushdey/addAnnotationsResourceView-master
Introduce annotations relevant to resource view during deploy
2020-07-31 19:12:05 +05:30
Koushik Dey e643530d85 Addressed review comments and refactored annotateNamespace 2020-07-31 19:02:52 +05:30
Koushik Dey a4ebc55d69 Checks in annotateNamespace to not error during failed annotation 2020-07-15 17:54:06 +05:30
Koushik Dey 15e04b8f7e Introduce annotations relevant to resource view during deploy 2020-07-15 16:24:50 +05:30
Sundar b4bc3003e8 added blue green strategy (#47)
* added blue green strategy

* Addressed review comments

* addressed pr comments

* updated names in test

* addressed final pr comments
2020-07-13 08:59:05 +05:30
Tauhid Anjum c9b54fdae2 Merge pull request #46 from Azure/tauhid621/optionalForceFlag
force flag added
2020-06-20 00:45:15 +05:30
tauhid621 6773ba4167 force flag added 2020-06-19 22:12:02 +05:30
rgsubh f1898e0618 Merge from release to master for test cases (#41)
* Test Cases for deploy (#35)

* Test Cases for deploy

* Testing workflow

* Fixing an issue with test runs on remote

* Fixing an issue with test runs on remote

* Fixing an issue with test runs on remote

* Fixing an issue with test runs on remote

* Fixing an issue with test runs on remote

* Fixing an issue with test runs on remote

* Review Comments fix

* Review comments fix

* Reverting typescript export changes in previour PR (#39)
2020-06-08 14:41:27 +05:30
Justin Hutchings 11a48a4e1d Add CodeQL security scanning (#38) 2020-06-03 11:25:20 +05:30
Anirudh 6da51b24cd Modified the description to optimise marketplace search (#31)
* modified description to optimise search

* modified wording

* added the AKS keyword

Co-authored-by: Anirudh Raghunath <void@Anirudhs-MacBook-Pro.local>
Co-authored-by: Anirudh Raghunath <void@MININT-G1P7G69.fareast.corp.microsoft.com>
2020-05-06 15:00:44 +05:30
Usha N 99c4423993 Update README.md 2020-03-26 18:12:00 +05:30
shigupt202 eb22293c53 Merge pull request #17 from Azure/users/shigupt/addingKubectlDescribeOutputInLogs
Users/shigupt/adding kubectl describe output in logs
2020-01-27 14:07:58 +05:30
Shivam Gupta e4bc5e8873 Adding a varibale to indicate describe output is needed 2020-01-23 16:46:13 +05:30
shigupt202 a3bb31ec16 Merge pull request #16 from shigupt202/users/shigupt/trafficSplitAPIVersionUpdate
Users/shigupt/traffic split api version update
2020-01-17 13:59:05 +05:30
Shivam Gupta e7d77ef817 Added exception for null kubectl commands 2020-01-17 10:15:28 +05:30
Shivam Gupta fdacb8e073 Created const for traffic split api version prefix 2020-01-13 16:20:48 +05:30
Shivam Gupta 4c0e9cfbff PR fixes 2020-01-10 11:26:48 +05:30
Shivam Gupta 305d883d74 Added lib file 2020-01-09 16:59:07 +05:30
Shivam Gupta 4a2857109f Added support for kubectl describe output in logs 2020-01-09 16:00:06 +05:30
Shivam Gupta 0527303033 Updated identation 2020-01-09 13:58:58 +05:30
Shivam Gupta 31a423057f Adding lib changes 2020-01-09 12:27:50 +05:30
Shivam Gupta ad0b77acbe TrafficSplit API version update 2020-01-09 11:21:36 +05:30
Lennart Schoch 2a3bf64395 Filter imagePullSecrets to contain only non-empty values (#14) 2019-12-06 08:34:10 +05:30
Deepak Sattiraju 26d4801e5e Update README.md 2019-12-04 15:03:49 +05:30
Shashank Barsin 637684d130 Merge pull request #8 from Azure/shasb
Update documentation
2019-11-19 14:26:17 +05:30
Shashank Barsin b635499b62 Update documentation 2019-11-19 14:25:13 +05:30
Shashank Barsin e6399ba4e7 Merge pull request #7 from Azure/shasb
Update documentation
2019-11-19 14:18:07 +05:30
Shashank Barsin 6687f5458e Update documentation 2019-11-19 14:15:40 +05:30
Deepak Sattiraju be01c3f321 Deployment Strategy (#4) (#6) 2019-11-18 21:07:19 +05:30
115 changed files with 18894 additions and 1445 deletions
+1
View File
@@ -0,0 +1 @@
* @Azure/aks-atlanta
+51
View File
@@ -0,0 +1,51 @@
name: 'Code scanning - action'
on:
push:
pull_request:
schedule:
- cron: '0 19 * * 0'
jobs:
CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest
steps:
- 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
# If this run was triggered by a pull request event, then checkout
# the head of the pull request instead of the merge commit.
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}
# Initializes the CodeQL tools for scanning.
- 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).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ 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
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
+35
View File
@@ -0,0 +1,35 @@
name: setting-default-labels
# Controls when the action will run.
on:
schedule:
- cron: '0 0/3 * * *'
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- uses: actions/stale@v3
name: Setting issue as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
stale-issue-label: 'idle'
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@v3
name: Setting PR as idle
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
stale-pr-label: 'idle'
days-before-stale: 14
days-before-close: -1
operations-per-run: 100
+18
View File
@@ -0,0 +1,18 @@
name: 'Run prettify'
on:
pull_request:
push:
branches: [main]
jobs:
prettier:
name: Prettier Check
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Enforce Prettier
uses: actionsx/prettier@v2
with:
args: --check .
+14
View File
@@ -0,0 +1,14 @@
name: Create release PR
on:
workflow_dispatch:
inputs:
release:
description: 'Define release version (ex: v1, v2, v3)'
required: true
jobs:
release-pr:
uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
with:
release: ${{ github.event.inputs.release }}
+215
View File
@@ -0,0 +1,215 @@
name: Minikube Integration Tests
on:
pull_request:
branches:
- master
- main
- 'releases/*'
push:
branches:
- master
- main
- 'releases/*'
workflow_dispatch:
jobs:
run-integration-test:
name: Run Minikube Integration Tests
runs-on: ubuntu-latest
env:
KUBECONFIG: /home/runner/.kube/config
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
rm -rf node_modules/
npm install
- name: Install ncc
run: npm i -g @vercel/ncc
- name: Build
run: ncc build src/run.ts -o lib
- name: Set name of ns
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
shell: bash
id: ns
- uses: Azure/setup-kubectl@v1
name: Install Kubectl
- id: setup-minikube
name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2
with:
minikube version: 'v1.24.0'
kubernetes version: 'v1.17.8'
driver: 'none'
timeout-minutes: 3
- name: Create namespace to run tests
run: kubectl create ns test-${{ steps.ns.outputs.name }}
- uses: actions/setup-python@v2
name: Install Python
with:
python-version: '3.x'
- name: Cleaning any previously created items
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-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 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
- name: Executing deploy action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels
run: |
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 }}
- name: Executing promote action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: promote
- name: Checking if deploments and services were created with none labels after promote
run: |
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 }}
- name: Executing deploy action on
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: deploy
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
run: |
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 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
- name: Executing reject action
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-service.yml
strategy: blue-green
route-method: service
action: reject
- name: Checking if deploments and services were routed back to none labels after reject
run: |
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 }}
- name: Cleaning up current set up
run: |
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 }}
- name: Executing deploy action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels
run: |
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 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: promote
- name: Checking if deploments, services and ingresses were created with none labels after promote
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: deploy
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
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' '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 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing reject action for ingress
uses: ./
with:
namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1
manifests: |
test/integration/manifests/test-ingress.yml
strategy: blue-green
route-method: ingress
action: reject
- name: Checking if deploments, services and ingresses were created with none labels after reject
run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- if: ${{ always() }}
name: Delete created namespace
run: kubectl delete ns test-${{ steps.ns.outputs.name }}
- if: ${{ always() }}
name: Posting result back to PR
run: |
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
shell: bash
+10
View File
@@ -0,0 +1,10 @@
name: Tag and create release draft
on:
push:
branches:
- releases/*
jobs:
tag-and-release:
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
+19
View File
@@ -0,0 +1,19 @@
name: 'Run unit tests.'
on: # rebuild any PRs and main branch changes
pull_request:
branches:
- main
- 'releases/*'
push:
branches:
- main
- 'releases/*'
jobs:
build: # make sure build/ci works properly
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- run: |
npm install
npm test
+5 -327
View File
@@ -1,329 +1,7 @@
## Ignore Visual Studio temporary files, build results, and node_modules
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
# User-specific files .DS_Store
*.suo .idea
*.user lib/
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio) coverage/
*.userprefs
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUNIT
*.VisualState.xml
TestResult.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
**/Properties/launchSettings.json
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# JetBrains Rider
.idea/
*.sln.iml
# CodeRush
.cr/
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
+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
+464 -131
View File
@@ -1,131 +1,464 @@
# Deploy manifest action for Kubernetes # Deploy manifests action for Kubernetes
Use this action to bake and deploy manifests to Kubernetes clusters.
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).
Assumes that the deployment target K8s cluster context was set earlier in the workflow by using either [`Azure/aks-set-context`](https://github.com/Azure/aks-set-context/tree/releases/v1) or [`Azure/k8s-set-context`](https://github.com/Azure/k8s-set-context/tree/releases/v1)
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.
#### Artifact substitution
The deploy action takes as input a list of container images which can be specified along with their tags or digests. The same is 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. ## Action capabilities
#### Manifest stability Following are the key capabilities of this action:
Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the task status as success/failure.
- **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.
#### Secret handling
The manifest files specfied as inputs are augmented with appropriate imagePullSecrets before deploying to the cluster. - **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure.
- **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster.
```yaml - **Deployment strategy** Supports both canary and blue-green deployment strategies
- uses: Azure/k8s-deploy@v1
with: - **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
namespace: 'myapp' # optional - **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).
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} ' - **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.
imagepullsecrets: | - **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:
image-pull-secret1
image-pull-secret2 - **Service route-method**: Identified services are configured to target the green deployments.
manifests: '/manifests/*.*' - **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.
kubectl-version: 'latest' # optional - **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.
```
Refer to the action metadata file for details about all the inputs https://github.com/Azure/k8s-deploy/blob/master/action.yml 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.
## End to end workflow for building container images and deploying to an Azure Kubernetes Service cluster ## Action inputs
```yaml <table>
on: [push] <thead>
<tr>
jobs: <th>Action inputs</th>
build: <th>Description</th>
runs-on: ubuntu-latest </tr>
steps: </thead>
- uses: actions/checkout@master <tr>
<td>action </br></br>(Required)</td>
- uses: Azure/docker-login@v1 <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>
with: </tr>
login-server: contoso.azurecr.io <tr>
username: ${{ secrets.REGISTRY_USERNAME }} <td>manifests </br></br>(Required)</td>
password: ${{ secrets.REGISTRY_PASSWORD }} <td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
</tr>
- run: | <tr>
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} <td>strategy </br></br>(Required)</td>
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} <td>Acceptable values: basic/canary/blue-green. <br>
Default value: basic
# Set the target AKS cluster. <br>Deployment strategy to be used while applying manifest files on the cluster.
- uses: Azure/aks-set-context@v1 <br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
with: <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>
creds: '${{ secrets.AZURE_CREDENTIALS }}' </tr>
cluster-name: contoso <tr>
resource-group: contoso-rg <td>namespace </br></br>(Optional)
<td>Namespace within the cluster to deploy to.</td>
- uses: Azure/k8s-create-secret@v1 </tr>
with: <tr>
container-registry-url: contoso.azurecr.io <td>images </br></br>(Optional)</td>
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} <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>
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} <code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br>
secret-name: demo-k8s-secret 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>
- uses: Azure/k8s-deploy@v1 <tr>
with: <td>imagepullsecrets </br></br>(Optional)</td>
manifests: | <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>
manifests/deployment.yml </tr>
manifests/service.yml <tr>
images: | <td>pull-images</br></br>(Optional)</td>
demo.azurecr.io/k8sdemo:${{ github.sha }} <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>
imagepullsecrets: | </tr>
demo-k8s-secret <tr>
``` <td>traffic-split-method </br></br>(Optional)</td>
<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>
## End to end workflow for building container images and deploying to a Kubernetes cluster </tr>
<tr>
```yaml <td>traffic-split-annotations </br></br>(Optional)</td>
on: [push] <td>Annotations in the form of key/value pair to be added to TrafficSplit.</td>
<tr>
jobs: <td>percentage </br></br>(Optional but required if strategy is canary)</td>
build: <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>
runs-on: ubuntu-latest </tr>
steps: <tr>
- uses: actions/checkout@master <td>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</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>
- uses: Azure/docker-login@v1 </tr>
with: <tr>
login-server: contoso.azurecr.io <td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
username: ${{ secrets.REGISTRY_USERNAME }} <td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
password: ${{ secrets.REGISTRY_PASSWORD }} <br>Service: Service selector labels are updated to target '-green' workloads.
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
- run: | <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>
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} </tr>
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} <tr>
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
- uses: Azure/k8s-set-context@v1 <td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
with: </tr>
kubeconfig: ${{ secrets.KUBE_CONFIG }} <tr>
<td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td>
- uses: Azure/k8s-create-secret@v1 <td>Acceptable values: true, false</br>Default value: false.</td>
with: </tr>
container-registry-url: contoso.azurecr.io <tr>
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} <td>force </br></br>(Optional)</td>
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} <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>
secret-name: demo-k8s-secret </tr>
<tr>
- uses: Azure/k8s-deploy@v1 <td>annotate-namespace</br></br>(Optional)</td>
with: <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
manifests: | </tr>
manifests/deployment.yml </table>
manifests/service.yml
images: | ## Usage Examples
demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: | ### Basic deployment (without any deployment strategy)
demo-k8s-secret
``` ```yaml
- uses: Azure/k8s-deploy@v3.1
# Contributing with:
namespace: 'myapp'
This project welcomes contributions and suggestions. Most contributions require you to agree to a manifests: |
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us dir/manifestsDirectory
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
When you submit a pull request, a CLA bot will automatically determine whether you need to provide image-pull-secret1
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions image-pull-secret2
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/). ### Private cluster deployment
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. ```yaml
- uses: Azure/k8s-deploy@v4
with:
resource-group: yourResourceGroup
name: yourClusterName
action: deploy
strategy: basic
private-cluster: true
manifests: |
manifests/azure-vote-backend-deployment.yaml
manifests/azure-vote-backend-service.yaml
manifests/azure-vote-frontend-deployment.yaml
manifests/azure-vote-frontend-service.yaml
images: |
registry.azurecr.io/containername
```
### Canary deployment without service mesh
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: deploy
percentage: 20
```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: promote # substitute reject if you want to reject
```
### Canary deployment based on Service Mesh Interface
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
action: deploy
traffic-split-method: smi
percentage: 20
baseline-and-canary-replicas: 1
```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} '
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
dir/manifestsDirectory
strategy: canary
traffic-split-method: smi
action: reject # substitute promote if you want to promote
```
### Blue-Green deployment with different route methods
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
ingress.yml
strategy: blue-green
action: deploy
route-method: ingress # substitute with service/smi as per need
version-switch-buffer: 15
```
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
```yaml
- uses: Azure/k8s-deploy@v3.1
with:
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: |
image-pull-secret1
image-pull-secret2
manifests: |
deployment.yaml
service.yaml
ingress.yml
strategy: blue-green
route-method: ingress # should be the same as the value when action was deploy
action: promote # substitute reject if you want to reject
```
## End to end workflows
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:
### Build container image and deploy to Azure Kubernetes Service cluster
```yaml
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: Azure/docker-login@v1
with:
login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: azure/setup-kubectl@v2.0
# Set the target AKS cluster.
- uses: Azure/aks-set-context@v1
with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso
resource-group: contoso-rg
- uses: Azure/k8s-create-secret@v1.1
with:
container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret
- uses: Azure/k8s-deploy@v3.1
with:
action: deploy
manifests: |
manifests/deployment.yml
manifests/service.yml
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
demo-k8s-secret
```
### Build container image and deploy to any Azure Kubernetes Service cluster
```yaml
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: Azure/docker-login@v1
with:
login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: azure/setup-kubectl@v2.0
- uses: Azure/k8s-set-context@v2
with:
kubeconfig: ${{ secrets.KUBE_CONFIG }}
- uses: Azure/k8s-create-secret@v1.1
with:
container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret
- uses: Azure/k8s-deploy@v3.1
with:
action: deploy
manifests: |
manifests/deployment.yml
manifests/service.yml
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
demo-k8s-secret
```
### Build image and add `dockerfile-path` label to it
We can use this image in other workflows once built.
```yaml
on: [push]
env:
NAMESPACE: demo-ns2
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: Azure/docker-login@v1
with:
login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- run: |
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
```
### Use bake action to get manifests deploying to a Kubernetes cluster
```yaml
on: [push]
env:
NAMESPACE: demo-ns2
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: Azure/docker-login@v1
with:
login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- uses: azure/setup-kubectl@v2.0
# Set the target AKS cluster.
- uses: Azure/aks-set-context@v1
with:
creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso
resource-group: contoso-rg
- uses: Azure/k8s-create-secret@v1.1
with:
namespace: ${{ env.NAMESPACE }}
container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
secret-name: demo-k8s-secret
- 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.
+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 -26
View File
@@ -1,26 +1,80 @@
name: 'Deploy to Kubernetes cluster' name: 'Deploy to Kubernetes cluster'
description: 'Deploy to Kubernetes cluster' 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
namespace: # You also need to have kubectl installed (azure/setup-kubectl)
description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.' namespace:
required: false description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.'
manifests: required: false
description: 'Path to the manifest files which will be used for deployment.' manifests:
required: true description: 'Path to the manifest files which will be used for deployment.'
default: '' required: true
images: images:
description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test'
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:
kubectl-version: 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: 'Version of kubectl. Installs a specific version of kubectl binary' required: false
required: false default: true
branding: strategy:
color: 'green' # optional, decorates the entry in the GitHub Marketplace description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
runs: required: true
using: 'node12' default: 'basic'
main: 'lib/run.js' route-method:
description: 'Route based on service, ingress or SMI for blue-green strategy'
required: false
default: 'service'
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)'
required: false
default: 0
traffic-split-method:
description: 'Traffic split method to be used. Allowed values are pod and smi'
required: false
default: 'pod'
traffic-split-annotations:
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
baseline-and-canary-replicas:
description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)'
required: false
default: 0
percentage:
description: 'Percentage of traffic redirect to canary deployment'
required: false
default: 0
action:
description: 'deploy, promote, or reject'
required: true
default: 'deploy'
force:
description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command'
required: false
default: false
token:
description: 'Github token'
default: ${{ github.token }}
required: true
annotate-namespace:
description: 'Annotate the target namespace'
required: false
default: true
private-cluster:
description: 'True if cluster is AKS private cluster'
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'
+10
View File
@@ -0,0 +1,10 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
'^.+\\.ts$': 'ts-jest'
},
verbose: true
}
-71
View File
@@ -1,71 +0,0 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const os = require("os");
const path = require("path");
const util = require("util");
const fs = require("fs");
const toolCache = require("@actions/tool-cache");
const core = require("@actions/core");
const kubectlToolName = 'kubectl';
const stableKubectlVersion = 'v1.15.0';
const stableVersionUrl = 'https://storage.googleapis.com/kubernetes-release/release/stable.txt';
function getExecutableExtension() {
if (os.type().match(/^Win/)) {
return '.exe';
}
return '';
}
function getkubectlDownloadURL(version) {
switch (os.type()) {
case 'Linux':
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/linux/amd64/kubectl', version);
case 'Darwin':
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/darwin/amd64/kubectl', version);
case 'Windows_NT':
default:
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/windows/amd64/kubectl.exe', version);
}
}
function getStableKubectlVersion() {
return __awaiter(this, void 0, void 0, function* () {
return toolCache.downloadTool(stableVersionUrl).then((downloadPath) => {
let version = fs.readFileSync(downloadPath, 'utf8').toString().trim();
if (!version) {
version = stableKubectlVersion;
}
return version;
}, (error) => {
core.debug(error);
core.warning('GetStableVersionFailed');
return stableKubectlVersion;
});
});
}
exports.getStableKubectlVersion = getStableKubectlVersion;
function downloadKubectl(version) {
return __awaiter(this, void 0, void 0, function* () {
let cachedToolpath = toolCache.find(kubectlToolName, version);
let kubectlDownloadPath = '';
if (!cachedToolpath) {
try {
kubectlDownloadPath = yield toolCache.downloadTool(getkubectlDownloadURL(version));
}
catch (exception) {
throw new Error('DownloadKubectlFailed');
}
cachedToolpath = yield toolCache.cacheFile(kubectlDownloadPath, kubectlToolName + getExecutableExtension(), kubectlToolName, version);
}
const kubectlPath = path.join(cachedToolpath, kubectlToolName + getExecutableExtension());
fs.chmodSync(kubectlPath, '777');
return kubectlPath;
});
}
exports.downloadKubectl = downloadKubectl;
-141
View File
@@ -1,141 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const core = require("@actions/core");
const utils_1 = require("./utils");
function getImagePullSecrets(inputObject) {
if (!inputObject || !inputObject.spec) {
return;
}
if (utils_1.isEqual(inputObject.kind, 'pod')
&& inputObject
&& inputObject.spec
&& inputObject.spec.imagePullSecrets) {
return inputObject.spec.imagePullSecrets;
}
else if (utils_1.isEqual(inputObject.kind, 'cronjob')
&& inputObject
&& inputObject.spec
&& inputObject.spec.jobTemplate
&& inputObject.spec.jobTemplate.spec
&& inputObject.spec.jobTemplate.spec.template
&& inputObject.spec.jobTemplate.spec.template.spec
&& inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets) {
return inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets;
}
else if (inputObject
&& inputObject.spec
&& inputObject.spec.template
&& inputObject.spec.template.spec
&& inputObject.spec.template.spec.imagePullSecrets) {
return inputObject.spec.template.spec.imagePullSecrets;
}
}
function setImagePullSecrets(inputObject, newImagePullSecrets) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) {
return;
}
if (utils_1.isEqual(inputObject.kind, 'pod')) {
if (inputObject
&& inputObject.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.imagePullSecrets = newImagePullSecrets;
}
else {
delete inputObject.spec.imagePullSecrets;
}
}
}
else if (utils_1.isEqual(inputObject.kind, 'cronjob')) {
if (inputObject
&& inputObject.spec
&& inputObject.spec.jobTemplate
&& inputObject.spec.jobTemplate.spec
&& inputObject.spec.jobTemplate.spec.template
&& inputObject.spec.jobTemplate.spec.template.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = newImagePullSecrets;
}
else {
delete inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets;
}
}
}
else if (!!inputObject.spec.template && !!inputObject.spec.template.spec) {
if (inputObject
&& inputObject.spec
&& inputObject.spec.template
&& inputObject.spec.template.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
}
else {
delete inputObject.spec.template.spec.imagePullSecrets;
}
}
}
}
function substituteImageNameInSpecContent(currentString, imageName, imageNameWithNewTag) {
if (currentString.indexOf(imageName) < 0) {
core.debug(`No occurence of replacement token: ${imageName} found`);
return currentString;
}
return currentString.split('\n').reduce((acc, line) => {
const imageKeyword = line.match(/^ *image:/);
if (imageKeyword) {
const [currentImageName, currentImageTag] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing
.split(':');
if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
}
}
return acc + line + '\n';
}, '');
}
function updateContainerImagesInManifestFiles(contents, containers) {
if (!!containers && containers.length > 0) {
containers.forEach((container) => {
let imageName = container.split(':')[0];
if (imageName.indexOf('@') > 0) {
imageName = imageName.split('@')[0];
}
if (contents.indexOf(imageName) > 0) {
contents = substituteImageNameInSpecContent(contents, imageName, container);
}
});
}
return contents;
}
exports.updateContainerImagesInManifestFiles = updateContainerImagesInManifestFiles;
function updateImagePullSecrets(inputObject, newImagePullSecrets) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) {
return;
}
let newImagePullSecretsObjects;
if (newImagePullSecrets.length > 0) {
newImagePullSecretsObjects = Array.from(newImagePullSecrets, x => { return !!x ? { 'name': x } : null; });
}
else {
newImagePullSecretsObjects = [];
}
let existingImagePullSecretObjects = getImagePullSecrets(inputObject);
if (!existingImagePullSecretObjects) {
existingImagePullSecretObjects = new Array();
}
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(newImagePullSecretsObjects);
setImagePullSecrets(inputObject, existingImagePullSecretObjects);
}
exports.updateImagePullSecrets = updateImagePullSecrets;
const workloadTypes = ['deployment', 'replicaset', 'daemonset', 'pod', 'statefulset', 'job', 'cronjob'];
function isWorkloadEntity(kind) {
if (!kind) {
core.debug('ResourceKindNotDefined');
return false;
}
return workloadTypes.some((type) => {
return utils_1.isEqual(type, kind);
});
}
exports.isWorkloadEntity = isWorkloadEntity;
-163
View File
@@ -1,163 +0,0 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const toolCache = require("@actions/tool-cache");
const core = require("@actions/core");
const io = require("@actions/io");
const toolrunner_1 = require("@actions/exec/lib/toolrunner");
const path = require("path");
const fs = require("fs");
const yaml = require("js-yaml");
const utils_1 = require("./utils");
const kubernetes_utils_1 = require("./kubernetes-utils");
const kubectl_util_1 = require("./kubectl-util");
let kubectlPath = "";
function setKubectlPath() {
return __awaiter(this, void 0, void 0, function* () {
if (core.getInput('kubectl-version')) {
const version = core.getInput('kubect-version');
kubectlPath = toolCache.find('kubectl', version);
if (!kubectlPath) {
kubectlPath = yield installKubectl(version);
}
}
else {
kubectlPath = yield io.which('kubectl', false);
if (!kubectlPath) {
const allVersions = toolCache.findAllVersions('kubectl');
kubectlPath = allVersions.length > 0 ? toolCache.find('kubectl', allVersions[0]) : '';
if (!kubectlPath) {
throw new Error('Kubectl is not installed, either add install-kubectl action or provide "kubectl-version" input to download kubectl');
}
kubectlPath = path.join(kubectlPath, `kubectl${utils_1.getExecutableExtension()}`);
}
}
});
}
function deploy(manifests, namespace) {
return __awaiter(this, void 0, void 0, function* () {
if (manifests) {
for (var i = 0; i < manifests.length; i++) {
let manifest = manifests[i];
let toolRunner = new toolrunner_1.ToolRunner(kubectlPath, ['apply', '-f', manifest, '--namespace', namespace]);
yield toolRunner.exec();
}
}
});
}
function checkRolloutStatus(name, kind, namespace) {
return __awaiter(this, void 0, void 0, function* () {
const toolrunner = new toolrunner_1.ToolRunner(kubectlPath, ['rollout', 'status', `${kind.trim()}/${name.trim()}`, `--namespace`, namespace]);
return toolrunner.exec();
});
}
function checkManifestsStability(manifests, namespace) {
return __awaiter(this, void 0, void 0, function* () {
manifests.forEach((manifest) => {
let content = fs.readFileSync(manifest).toString();
yaml.safeLoadAll(content, function (inputObject) {
return __awaiter(this, void 0, void 0, function* () {
if (!!inputObject.kind && !!inputObject.metadata && !!inputObject.metadata.name) {
let kind = inputObject.kind;
switch (kind.toLowerCase()) {
case 'deployment':
case 'daemonset':
case 'statefulset':
yield checkRolloutStatus(inputObject.metadata.name, kind, namespace);
break;
default:
core.debug(`No rollout check for kind: ${inputObject.kind}`);
}
}
});
});
});
});
}
function getManifestFileName(kind, name) {
const filePath = kind + '_' + name + '_' + utils_1.getCurrentTime().toString();
const tempDirectory = process.env['RUNNER_TEMP'];
const fileName = path.join(tempDirectory, path.basename(filePath));
return fileName;
}
function writeObjectsToFile(inputObjects) {
const newFilePaths = [];
if (!!inputObjects) {
inputObjects.forEach((inputObject) => {
try {
const inputObjectString = JSON.stringify(inputObject);
if (!!inputObject.kind && !!inputObject.metadata && !!inputObject.metadata.name) {
const fileName = getManifestFileName(inputObject.kind, inputObject.metadata.name);
fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName);
}
else {
core.debug('Input object is not proper K8s resource object. Object: ' + inputObjectString);
}
}
catch (ex) {
core.debug('Exception occurred while wrting object to file : ' + inputObject + ' . Exception: ' + ex);
}
});
}
return newFilePaths;
}
function updateManifests(manifests, imagesToOverride, imagepullsecrets) {
const newObjectsList = [];
manifests.forEach((filePath) => {
let fileContents = fs.readFileSync(filePath).toString();
fileContents = kubernetes_utils_1.updateContainerImagesInManifestFiles(fileContents, imagesToOverride.split('\n'));
yaml.safeLoadAll(fileContents, function (inputObject) {
if (!!imagepullsecrets && !!inputObject && !!inputObject.kind) {
if (kubernetes_utils_1.isWorkloadEntity(inputObject.kind)) {
kubernetes_utils_1.updateImagePullSecrets(inputObject, imagepullsecrets.split('\n'));
}
}
newObjectsList.push(inputObject);
});
});
return writeObjectsToFile(newObjectsList);
}
function installKubectl(version) {
return __awaiter(this, void 0, void 0, function* () {
if (utils_1.isEqual(version, 'latest')) {
version = yield kubectl_util_1.getStableKubectlVersion();
}
return yield kubectl_util_1.downloadKubectl(version);
});
}
function checkClusterContext() {
if (!process.env["KUBECONFIG"]) {
throw new Error('Cluster context not set. Use k8ssetcontext action to set cluster context');
}
}
function run() {
return __awaiter(this, void 0, void 0, function* () {
checkClusterContext();
yield setKubectlPath();
let manifestsInput = core.getInput('manifests');
if (!manifestsInput) {
core.setFailed('No manifests supplied to deploy');
}
let namespace = core.getInput('namespace');
if (!namespace) {
namespace = 'default';
}
let manifests = manifestsInput.split('\n');
const imagesToOverride = core.getInput('images');
const imagePullSecretsToAdd = core.getInput('imagepullsecrets');
if (!!imagePullSecretsToAdd || !!imagesToOverride) {
manifests = updateManifests(manifests, imagesToOverride, imagePullSecretsToAdd);
}
yield deploy(manifests, namespace);
yield checkManifestsStability(manifests, namespace);
});
}
run().catch(core.setFailed);
-26
View File
@@ -1,26 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const os = require("os");
function isEqual(str1, str2) {
if (!str1)
str1 = "";
if (!str2)
str2 = "";
return str1.toLowerCase() === str2.toLowerCase();
}
exports.isEqual = isEqual;
function getRandomInt(max) {
return Math.floor(Math.random() * Math.floor(max));
}
exports.getRandomInt = getRandomInt;
function getExecutableExtension() {
if (os.type().match(/^Win/)) {
return '.exe';
}
return '';
}
exports.getExecutableExtension = getExecutableExtension;
function getCurrentTime() {
return new Date().getTime();
}
exports.getCurrentTime = getCurrentTime;
+11420 -98
View File
File diff suppressed because it is too large Load Diff
+32 -19
View File
@@ -1,19 +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",
"dependencies": { "coverage": "jest --coverage=true",
"@actions/tool-cache": "^1.0.0", "format": "prettier --write .",
"@actions/io": "^1.0.0", "format-check": "prettier --check ."
"@actions/core": "^1.0.0", },
"@actions/exec": "^1.0.0", "dependencies": {
"js-yaml": "3.13.1" "@actions/core": "^1.2.6",
}, "@actions/exec": "^1.0.0",
"devDependencies": { "@actions/io": "^1.0.0",
"@types/node": "^12.0.10" "@actions/tool-cache": "1.1.2",
} "@octokit/core": "^3.5.1",
} "@octokit/plugin-retry": "^3.0.9",
"@types/minipass": "^3.1.2",
"js-yaml": "3.13.1"
},
"devDependencies": {
"@types/jest": "^26.0.0",
"@types/js-yaml": "^3.12.7",
"@types/node": "^12.20.41",
"jest": "^26.0.0",
"prettier": "^2.7.1",
"ts-jest": "^26.0.0",
"typescript": "3.9.5"
}
}
+79
View File
@@ -0,0 +1,79 @@
import * as core from '@actions/core'
import * as models from '../types/kubernetesTypes'
import * as KubernetesConstants from '../types/kubernetesTypes'
import {Kubectl, Resource} from '../types/kubectl'
import {
getResources,
updateManifestFiles
} from '../utilities/manifestUpdateUtils'
import {
annotateAndLabelResources,
checkManifestStability,
deployManifests
} from '../strategyHelpers/deploymentHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
export async function deploy(
kubectl: Kubectl,
manifestFilePaths: string[],
deploymentStrategy: DeploymentStrategy
) {
// update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths)
core.debug(`Input manifest files: ${inputManifestFiles}`)
// deploy manifests
core.startGroup('Deploying manifests')
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
const deployedManifestFiles = await deployManifests(
inputManifestFiles,
deploymentStrategy,
kubectl,
trafficSplitMethod
)
core.debug(`Deployed manifest files: ${deployedManifestFiles}`)
core.endGroup()
// check manifest stability
core.startGroup('Checking manifest stability')
const resourceTypes: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
])
)
await checkManifestStability(kubectl, resourceTypes)
core.endGroup()
// print ingresses
core.startGroup('Printing ingresses')
const ingressResources: Resource[] = getResources(deployedManifestFiles, [
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
])
for (const ingressResource of ingressResources) {
await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name
)
}
core.endGroup()
// annotate resources
core.startGroup('Annotating resources')
let allPods
try {
allPods = JSON.parse((await kubectl.getAllPods()).stdout)
} catch (e) {
core.debug(`Unable to parse pods: ${e}`)
}
await annotateAndLabelResources(
deployedManifestFiles,
kubectl,
resourceTypes,
allPods
)
core.endGroup()
}
+177
View File
@@ -0,0 +1,177 @@
import * as core from '@actions/core'
import * as deploy from './deploy'
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import {
getResources,
updateManifestFiles
} from '../utilities/manifestUpdateUtils'
import * as models from '../types/kubernetesTypes'
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
import {
deleteGreenObjects,
getManifestObjects,
NONE_LABEL_VALUE
} from '../strategyHelpers/blueGreen/blueGreenHelper'
import {BlueGreenManifests} from '../types/blueGreenTypes'
import {
promoteBlueGreenIngress,
promoteBlueGreenService,
promoteBlueGreenSMI
} from '../strategyHelpers/blueGreen/promote'
import {
routeBlueGreenService,
routeBlueGreenIngressUnchanged,
routeBlueGreenSMI
} from '../strategyHelpers/blueGreen/route'
import {cleanupSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
import {Kubectl, Resource} from '../types/kubectl'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
export async function promote(
kubectl: Kubectl,
manifests: string[],
deploymentStrategy: DeploymentStrategy
) {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY:
await promoteCanary(kubectl, manifests)
break
case DeploymentStrategy.BLUE_GREEN:
await promoteBlueGreen(kubectl, manifests)
break
default:
throw Error('Invalid promote deployment strategy')
}
}
async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
includeServices = true
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
// canary deployment, then update stable deployment and then redirect traffic to stable deployment
core.startGroup('Redirecting traffic to canary deployment')
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
kubectl,
manifests
)
core.endGroup()
core.startGroup('Deploying input manifests with SMI canary strategy')
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
core.startGroup('Redirecting traffic to stable deployment')
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
manifests
)
core.endGroup()
} else {
core.startGroup('Deploying input manifests')
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY)
core.endGroup()
}
core.startGroup('Deleting canary and baseline workloads')
try {
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
manifests,
includeServices
)
} catch (ex) {
core.warning(
`Exception occurred while deleting canary and baseline workloads: ${ex}`
)
}
core.endGroup()
}
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// update container images and pull secrets
const inputManifestFiles: string[] = updateManifestFiles(manifests)
const manifestObjects: BlueGreenManifests =
getManifestObjects(inputManifestFiles)
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
core.startGroup('Deleting old deployment and making new stable deployment')
const {deployResult} = await (async () => {
switch (routeStrategy) {
case RouteStrategy.INGRESS:
return await promoteBlueGreenIngress(kubectl, manifestObjects)
case RouteStrategy.SMI:
return await promoteBlueGreenSMI(kubectl, manifestObjects)
default:
return await promoteBlueGreenService(kubectl, manifestObjects)
}
})()
core.endGroup()
// checking stability of newly created deployments
core.startGroup('Checking manifest stability')
const deployedManifestFiles = deployResult.manifestFiles
const resources: Resource[] = getResources(
deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE
])
)
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
core.endGroup()
core.startGroup(
'Routing to new deployments and deleting old workloads and services'
)
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngressUnchanged(
kubectl,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
)
await deleteGreenObjects(
kubectl,
[].concat(
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
View File
@@ -0,0 +1,77 @@
import * as core from '@actions/core'
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
import {Kubectl} from '../types/kubectl'
import {BlueGreenManifests} from '../types/blueGreenTypes'
import {
rejectBlueGreenIngress,
rejectBlueGreenService,
rejectBlueGreenSMI
} from '../strategyHelpers/blueGreen/reject'
import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
export async function reject(
kubectl: Kubectl,
manifests: string[],
deploymentStrategy: DeploymentStrategy
) {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY:
await rejectCanary(kubectl, manifests)
break
case DeploymentStrategy.BLUE_GREEN:
await rejectBlueGreen(kubectl, manifests)
break
default:
throw 'Invalid delete deployment strategy'
}
}
async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
core.startGroup('Rejecting deployment with SMI canary strategy')
includeServices = true
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
kubectl,
manifests
)
core.endGroup()
}
core.startGroup('Deleting baseline and canary workloads')
await canaryDeploymentHelper.deleteCanaryDeployment(
kubectl,
manifests,
includeServices
)
core.endGroup()
}
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
core.startGroup('Rejecting deployment with blue green strategy')
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
}
-65
View File
@@ -1,65 +0,0 @@
import * as os from 'os';
import * as path from 'path';
import * as util from 'util';
import * as fs from 'fs';
import * as toolCache from '@actions/tool-cache';
import * as core from '@actions/core';
const kubectlToolName = 'kubectl';
const stableKubectlVersion = 'v1.15.0';
const stableVersionUrl = 'https://storage.googleapis.com/kubernetes-release/release/stable.txt';
function getExecutableExtension(): string {
if (os.type().match(/^Win/)) {
return '.exe';
}
return '';
}
function getkubectlDownloadURL(version: string): string {
switch (os.type()) {
case 'Linux':
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/linux/amd64/kubectl', version);
case 'Darwin':
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/darwin/amd64/kubectl', version);
case 'Windows_NT':
default:
return util.format('https://storage.googleapis.com/kubernetes-release/release/%s/bin/windows/amd64/kubectl.exe', version);
}
}
export async function getStableKubectlVersion(): Promise<string> {
return toolCache.downloadTool(stableVersionUrl).then((downloadPath) => {
let version = fs.readFileSync(downloadPath, 'utf8').toString().trim();
if (!version) {
version = stableKubectlVersion;
}
return version;
}, (error) => {
core.debug(error);
core.warning('GetStableVersionFailed');
return stableKubectlVersion;
});
}
export async function downloadKubectl(version: string): Promise<string> {
let cachedToolpath = toolCache.find(kubectlToolName, version);
let kubectlDownloadPath = '';
if (!cachedToolpath) {
try {
kubectlDownloadPath = await toolCache.downloadTool(getkubectlDownloadURL(version));
} catch (exception) {
throw new Error('DownloadKubectlFailed');
}
cachedToolpath = await toolCache.cacheFile(kubectlDownloadPath, kubectlToolName + getExecutableExtension(), kubectlToolName, version);
}
const kubectlPath = path.join(cachedToolpath, kubectlToolName + getExecutableExtension());
fs.chmodSync(kubectlPath, '777');
return kubectlPath;
}
-148
View File
@@ -1,148 +0,0 @@
import * as core from '@actions/core';
import { isEqual } from "./utils";
function getImagePullSecrets(inputObject: any) {
if (!inputObject || !inputObject.spec) {
return;
}
if (isEqual(inputObject.kind, 'pod')
&& inputObject
&& inputObject.spec
&& inputObject.spec.imagePullSecrets) {
return inputObject.spec.imagePullSecrets;
} else if (isEqual(inputObject.kind, 'cronjob')
&& inputObject
&& inputObject.spec
&& inputObject.spec.jobTemplate
&& inputObject.spec.jobTemplate.spec
&& inputObject.spec.jobTemplate.spec.template
&& inputObject.spec.jobTemplate.spec.template.spec
&& inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets) {
return inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets;
} else if (inputObject
&& inputObject.spec
&& inputObject.spec.template
&& inputObject.spec.template.spec
&& inputObject.spec.template.spec.imagePullSecrets) {
return inputObject.spec.template.spec.imagePullSecrets;
}
}
function setImagePullSecrets(inputObject: any, newImagePullSecrets: any) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) {
return;
}
if (isEqual(inputObject.kind, 'pod')) {
if (inputObject
&& inputObject.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.imagePullSecrets = newImagePullSecrets;
} else {
delete inputObject.spec.imagePullSecrets;
}
}
} else if (isEqual(inputObject.kind, 'cronjob')) {
if (inputObject
&& inputObject.spec
&& inputObject.spec.jobTemplate
&& inputObject.spec.jobTemplate.spec
&& inputObject.spec.jobTemplate.spec.template
&& inputObject.spec.jobTemplate.spec.template.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = newImagePullSecrets;
} else {
delete inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets;
}
}
} else if (!!inputObject.spec.template && !!inputObject.spec.template.spec) {
if (inputObject
&& inputObject.spec
&& inputObject.spec.template
&& inputObject.spec.template.spec) {
if (newImagePullSecrets.length > 0) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
} else {
delete inputObject.spec.template.spec.imagePullSecrets;
}
}
}
}
function substituteImageNameInSpecContent(currentString: string, imageName: string, imageNameWithNewTag: string) {
if (currentString.indexOf(imageName) < 0) {
core.debug(`No occurence of replacement token: ${imageName} found`);
return currentString;
}
return currentString.split('\n').reduce((acc, line) => {
const imageKeyword = line.match(/^ *image:/);
if (imageKeyword) {
const [currentImageName, currentImageTag] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing
.split(':');
if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
}
}
return acc + line + '\n';
}, '');
}
export function updateContainerImagesInManifestFiles(contents, containers: string[]): string {
if (!!containers && containers.length > 0) {
containers.forEach((container: string) => {
let imageName = container.split(':')[0];
if (imageName.indexOf('@') > 0) {
imageName = imageName.split('@')[0];
}
if (contents.indexOf(imageName) > 0) {
contents = substituteImageNameInSpecContent(contents, imageName, container);
}
});
}
return contents;
}
export function updateImagePullSecrets(inputObject: any, newImagePullSecrets: string[]) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) {
return;
}
let newImagePullSecretsObjects;
if (newImagePullSecrets.length > 0) {
newImagePullSecretsObjects = Array.from(newImagePullSecrets, x => { return !!x ? { 'name': x } : null; });
} else {
newImagePullSecretsObjects = [];
}
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
if (!existingImagePullSecretObjects) {
existingImagePullSecretObjects = new Array();
}
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(newImagePullSecretsObjects);
setImagePullSecrets(inputObject, existingImagePullSecretObjects);
}
const workloadTypes: string[] = ['deployment', 'replicaset', 'daemonset', 'pod', 'statefulset', 'job', 'cronjob'];
export function isWorkloadEntity(kind: string): boolean {
if (!kind) {
core.debug('ResourceKindNotDefined');
return false;
}
return workloadTypes.some((type: string) => {
return isEqual(type, kind);
});
}
+69 -155
View File
@@ -1,155 +1,69 @@
import * as toolCache from '@actions/tool-cache'; import * as core from '@actions/core'
import * as core from '@actions/core'; import {getKubectlPath, Kubectl} from './types/kubectl'
import * as io from '@actions/io'; import {deploy} from './actions/deploy'
import { ToolRunner } from "@actions/exec/lib/toolrunner"; import {promote} from './actions/promote'
import {reject} from './actions/reject'
import * as path from 'path'; import {Action, parseAction} from './types/action'
import * as fs from 'fs'; import {parseDeploymentStrategy} from './types/deploymentStrategy'
import * as yaml from 'js-yaml'; import {getFilesFromDirectories} from './utilities/fileUtils'
import {PrivateKubectl} from './types/privatekubectl'
import { getExecutableExtension, isEqual, getCurrentTime } from "./utils";
import { isWorkloadEntity, updateContainerImagesInManifestFiles, updateImagePullSecrets } from "./kubernetes-utils"; export async function run() {
import { downloadKubectl, getStableKubectlVersion } from "./kubectl-util"; // verify kubeconfig is set
if (!process.env['KUBECONFIG'])
let kubectlPath = ""; core.warning(
'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.'
async function setKubectlPath() { )
if (core.getInput('kubectl-version')) {
const version = core.getInput('kubect-version'); // get inputs
kubectlPath = toolCache.find('kubectl', version); const action: Action | undefined = parseAction(
if (!kubectlPath) { core.getInput('action', {required: true})
kubectlPath = await installKubectl(version); )
} const strategy = parseDeploymentStrategy(core.getInput('strategy'))
} else { const manifestsInput = core.getInput('manifests', {required: true})
kubectlPath = await io.which('kubectl', false); const manifestFilePaths = manifestsInput
if (!kubectlPath) { .split(/[\n,;]+/) // split into each individual manifest
const allVersions = toolCache.findAllVersions('kubectl'); .map((manifest) => manifest.trim()) // remove surrounding whitespace
kubectlPath = allVersions.length > 0 ? toolCache.find('kubectl', allVersions[0]) : ''; .filter((manifest) => manifest.length > 0) // remove any blanks
if (!kubectlPath) {
throw new Error('Kubectl is not installed, either add install-kubectl action or provide "kubectl-version" input to download kubectl'); const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
} const kubectlPath = await getKubectlPath()
kubectlPath = path.join(kubectlPath, `kubectl${getExecutableExtension()}`); const namespace = core.getInput('namespace') || 'default'
} const isPrivateCluster =
} core.getInput('private-cluster').toLowerCase() === 'true'
} const resourceGroup = core.getInput('resource-group') || ''
const resourceName = core.getInput('name') || ''
async function deploy(manifests: string[], namespace: string) {
if (manifests) { const kubectl = isPrivateCluster
for (var i = 0; i < manifests.length; i++) { ? new PrivateKubectl(
let manifest = manifests[i]; kubectlPath,
let toolRunner = new ToolRunner(kubectlPath, ['apply', '-f', manifest, '--namespace', namespace]); namespace,
await toolRunner.exec(); true,
} resourceGroup,
} resourceName
} )
: new Kubectl(kubectlPath, namespace, true)
async function checkRolloutStatus(name: string, kind: string, namespace: string) {
const toolrunner = new ToolRunner(kubectlPath, ['rollout', 'status', `${kind.trim()}/${name.trim()}`, `--namespace`, namespace]); // run action
return toolrunner.exec(); switch (action) {
} case Action.DEPLOY: {
await deploy(kubectl, fullManifestFilePaths, strategy)
async function checkManifestsStability(manifests: string[], namespace: string) { break
manifests.forEach((manifest) => { }
let content = fs.readFileSync(manifest).toString(); case Action.PROMOTE: {
yaml.safeLoadAll(content, async function (inputObject: any) { await promote(kubectl, fullManifestFilePaths, strategy)
if (!!inputObject.kind && !!inputObject.metadata && !!inputObject.metadata.name) { break
let kind: string = inputObject.kind; }
switch (kind.toLowerCase()) { case Action.REJECT: {
case 'deployment': await reject(kubectl, fullManifestFilePaths, strategy)
case 'daemonset': break
case 'statefulset': }
await checkRolloutStatus(inputObject.metadata.name, kind, namespace); default: {
break; throw Error(
default: 'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
core.debug(`No rollout check for kind: ${inputObject.kind}`) )
} }
} }
}); }
});
} run().catch(core.setFailed)
function getManifestFileName(kind: string, name: string) {
const filePath = kind + '_' + name + '_' + getCurrentTime().toString();
const tempDirectory = process.env['RUNNER_TEMP'];
const fileName = path.join(tempDirectory, path.basename(filePath));
return fileName;
}
function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = [];
if (!!inputObjects) {
inputObjects.forEach((inputObject: any) => {
try {
const inputObjectString = JSON.stringify(inputObject);
if (!!inputObject.kind && !!inputObject.metadata && !!inputObject.metadata.name) {
const fileName = getManifestFileName(inputObject.kind, inputObject.metadata.name);
fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName);
} else {
core.debug('Input object is not proper K8s resource object. Object: ' + inputObjectString);
}
} catch (ex) {
core.debug('Exception occurred while wrting object to file : ' + inputObject + ' . Exception: ' + ex);
}
});
}
return newFilePaths;
}
function updateManifests(manifests: string[], imagesToOverride: string, imagepullsecrets: string): string[] {
const newObjectsList = [];
manifests.forEach((filePath: string) => {
let fileContents = fs.readFileSync(filePath).toString();
fileContents = updateContainerImagesInManifestFiles(fileContents, imagesToOverride.split('\n'));
yaml.safeLoadAll(fileContents, function (inputObject: any) {
if (!!imagepullsecrets && !!inputObject && !!inputObject.kind) {
if (isWorkloadEntity(inputObject.kind)) {
updateImagePullSecrets(inputObject, imagepullsecrets.split('\n'));
}
}
newObjectsList.push(inputObject);
});
});
return writeObjectsToFile(newObjectsList);
}
async function installKubectl(version: string) {
if (isEqual(version, 'latest')) {
version = await getStableKubectlVersion();
}
return await downloadKubectl(version);
}
function checkClusterContext() {
if (!process.env["KUBECONFIG"]) {
throw new Error('Cluster context not set. Use k8ssetcontext action to set cluster context');
}
}
async function run() {
checkClusterContext();
await setKubectlPath();
let manifestsInput = core.getInput('manifests');
if (!manifestsInput) {
core.setFailed('No manifests supplied to deploy');
}
let namespace = core.getInput('namespace');
if (!namespace) {
namespace = 'default';
}
let manifests = manifestsInput.split('\n');
const imagesToOverride = core.getInput('images');
const imagePullSecretsToAdd = core.getInput('imagepullsecrets');
if (!!imagePullSecretsToAdd || !!imagesToOverride) {
manifests = updateManifests(manifests, imagesToOverride, imagePullSecretsToAdd)
}
await deploy(manifests, namespace);
await checkManifestsStability(manifests, namespace);
}
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')
})
})
@@ -0,0 +1,266 @@
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import {DeployResult} from '../../types/deployResult'
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import {
isDeploymentEntity,
isIngressEntity,
isServiceEntity,
KubernetesWorkload
} from '../../types/kubernetesTypes'
import {
BlueGreenDeployment,
BlueGreenManifests
} from '../../types/blueGreenTypes'
import * as fileHelper from '../../utilities/fileUtils'
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
import {
UnsetClusterSpecificDetails,
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
export const GREEN_LABEL_VALUE = 'green'
export const NONE_LABEL_VALUE = 'None'
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color'
export const GREEN_SUFFIX = '-green'
export const STABLE_SUFFIX = '-stable'
export async function deleteGreenObjects(
kubectl: Kubectl,
toDelete: K8sObject[]
): Promise<K8sDeleteObject[]> {
// const resourcesToDelete: K8sDeleteObject[] = []
const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => {
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 deleteObjects(
kubectl: Kubectl,
deleteList: K8sDeleteObject[]
) {
// delete services and deployments
for (const delObject of deleteList) {
try {
const result = await kubectl.delete([delObject.kind, delObject.name])
checkForErrors([result])
} catch (ex) {
core.debug(`failed to delete object ${delObject.name}: ${ex}`)
}
}
}
// other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList: K8sObject[] = []
const routedServiceEntityList: K8sObject[] = []
const unroutedServiceEntityList: K8sObject[] = []
const ingressEntityList: K8sObject[] = []
const otherEntitiesList: K8sObject[] = []
const serviceNameMap = new Map<string, string>()
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) {
const kind = inputObject.kind
const name = inputObject.metadata.name
if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject)
} else if (isServiceEntity(kind)) {
if (isServiceRouted(inputObject, deploymentEntityList)) {
routedServiceEntityList.push(inputObject)
serviceNameMap.set(
name,
getBlueGreenResourceName(name, GREEN_SUFFIX)
)
} else {
unroutedServiceEntityList.push(inputObject)
}
} else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject)
} else {
otherEntitiesList.push(inputObject)
}
}
})
})
return {
serviceEntityList: routedServiceEntityList,
serviceNameMap: serviceNameMap,
unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList
}
}
export function isServiceRouted(
serviceObject: any[],
deploymentEntityList: any[]
): boolean {
const serviceSelector: any = getServiceSelector(serviceObject)
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 deployWithLabel(
kubectl: Kubectl,
deploymentObjectList: any[],
nextLabel: string
): Promise<BlueGreenDeployment> {
const newObjectsList = deploymentObjectList.map((inputObject) =>
getNewBlueGreenObject(inputObject, nextLabel)
)
core.debug(
`objects deployed with label are ${JSON.stringify(newObjectsList)}`
)
const deployResult = await deployObjects(kubectl, newObjectsList)
return {deployResult, objects: newObjectsList}
}
export function getNewBlueGreenObject(
inputObject: any,
labelValue: string
): K8sObject {
const newObject = JSON.parse(JSON.stringify(inputObject))
// Updating name only if label is green label is given
if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name,
GREEN_SUFFIX
)
}
// Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject
}
export function addBlueGreenLabelsAndAnnotations(
inputObject: any,
labelValue: string
) {
//creating the k8s.deploy.color label
const newLabels = new Map<string, string>()
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue
// updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false)
// updating spec labels if it is not a service
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false)
}
}
export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}`
}
export function getDeploymentMatchLabels(deploymentObject: any): any {
if (
deploymentObject?.kind?.toUpperCase() ==
KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels
) {
return deploymentObject.metadata.labels
} else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels
}
}
export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector
}
}
export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any,
matchLabels: any
): boolean {
const serviceSelectorMap = new Map()
const matchLabelsMap = new Map()
JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value)
})
JSON.parse(JSON.stringify(matchLabels), (key, value) => {
matchLabelsMap.set(key, value)
})
let isMatch = true
serviceSelectorMap.forEach((value, key) => {
if (
!!key &&
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value
)
isMatch = false
})
return isMatch
}
export async function fetchResource(
kubectl: Kubectl,
kind: string,
name: string
): Promise<K8sObject> {
const result = await kubectl.getResource(kind, name)
if (result == null || !!result.stderr) {
return null
}
if (!!result.stdout) {
const resource = JSON.parse(result.stdout) as K8sObject
try {
UnsetClusterSpecificDetails(resource)
return resource
} catch (ex) {
core.debug(
`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)
})
})
@@ -0,0 +1,120 @@
import * as core from '@actions/core'
import {K8sIngress} from '../../types/k8sObject'
import {
addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL,
GREEN_LABEL_VALUE,
fetchResource
} from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
const BACKEND = 'backend'
export function getUpdatedBlueGreenIngress(
inputObject: any,
serviceNameMap: Map<string, string>,
type: string
): K8sIngress {
const newObject = JSON.parse(JSON.stringify(inputObject))
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type)
// update ingress labels
if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') {
return updateIngressBackendBetaV1(newObject, serviceNameMap)
}
return updateIngressBackend(newObject, serviceNameMap)
}
export function updateIngressBackendBetaV1(
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(
inputObject: any,
serviceNameMap: Map<string, string>
): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if (
key.toLowerCase() === BACKEND &&
serviceNameMap.has(value.service.name)
) {
value.service.name = serviceNameMap.get(value.service.name)
}
return value
})
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
)
})
})
@@ -0,0 +1,49 @@
import * as core from '@actions/core'
import {K8sServiceObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import {
addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL,
fetchResource,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
// add green labels to configure existing service
export function getUpdatedBlueGreenService(
inputObject: any,
labelValue: string
): K8sServiceObject {
const newObject = JSON.parse(JSON.stringify(inputObject))
// Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
return newObject
}
export async function validateServicesState(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<boolean> {
let areServicesGreen: boolean = true
for (const serviceObject of serviceEntityList) {
// finding the existing routed service
const existingService = await fetchResource(
kubectl,
serviceObject.kind,
serviceObject.metadata.name
)
let isServiceGreen =
!!existingService &&
getServiceSpecLabel(existingService as K8sServiceObject) ==
GREEN_LABEL_VALUE
areServicesGreen = areServicesGreen && isServiceGreen
}
return areServicesGreen
}
export function getServiceSpecLabel(inputObject: K8sServiceObject): string {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL]
}
@@ -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')
})
})
@@ -0,0 +1,210 @@
import * as core from '@actions/core'
import {Kubectl} from '../../types/kubectl'
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import {
deleteObjects,
deployObjects,
fetchResource,
getBlueGreenResourceName,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
GREEN_SUFFIX,
NONE_LABEL_VALUE,
STABLE_SUFFIX
} from './blueGreenHelper'
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
import {
K8sDeleteObject,
K8sObject,
TrafficSplitObject
} from '../../types/k8sObject'
import {DeployResult} from '../../types/deployResult'
import {inputAnnotations} from '../../inputUtils'
export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit'
export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
export const MIN_VAL = 0
export const MAX_VAL = 100
export async function setupSMI(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<BlueGreenDeployment> {
const newObjectsList = []
const trafficObjectList = []
serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service
trafficObjectList.push(serviceObject)
// set up the services for trafficsplit
const newStableService = getStableSMIServiceResource(serviceObject)
const newGreenService = getGreenSMIServiceResource(serviceObject)
newObjectsList.push(newStableService)
newObjectsList.push(newGreenService)
})
const tsObjects: TrafficSplitObject[] = []
// 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)
}
const objectsToDeploy = [].concat(newObjectsList, tsObjects)
// create services
const smiDeploymentResult: DeployResult = await deployObjects(
kubectl,
objectsToDeploy
)
return {
objects: objectsToDeploy,
deployResult: smiDeploymentResult
}
}
let trafficSplitAPIVersion = ''
export async function createTrafficSplitObject(
kubectl: Kubectl,
name: string,
nextLabel: string
): Promise<TrafficSplitObject> {
// cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
// retrieve annotations for TS object
const annotations = inputAnnotations
// 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: 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 function getStableSMIServiceResource(inputObject: K8sObject): K8sObject {
const newObject = JSON.parse(JSON.stringify(inputObject))
// adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name,
STABLE_SUFFIX
)
return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE)
}
export function getGreenSMIServiceResource(inputObject: K8sObject): K8sObject {
const newObject = JSON.parse(JSON.stringify(inputObject))
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE)
}
export async function validateTrafficSplitsState(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<boolean> {
let trafficSplitsInRightState: boolean = true
for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name
let trafficSplitObject = await fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
)
core.debug(
`ts object extracted was ${JSON.stringify(trafficSplitObject)}`
)
if (!trafficSplitObject) {
core.debug(`no traffic split exits for ${name}`)
trafficSplitsInRightState = false
continue
}
trafficSplitObject.spec.backends.forEach((element) => {
// checking if trafficsplit in right state to deploy
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MAX_VAL
}
if (
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MIN_VAL
}
})
}
return trafficSplitsInRightState
}
export async function cleanupSMI(
kubectl: Kubectl,
serviceEntityList: any[]
): Promise<K8sDeleteObject[]> {
const deleteList: K8sDeleteObject[] = []
serviceEntityList.forEach((serviceObject) => {
deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
),
kind: TRAFFIC_SPLIT_OBJECT
})
deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
GREEN_SUFFIX
),
kind: serviceObject.kind
})
deleteList.push({
name: getBlueGreenResourceName(
serviceObject.metadata.name,
STABLE_SUFFIX
),
kind: serviceObject.kind
})
})
// delete all objects
await deleteObjects(kubectl, deleteList)
return deleteList
}
+196
View File
@@ -0,0 +1,196 @@
import {Kubectl} from '../../types/kubectl'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as core from '@actions/core'
import {
isDeploymentEntity,
isServiceEntity,
KubernetesWorkload
} from '../../types/kubernetesTypes'
import * as utils from '../../utilities/manifestUpdateUtils'
import {
updateObjectAnnotations,
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
import {checkForErrors} from '../../utilities/kubectlUtils'
export const CANARY_VERSION_LABEL = 'workflow/version'
const BASELINE_SUFFIX = '-baseline'
export const BASELINE_LABEL_VALUE = 'baseline'
const CANARY_SUFFIX = '-canary'
export const CANARY_LABEL_VALUE = 'canary'
export const STABLE_SUFFIX = '-stable'
export const STABLE_LABEL_VALUE = 'stable'
export async function deleteCanaryDeployment(
kubectl: Kubectl,
manifestFilePaths: string[],
includeServices: boolean
) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) {
throw new Error('Manifest file not found')
}
await cleanUpCanary(kubectl, manifestFilePaths, includeServices)
}
export function markResourceAsStable(inputObject: any): object {
if (isResourceMarkedAsStable(inputObject)) {
return inputObject
}
const newObject = JSON.parse(JSON.stringify(inputObject))
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE)
return newObject
}
export function isResourceMarkedAsStable(inputObject: any): boolean {
return (
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
)
}
export function getStableResource(inputObject: any): object {
const replicaCount = specContainsReplicas(inputObject.kind)
? inputObject.metadata.replicas
: 0
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE)
}
export function getNewBaselineResource(
stableObject: any,
replicas?: number
): object {
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE)
}
export function getNewCanaryResource(
inputObject: any,
replicas?: number
): object {
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE)
}
export async function fetchResource(
kubectl: Kubectl,
kind: string,
name: string
) {
const result = await kubectl.getResource(kind, name)
if (!result || result?.stderr) {
return null
}
if (result.stdout) {
const resource = JSON.parse(result.stdout)
try {
utils.UnsetClusterSpecificDetails(resource)
return resource
} catch (ex) {
core.debug(
`Exception occurred while Parsing ${resource} in JSON object: ${ex}`
)
}
}
}
export function getCanaryResourceName(name: string) {
return name + CANARY_SUFFIX
}
export function getBaselineResourceName(name: string) {
return name + BASELINE_SUFFIX
}
export function getStableResourceName(name: string) {
return name + STABLE_SUFFIX
}
function getNewCanaryObject(
inputObject: any,
replicas: number,
type: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject))
// Updating name
if (type === CANARY_LABEL_VALUE) {
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name)
} else if (type === STABLE_LABEL_VALUE) {
newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
} else {
newObject.metadata.name = getBaselineResourceName(
inputObject.metadata.name
)
}
addCanaryLabelsAndAnnotations(newObject, type)
if (specContainsReplicas(newObject.kind)) {
newObject.spec.replicas = replicas
}
return newObject
}
function specContainsReplicas(kind: string) {
return (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
!isServiceEntity(kind)
)
}
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newLabels = new Map<string, string>()
newLabels[CANARY_VERSION_LABEL] = type
updateObjectLabels(inputObject, newLabels, false)
updateObjectAnnotations(inputObject, newLabels, false)
updateSelectorLabels(inputObject, newLabels, false)
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false)
}
}
async function cleanUpCanary(
kubectl: Kubectl,
files: string[],
includeServices: boolean
) {
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)
}
}
}
}
@@ -0,0 +1,94 @@
import {Kubectl} from '../../types/kubectl'
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as fileHelper from '../../utilities/fileUtils'
import * as canaryDeploymentHelper from './canaryHelper'
import {isDeploymentEntity} from '../../types/kubernetesTypes'
import {getReplicaCount} from '../../utilities/manifestUpdateUtils'
export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
const newObjectsList = []
const percentage = parseInt(core.getInput('percentage'))
if (percentage < 0 || percentage > 100)
throw Error('Percentage must be between 0 and 100')
for (const filePath of filePaths) {
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)) {
core.debug('Calculating replica count for canary')
const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject,
percentage
)
core.debug('Replica count is ' + canaryReplicaCount)
// Get stable object
core.debug('Querying stable object')
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
if (!stableObject) {
core.debug('Stable object not found. Creating canary object')
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
} else {
core.debug(
'Creating canary and baseline objects. Stable object found: ' +
JSON.stringify(stableObject)
)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
core.debug(
'New canary object: ' + JSON.stringify(newCanaryObject)
)
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
core.debug(
'New baseline object: ' + JSON.stringify(newBaselineObject)
)
newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject)
}
} else {
// update non deployment entity as it is
newObjectsList.push(inputObject)
}
}
}
core.debug('New objects list: ' + JSON.stringify(newObjectsList))
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(manifestFiles, forceDeployment)
return {result, newFilePaths: manifestFiles}
}
function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
const inputReplicaCount = getReplicaCount(inputObject)
return Math.round((inputReplicaCount * percentage) / 100)
}
@@ -0,0 +1,330 @@
import {Kubectl} from '../../types/kubectl'
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as fileHelper from '../../utilities/fileUtils'
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
import * as canaryDeploymentHelper from './canaryHelper'
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
import {checkForErrors} from '../../utilities/kubectlUtils'
import {inputAnnotations} from '../../inputUtils'
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
const canaryReplicaCount = parseInt(
core.getInput('baseline-and-canary-replicas')
)
if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
throw Error('Baseline-and-canary-replicas must be between 0 and 100')
const newObjectsList = []
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (isDeploymentEntity(kind)) {
const stableObject = canaryDeploymentHelper.fetchResource(
kubectl,
kind,
name
)
if (!stableObject) {
core.debug(
'Stable object not found. Creating only canary object'
)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
} else {
if (
!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)
) {
throw Error(`StableSpecSelectorNotExist : ${name}`)
}
core.debug(
'Stable object found. Creating canary and baseline objects'
)
const newCanaryObject =
canaryDeploymentHelper.getNewCanaryResource(
inputObject,
canaryReplicaCount
)
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource(
stableObject,
canaryReplicaCount
)
newObjectsList.push(newCanaryObject)
newObjectsList.push(newBaselineObject)
}
} else {
// Update non deployment entity as it is
newObjectsList.push(inputObject)
}
})
})
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(newFilePaths, forceDeployment)
await createCanaryService(kubectl, filePaths)
return {result, newFilePaths}
}
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
const newObjectsList = []
const trafficObjectsList = []
for (const filePath of filePaths) {
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 (isServiceEntity(kind)) {
const newCanaryServiceObject =
canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject)
const newBaselineServiceObject =
canaryDeploymentHelper.getNewBaselineResource(inputObject)
newObjectsList.push(newBaselineServiceObject)
const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
kind,
canaryDeploymentHelper.getStableResourceName(name)
)
if (!stableObject) {
const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject)
newObjectsList.push(newStableServiceObject)
core.debug('Creating the traffic object for service: ' + name)
const trafficObject = await createTrafficSplitManifestFile(
kubectl,
name,
0,
0,
1000
)
trafficObjectsList.push(trafficObject)
} else {
let updateTrafficObject = true
const trafficObject = await canaryDeploymentHelper.fetchResource(
kubectl,
TRAFFIC_SPLIT_OBJECT,
getTrafficSplitResourceName(name)
)
if (trafficObject) {
const trafficJObject = JSON.parse(
JSON.stringify(trafficObject)
)
if (trafficJObject?.spec?.backends) {
trafficJObject.spec.backends.forEach((s) => {
if (
s.service ===
canaryDeploymentHelper.getCanaryResourceName(
name
) &&
s.weight === '1000m'
) {
core.debug('Update traffic objcet not required')
updateTrafficObject = false
}
})
}
}
if (updateTrafficObject) {
core.debug(
'Stable service object present so updating the traffic object for service: ' +
name
)
trafficObjectsList.push(
updateTrafficSplitObject(kubectl, name)
)
}
}
}
}
}
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...trafficObjectsList)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(manifestFiles, forceDeployment)
checkForErrors([result])
}
export async function redirectTrafficToCanaryDeployment(
kubectl: Kubectl,
manifestFilePaths: string[]
) {
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000)
}
export async function redirectTrafficToStableDeployment(
kubectl: Kubectl,
manifestFilePaths: string[]
) {
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
}
async function adjustTraffic(
kubectl: Kubectl,
manifestFilePaths: string[],
stableWeight: number,
canaryWeight: number
) {
if (!manifestFilePaths || manifestFilePaths?.length == 0) {
return
}
const trafficSplitManifests = []
for (const filePath of manifestFilePaths) {
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 (isServiceEntity(kind)) {
trafficSplitManifests.push(
await createTrafficSplitManifestFile(
kubectl,
name,
stableWeight,
0,
canaryWeight
)
)
}
}
}
if (trafficSplitManifests.length <= 0) {
return
}
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
const result = await kubectl.apply(trafficSplitManifests, forceDeployment)
checkForErrors([result])
}
async function updateTrafficSplitObject(
kubectl: Kubectl,
serviceName: string
): Promise<string> {
const percentage = parseInt(core.getInput('percentage'))
if (percentage < 0 || percentage > 100)
throw Error('Percentage must be between 0 and 100')
const percentageWithMuliplier = percentage * 10
const baselineAndCanaryWeight = percentageWithMuliplier / 2
const stableDeploymentWeight = 1000 - percentageWithMuliplier
core.debug(
'Creating the traffic object with canary weight: ' +
baselineAndCanaryWeight +
',baseling weight: ' +
baselineAndCanaryWeight +
',stable: ' +
stableDeploymentWeight
)
return await createTrafficSplitManifestFile(
kubectl,
serviceName,
stableDeploymentWeight,
baselineAndCanaryWeight,
baselineAndCanaryWeight
)
}
async function createTrafficSplitManifestFile(
kubectl: Kubectl,
serviceName: string,
stableWeight: number,
baselineWeight: number,
canaryWeight: number
): Promise<string> {
const smiObjectString = await getTrafficSplitObject(
kubectl,
serviceName,
stableWeight,
baselineWeight,
canaryWeight
)
const manifestFile = fileHelper.writeManifestToFile(
smiObjectString,
TRAFFIC_SPLIT_OBJECT,
serviceName
)
if (!manifestFile) {
throw new Error('Unable to create traffic split manifest file')
}
return manifestFile
}
let trafficSplitAPIVersion = ''
async function getTrafficSplitObject(
kubectl: Kubectl,
name: string,
stableWeight: number,
baselineWeight: number,
canaryWeight: number
): Promise<string> {
// cached version
if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
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
View File
@@ -0,0 +1,230 @@
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as canaryDeploymentHelper from './canary/canaryHelper'
import * as models from '../types/kubernetesTypes'
import {isDeploymentEntity} from '../types/kubernetesTypes'
import * as fileHelper from '../utilities/fileUtils'
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
import {Kubectl, Resource} from '../types/kubectl'
import {deployPodCanary} from './canary/podCanaryHelper'
import {deploySMICanary} from './canary/smiCanaryHelper'
import {DeploymentConfig} from '../types/deploymentConfig'
import {
deployBlueGreen,
deployBlueGreenIngress,
deployBlueGreenService
} from './blueGreen/deploy'
import {deployBlueGreenSMI} from './blueGreen/deploy'
import {DeploymentStrategy} from '../types/deploymentStrategy'
import * as core from '@actions/core'
import {
parseTrafficSplitMethod,
TrafficSplitMethod
} from '../types/trafficSplitMethod'
import {parseRouteStrategy} from '../types/routeStrategy'
import {ExecOutput} from '@actions/exec'
import {
getWorkflowAnnotationKeyLabel,
getWorkflowAnnotations,
cleanLabel
} from '../utilities/workflowAnnotationUtils'
import {
annotateChildPods,
checkForErrors,
getLastSuccessfulRunSha
} from '../utilities/kubectlUtils'
import {
getWorkflowFilePath,
normalizeWorkflowStrLabel
} from '../utilities/githubUtils'
import {getDeploymentConfig} from '../utilities/dockerUtils'
export async function deployManifests(
files: string[],
deploymentStrategy: DeploymentStrategy,
kubectl: Kubectl,
trafficSplitMethod: TrafficSplitMethod
): Promise<string[]> {
switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: {
const {result, newFilePaths} =
trafficSplitMethod == TrafficSplitMethod.SMI
? await deploySMICanary(files, kubectl)
: await deployPodCanary(files, kubectl)
checkForErrors([result])
return newFilePaths
}
case DeploymentStrategy.BLUE_GREEN: {
const routeStrategy = parseRouteStrategy(
core.getInput('route-method', {required: true})
)
const blueGreenDeployment = await deployBlueGreen(
kubectl,
files,
routeStrategy
)
core.debug(
`objects deployed for ${routeStrategy}: ${JSON.stringify(
blueGreenDeployment.objects
)} `
)
checkForErrors([blueGreenDeployment.deployResult.execResult])
return blueGreenDeployment.deployResult.manifestFiles
}
case DeploymentStrategy.BASIC: {
const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true})
)
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
const updatedManifests = appendStableVersionLabelToResource(files)
const result = await kubectl.apply(
updatedManifests,
forceDeployment
)
checkForErrors([result])
} else {
const result = await kubectl.apply(files, forceDeployment)
checkForErrors([result])
}
return files
}
default: {
throw new Error('Deployment strategy is not recognized.')
}
}
}
function appendStableVersionLabelToResource(files: string[]): string[] {
const manifestFiles = []
const newObjectsList = []
files.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, function (inputObject) {
const {kind} = inputObject
if (isDeploymentEntity(kind)) {
const updatedObject =
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject)
} else {
manifestFiles.push(filePath)
}
})
})
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...updatedManifestFiles)
return manifestFiles
}
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[]
): Promise<void> {
await KubernetesManifestUtility.checkManifestStability(kubectl, resources)
}
export async function annotateAndLabelResources(
files: string[],
kubectl: Kubectl,
resourceTypes: Resource[],
allPods: any
) {
const githubToken = core.getInput('token')
const workflowFilePath = await getWorkflowFilePath(githubToken)
const deploymentConfig = await getDeploymentConfig()
const annotationKeyLabel = getWorkflowAnnotationKeyLabel()
await annotateResources(
files,
kubectl,
resourceTypes,
allPods,
annotationKeyLabel,
workflowFilePath,
deploymentConfig
)
await labelResources(files, kubectl, annotationKeyLabel)
}
async function annotateResources(
files: string[],
kubectl: Kubectl,
resourceTypes: Resource[],
allPods: any,
annotationKey: string,
workflowFilePath: string,
deploymentConfig: DeploymentConfig
) {
const annotateResults: ExecOutput[] = []
const namespace = core.getInput('namespace') || 'default'
const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl,
namespace,
annotationKey
)
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
lastSuccessSha,
workflowFilePath,
deploymentConfig
)}`
const annotateNamespace = !(
core.getInput('annotate-namespace').toLowerCase() === 'false'
)
if (annotateNamespace) {
annotateResults.push(
await kubectl.annotate('namespace', namespace, annotationKeyValStr)
)
}
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr))
for (const resource of resourceTypes) {
if (
resource.type.toLowerCase() !==
models.KubernetesWorkload.POD.toLowerCase()
) {
;(
await annotateChildPods(
kubectl,
resource.type,
resource.name,
annotationKeyValStr,
allPods
)
).forEach((execResult) => annotateResults.push(execResult))
}
}
checkForErrors(annotateResults, true)
}
async function labelResources(
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)
}
+22
View File
@@ -0,0 +1,22 @@
import {Action, parseAction} from './action'
describe('Action type', () => {
test('it has required values', () => {
const vals = <any>Object.values(Action)
expect(vals.includes('deploy')).toBe(true)
expect(vals.includes('promote')).toBe(true)
expect(vals.includes('reject')).toBe(true)
})
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)
})
test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction('invalid')).toBe(undefined)
expect(parseAction('unsupportedType')).toBe(undefined)
})
})
+17
View File
@@ -0,0 +1,17 @@
export enum Action {
DEPLOY = 'deploy',
PROMOTE = 'promote',
REJECT = 'reject'
}
/**
* Converts a string to the Action enum
* @param str The action type (case insensitive)
* @returns The Action enum or undefined if it can't be parsed
*/
export const parseAction = (str: string): Action | undefined =>
Action[
Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[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[]
}
+5
View File
@@ -0,0 +1,5 @@
export interface DeploymentConfig {
manifestFilePaths: string[]
helmChartFilePaths: string[]
dockerfilePaths: any
}
+25
View File
@@ -0,0 +1,25 @@
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy'
describe('Deployment strategy type', () => {
test('it has required values', () => {
const vals = <any>Object.values(DeploymentStrategy)
expect(vals.includes('canary')).toBe(true)
expect(vals.includes('blue-green')).toBe(true)
expect(vals.includes('basic')).toBe(true)
})
test('it can parse valid values from a string', () => {
expect(parseDeploymentStrategy('blue-green')).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('Blue-green')).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe(
DeploymentStrategy.BLUE_GREEN
)
expect(parseDeploymentStrategy('blue-greeN')).toBe(
DeploymentStrategy.BLUE_GREEN
)
})
})
+20
View File
@@ -0,0 +1,20 @@
export enum DeploymentStrategy {
BASIC = 'basic',
CANARY = 'canary',
BLUE_GREEN = 'blue-green'
}
/**
* Converts a string to the DeploymentStrategy enum
* @param str The deployment strategy (case insensitive)
* @returns The DeploymentStrategy enum or undefined if it can't be parsed
*/
export const parseDeploymentStrategy = (
str: string
): DeploymentStrategy | undefined =>
DeploymentStrategy[
Object.keys(DeploymentStrategy).filter(
(k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy
]
+98
View File
@@ -0,0 +1,98 @@
import {DockerExec} from './docker'
import * as actions from '@actions/exec'
const dockerPath = 'dockerPath'
const image = 'image'
const args = ['arg1', 'arg2', 'arg3']
describe('Docker class', () => {
const docker = new DockerExec(dockerPath)
describe('with a success exec return', () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
test('pulls an image', async () => {
await docker.pull(image, args)
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['pull', image, ...args],
{silent: false}
)
})
test('pulls an image silently', async () => {
await docker.pull(image, args, true)
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['pull', image, ...args],
{silent: true}
)
})
test('inspects a docker image', async () => {
const result = await docker.inspect(image, args)
expect(result).toBe(execReturn.stdout)
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['inspect', image, ...args],
{silent: false}
)
})
test('inspects a docker image silently', async () => {
const result = await docker.inspect(image, args, true)
expect(result).toBe(execReturn.stdout)
expect(actions.getExecOutput).toBeCalledWith(
dockerPath,
['inspect', image, ...args],
{silent: true}
)
})
})
describe('with an unsuccessful exec return code', () => {
const execReturn = {exitCode: 3, stdout: '', stderr: ''}
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow()
})
test('inspects a docker image', async () => {
const result = await expect(
docker.inspect(image, args)
).rejects.toThrow()
})
})
describe('with an unsuccessful exec return code', () => {
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'}
beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
test('pulls an image', async () => {
await expect(docker.pull(image, args)).rejects.toThrow()
})
test('inspects a docker image', async () => {
const result = await expect(
docker.inspect(image, args)
).rejects.toThrow()
})
})
})
+32
View File
@@ -0,0 +1,32 @@
import {getExecOutput} from '@actions/exec'
export class DockerExec {
private readonly dockerPath: string
constructor(dockerPath: string) {
this.dockerPath = dockerPath
}
public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(['pull', image, ...args], silent)
if (result.stderr != '' || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`)
}
}
public async inspect(
image: string,
args: string[],
silent: boolean = false
): Promise<string> {
const result = await this.execute(['inspect', image, ...args], silent)
if (result.stderr != '' || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`)
return result.stdout
}
private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, {silent})
}
}
+40
View File
@@ -0,0 +1,40 @@
import * as core from '@actions/core'
import {Octokit} from '@octokit/core'
import {Endpoints} from '@octokit/types'
import {retry} from '@octokit/plugin-retry'
export const OkStatusCode = 200
const RetryOctokit = Octokit.plugin(retry)
const RETRY_COUNT = 5
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows'
type responseType =
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response']
export class GitHubClient {
private readonly repository: string
private readonly token: string
constructor(repository: string, token: string) {
this.repository = repository
this.token = token
}
// prettier-ignore
public async getWorkflows(): Promise<responseType> {
const octokit = new RetryOctokit({
auth: this.token,
request: {retries: RETRY_COUNT},
baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com",
})
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
}
+367
View File
@@ -0,0 +1,367 @@
import {getKubectlPath, Kubectl} from './kubectl'
import * as exec from '@actions/exec'
import * as io from '@actions/io'
import * as core from '@actions/core'
import * as toolCache from '@actions/tool-cache'
import {config} from 'process'
describe('Kubectl path', () => {
const version = '1.1'
const path = 'path'
it('gets the kubectl path', async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
expect(await getKubectlPath()).toBe(path)
})
it('gets the kubectl path with version', async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version)
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path)
expect(await getKubectlPath()).toBe(path)
})
it('throws if kubectl not found', async () => {
// without version
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow()
// with verision
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => getKubectlPath()).rejects.toThrow()
})
})
const kubectlPath = 'kubectlPath'
const testNamespace = 'testNamespace'
const defaultNamespace = 'default'
describe('Kubectl class', () => {
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
describe('omits default namespace from commands', () => {
it('executes a command without appending --namespace arg', async () => {
// no args
const command = 'command'
expect(await kubectl.executeCommand(command)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(kubectlPath, [command], {
silent: false
})
})
})
})
describe('with a success exec return in testNamespace', () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
return execReturn
})
})
it('applies a configuration with a single config path', async () => {
const configPaths = 'configPaths'
const result = await kubectl.apply(configPaths)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace],
{silent: false}
)
})
it('applies a configuration with multiple config paths', async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3']
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 force when specified', async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3']
const result = await kubectl.apply(configPaths, true)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'apply',
'-f',
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
'--force',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('describes a resource', async () => {
const resourceType = 'type'
const resourceName = 'name'
const result = await kubectl.describe(resourceType, resourceName)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{silent: false}
)
})
it('describes a resource silently', async () => {
const resourceType = 'type'
const resourceName = 'name'
const result = await kubectl.describe(resourceType, resourceName, true)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'describe',
resourceType,
resourceName,
'--namespace',
testNamespace
],
{silent: true}
)
})
it('annotates resource', async () => {
const resourceType = 'type'
const resourceName = 'name'
const annotation = 'annotation'
const result = await kubectl.annotate(
resourceType,
resourceName,
annotation
)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
resourceType,
resourceName,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('annotates files with single file', async () => {
const file = 'file'
const annotation = 'annotation'
const result = await kubectl.annotateFiles(file, annotation)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
file,
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('annotates files with mulitple files', async () => {
const files = ['file1', 'file2', 'file3']
const annotation = 'annotation'
const result = await kubectl.annotateFiles(files, annotation)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'annotate',
'-f',
files.join(','),
annotation,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('labels files with single file', async () => {
const file = 'file'
const labels = ['label1', 'label2']
const result = await kubectl.labelFiles(file, labels)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
file,
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('labels files with multiple files', async () => {
const files = ['file1', 'file2', 'file3']
const labels = ['label1', 'label2']
const result = await kubectl.labelFiles(files, labels)
expect(result).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'label',
'-f',
files.join(','),
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('gets all pods', async () => {
expect(await kubectl.getAllPods()).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['get', 'pods', '-o', 'json', '--namespace', testNamespace],
{silent: true}
)
})
it('checks rollout status', async () => {
const resourceType = 'type'
const name = 'name'
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
execReturn
)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'rollout',
'status',
`${resourceType}/${name}`,
'--namespace',
testNamespace
],
{silent: false}
)
})
it('gets resource', async () => {
const resourceType = 'type'
const name = 'name'
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
'get',
`${resourceType}/${name}`,
'-o',
'json',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('executes a command', async () => {
// no args
const command = 'command'
expect(await kubectl.executeCommand(command)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, '--namespace', testNamespace],
{silent: false}
)
// with args
const args = 'args'
expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[command, args, '--namespace', testNamespace],
{silent: false}
)
})
it('deletes with single argument', async () => {
const arg = 'argument'
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 args = ['argument1', 'argument2', 'argument3']
expect(await kubectl.delete(args)).toBe(execReturn)
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
['delete', ...args, '--namespace', testNamespace],
{silent: false}
)
})
})
it('gets new replica sets', async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace)
const newReplicaSetName = 'newreplicaset'
const name = 'name'
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra',
stderr: ''
}
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
return describeReturn
})
const deployment = 'deployment'
const result = await kubectl.getNewReplicaSet(deployment)
expect(result).toBe(name)
})
})
+188
View File
@@ -0,0 +1,188 @@
import {ExecOutput, getExecOutput} from '@actions/exec'
import {createInlineArray} from '../utilities/arrayUtils'
import * as core from '@actions/core'
import * as toolCache from '@actions/tool-cache'
import * as io from '@actions/io'
export interface Resource {
name: string
type: string
}
export class Kubectl {
protected readonly kubectlPath: string
protected readonly namespace: string
protected readonly ignoreSSLErrors: boolean
protected readonly resourceGroup: string
protected readonly name: string
protected isPrivateCluster: boolean
constructor(
kubectlPath: string,
namespace: string = 'default',
ignoreSSLErrors: boolean = false,
resourceGroup: string = '',
name: string = ''
) {
this.kubectlPath = kubectlPath
this.ignoreSSLErrors = !!ignoreSSLErrors
this.namespace = namespace
this.resourceGroup = resourceGroup
this.name = name
}
public async apply(
configurationPaths: string | string[],
force: boolean = false
): Promise<ExecOutput> {
try {
if (!configurationPaths || configurationPaths?.length === 0)
throw Error('Configuration paths must exist')
const applyArgs: string[] = [
'apply',
'-f',
createInlineArray(configurationPaths)
]
if (force) applyArgs.push('--force')
return await this.execute(applyArgs)
} catch (err) {
core.debug('Kubectl apply failed:' + err)
}
}
public async describe(
resourceType: string,
resourceName: string,
silent: boolean = false
): Promise<ExecOutput> {
return await this.execute(
['describe', resourceType, resourceName],
silent
)
}
public async getNewReplicaSet(deployment: string) {
const result = await this.describe('deployment', deployment, true)
let newReplicaSet = ''
if (result?.stdout) {
const stdout = result.stdout.split('\n')
stdout.forEach((line: string) => {
const newreplicaset = 'newreplicaset'
if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
newReplicaSet = line
.substring(newreplicaset.length)
.trim()
.split(' ')[0]
})
}
return newReplicaSet
}
public async annotate(
resourceType: string,
resourceName: string,
annotation: string
): Promise<ExecOutput> {
const args = [
'annotate',
resourceType,
resourceName,
annotation,
'--overwrite'
]
return await this.execute(args)
}
public async annotateFiles(
files: string | string[],
annotation: string
): Promise<ExecOutput> {
const args = [
'annotate',
'-f',
createInlineArray(files),
annotation,
'--overwrite'
]
return await this.execute(args)
}
public async labelFiles(
files: string | string[],
labels: string[]
): Promise<ExecOutput> {
const args = [
'label',
'-f',
createInlineArray(files),
...labels,
'--overwrite'
]
return await this.execute(args)
}
public async getAllPods(): Promise<ExecOutput> {
return await this.execute(['get', 'pods', '-o', 'json'], true)
}
public async checkRolloutStatus(
resourceType: string,
name: string
): Promise<ExecOutput> {
return await this.execute([
'rollout',
'status',
`${resourceType}/${name}`
])
}
public async getResource(
resourceType: string,
name: string
): Promise<ExecOutput> {
return await this.execute([
'get',
`${resourceType}/${name}`,
'-o',
'json'
])
}
public executeCommand(command: string, args?: string) {
if (!command) throw new Error('Command must be defined')
return args ? this.execute([command, args]) : this.execute([command])
}
public delete(args: string | string[]) {
if (typeof args === 'string') return this.execute(['delete', args])
return this.execute(['delete', ...args])
}
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
}
+117
View File
@@ -0,0 +1,117 @@
import {
DEPLOYMENT_TYPES,
DiscoveryAndLoadBalancerResource,
isDeploymentEntity,
isIngressEntity,
isServiceEntity,
isWorkloadEntity,
KubernetesWorkload,
ResourceKindNotDefinedError,
ServiceTypes,
WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS
} from './kubernetesTypes'
describe('Kubernetes types', () => {
it('contains kubernetes workloads', () => {
expect(KubernetesWorkload.POD).toBe('Pod')
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset')
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment')
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet')
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet')
expect(KubernetesWorkload.JOB).toBe('job')
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob')
})
it('contains discovery and load balancer resources', () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service')
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress')
})
it('contains service types', () => {
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer')
expect(ServiceTypes.NODE_PORT).toBe('NodePort')
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP')
})
it('contains deployment types', () => {
const expected = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset'
]
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true)
})
it('contains workload types', () => {
const expected = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset',
'job',
'cronjob'
]
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true)
})
it('contains workload types with rollout status', () => {
const expected = ['deployment', 'daemonset', 'statefulset']
expect(
expected.every((val) =>
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val)
)
).toBe(true)
})
it('checks if kind is deployment entity', () => {
// throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow(
ResourceKindNotDefinedError
)
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', () => {
// throws on no kind
expect(() => isWorkloadEntity(undefined)).toThrow(
ResourceKindNotDefinedError
)
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', () => {
// throws on no kind
expect(() => isServiceEntity(undefined)).toThrow(
ResourceKindNotDefinedError
)
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', () => {
// throws on no kind
expect(() => isIngressEntity(undefined)).toThrow(
ResourceKindNotDefinedError
)
expect(isIngressEntity('ingress')).toBe(true)
expect(isIngressEntity('Ingress')).toBe(true)
expect(isIngressEntity('ingresS')).toBe(true)
expect(isIngressEntity('INGRESS')).toBe(true)
})
})
+81
View File
@@ -0,0 +1,81 @@
export class KubernetesWorkload {
public static POD: string = 'Pod'
public static REPLICASET: string = 'Replicaset'
public static DEPLOYMENT: string = 'Deployment'
public static STATEFUL_SET: string = 'StatefulSet'
public static DAEMON_SET: string = 'DaemonSet'
public static JOB: string = 'job'
public static CRON_JOB: string = 'cronjob'
}
export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = 'service'
public static INGRESS: string = 'ingress'
}
export class ServiceTypes {
public static LOAD_BALANCER: string = 'LoadBalancer'
public static NODE_PORT: string = 'NodePort'
public static CLUSTER_IP: string = 'ClusterIP'
}
export const DEPLOYMENT_TYPES: string[] = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset'
]
export const WORKLOAD_TYPES: string[] = [
'deployment',
'replicaset',
'daemonset',
'pod',
'statefulset',
'job',
'cronjob'
]
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
'deployment',
'daemonset',
'statefulset'
]
export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase()
})
}
export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase()
)
}
export function isServiceEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
return 'service' === kind.toLowerCase()
}
export function isIngressEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError
return 'ingress' === kind.toLowerCase()
}
export const ResourceKindNotDefinedError = Error('Resource kind not defined')
export const NullInputObjectError = Error('Null inputObject')
export const InputObjectKindNotDefinedError = Error(
'Input object kind not defined'
)
export const InputObjectMetadataNotDefinedError = Error(
'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"
)
})
}
}
+22
View File
@@ -0,0 +1,22 @@
import {parseRouteStrategy, RouteStrategy} from './routeStrategy'
describe('Route strategy type', () => {
test('it has required values', () => {
const vals = <any>Object.values(RouteStrategy)
expect(vals.includes('ingress')).toBe(true)
expect(vals.includes('smi')).toBe(true)
expect(vals.includes('service')).toBe(true)
})
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)
})
test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy('invalid')).toBe(undefined)
expect(parseRouteStrategy('unsupportedType')).toBe(undefined)
})
})
+12
View File
@@ -0,0 +1,12 @@
export enum RouteStrategy {
INGRESS = 'ingress',
SMI = 'smi',
SERVICE = 'service'
}
export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
RouteStrategy[
Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy
]
+21
View File
@@ -0,0 +1,21 @@
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod'
describe('Traffic split method type', () => {
test('it has required values', () => {
const vals = <any>Object.values(TrafficSplitMethod)
expect(vals.includes('pod')).toBe(true)
expect(vals.includes('smi')).toBe(true)
})
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)
})
test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod('invalid')).toBe(undefined)
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined)
})
})
+19
View File
@@ -0,0 +1,19 @@
export enum TrafficSplitMethod {
POD = 'pod',
SMI = 'smi'
}
/**
* Converts a string to the TrafficSplitMethod enum
* @param str The traffic split method (case insensitive)
* @returns The TrafficSplitMethod enum or undefined if it can't be parsed
*/
export const parseTrafficSplitMethod = (
str: string
): TrafficSplitMethod | undefined =>
TrafficSplitMethod[
Object.keys(TrafficSplitMethod).filter(
(k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod
]
+12
View File
@@ -0,0 +1,12 @@
import {createInlineArray} from './arrayUtils'
describe('array utilities', () => {
it('creates an inline array', () => {
const strings = ['str1', 'str2', 'str3']
expect(createInlineArray(strings)).toBe(strings.join(','))
const string = 'str1'
expect(createInlineArray([string])).toBe(string)
expect(createInlineArray(string)).toBe(string)
})
})
+6
View File
@@ -0,0 +1,6 @@
export function createInlineArray(str: string | string[]): string {
if (typeof str === 'string') {
return str
}
return str.join(',')
}
+15
View File
@@ -0,0 +1,15 @@
import * as io from '@actions/io'
import {checkDockerPath} from './dockerUtils'
describe('docker utilities', () => {
it('checks if docker is installed', async () => {
// docker installed
const path = 'path'
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
expect(() => checkDockerPath()).not.toThrow()
// docker not installed
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
await expect(() => checkDockerPath()).rejects.toThrow()
})
})
+75
View File
@@ -0,0 +1,75 @@
import * as io from '@actions/io'
import {DeploymentConfig} from '../types/deploymentConfig'
import * as core from '@actions/core'
import {DockerExec} from '../types/docker'
import {getNormalizedPath} from './githubUtils'
export async function getDeploymentConfig(): Promise<DeploymentConfig> {
let helmChartPaths: string[] =
process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') ||
[]
helmChartPaths = helmChartPaths.map((helmchart) =>
getNormalizedPath(helmchart.trim())
)
let inputManifestFiles: string[] =
core
.getInput('manifests')
.split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || []
if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile)
)
}
const imageNames = core.getInput('images').split('\n') || []
const imageDockerfilePathMap: {[id: string]: string} = {}
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false')
if (pullImages) {
//Fetching from image label if available
for (const image of imageNames) {
try {
imageDockerfilePathMap[image] = await getDockerfilePath(image)
} catch (ex) {
core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} `
)
}
}
}
return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap
})
}
async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath()
const dockerExec: DockerExec = new DockerExec('docker')
await dockerExec.pull(image, [], false)
const imageInspectResult: string = await dockerExec.inspect(image, [], false)
const imageConfig = JSON.parse(imageInspectResult)[0]
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path'
let pathValue: string = ''
if (
imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY]
pathValue = getNormalizedPath(pathLabel)
}
return Promise.resolve(pathValue)
}
export async function checkDockerPath() {
const dockerPath = await io.which('docker', false)
if (!dockerPath) {
throw new Error('Docker is not installed.')
}
}
+63
View File
@@ -0,0 +1,63 @@
import {getFilesFromDirectories} from './fileUtils'
import * as path from 'path'
describe('File utils', () => {
it('detects files in nested directories and ignores non-manifest files and empty dirs', () => {
const testPath = path.join('test', 'unit', 'manifests')
const testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = [
'test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml',
'test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml',
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml',
'test/unit/manifests/test-ingress.yml',
'test/unit/manifests/test-ingress-new.yml',
'test/unit/manifests/test-service.yml'
]
// is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(7)
expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(fileName)
})
})
it('crashes when an invalid file is provided', () => {
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
const goodPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect(() => {
getFilesFromDirectories([badPath, goodPath])
}).toThrowError()
})
it("doesn't duplicate files when nested dir included", () => {
const outerPath = path.join('test', 'unit', 'manifests')
const fileAtOuter = path.join(
'test',
'unit',
'manifests',
'test-service.yml'
)
const innerPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect(
getFilesFromDirectories([outerPath, fileAtOuter, innerPath])
).toHaveLength(7)
})
})
// 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
View File
@@ -0,0 +1,116 @@
import * as fs from 'fs'
import * as path from 'path'
import * as core from '@actions/core'
import * as os from 'os'
import {getCurrentTime} from './timeUtils'
export function getTempDirectory(): string {
return process.env['runner.tempDirectory'] || os.tmpdir()
}
export function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = []
inputObjects.forEach((inputObject: any) => {
try {
const inputObjectString = JSON.stringify(inputObject)
if (inputObject?.metadata?.name) {
const fileName = getManifestFileName(
inputObject.kind,
inputObject.metadata.name
)
fs.writeFileSync(path.join(fileName), inputObjectString)
newFilePaths.push(fileName)
} else {
core.debug(
'Input object is not proper K8s resource object. Object: ' +
inputObjectString
)
}
} catch (ex) {
core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}`
)
}
})
return newFilePaths
}
export function writeManifestToFile(
inputObjectString: string,
kind: string,
name: string
): string {
if (inputObjectString) {
try {
const fileName = getManifestFileName(kind, name)
fs.writeFileSync(path.join(fileName), inputObjectString)
return fileName
} catch (ex) {
throw Error(
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
)
}
}
}
function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_${getCurrentTime().toString()}`
const tempDirectory = getTempDirectory()
return path.join(tempDirectory, path.basename(filePath))
}
export function getFilesFromDirectories(filePaths: string[]): string[] {
const fullPathSet: Set<string> = new Set<string>()
filePaths.forEach((fileName) => {
try {
if (fs.lstatSync(fileName).isDirectory()) {
recurisveManifestGetter(fileName).forEach((file) => {
fullPathSet.add(file)
})
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
fullPathSet.add(fileName)
} else {
core.debug(
`Detected non-manifest file, ${fileName}, continuing... `
)
}
} catch (ex) {
throw Error(
`Exception occurred while reading the file ${fileName}: ${ex}`
)
}
})
return Array.from(fullPathSet)
}
function recurisveManifestGetter(dirName: string): string[] {
const toRet: string[] = []
fs.readdirSync(dirName).forEach((fileName) => {
const fnwd: string = path.join(dirName, fileName)
if (fs.lstatSync(fnwd).isDirectory()) {
toRet.push(...recurisveManifestGetter(fnwd))
} else if (
getFileExtension(fileName) === 'yml' ||
getFileExtension(fileName) === 'yaml'
) {
toRet.push(path.join(dirName, fileName))
} else {
core.debug(`Detected non-manifest file, ${fileName}, continuing... `)
}
})
return toRet
}
function getFileExtension(fileName: string) {
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
}
+48
View File
@@ -0,0 +1,48 @@
import {
getNormalizedPath,
isHttpUrl,
normalizeWorkflowStrLabel
} from './githubUtils'
describe('Github utils', () => {
it('normalizes workflow string labels', () => {
const workflowsPath = '.github/workflows/'
const path = 'test/path/test'
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path)
expect(normalizeWorkflowStrLabel(path)).toBe(path)
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath
)
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe(
path + '_' + path
)
})
it('normalizes path', () => {
const httpUrl = 'http://www.test.com'
expect(getNormalizedPath(httpUrl)).toBe(httpUrl)
const httpsUrl = 'https://www.test.com'
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl)
const repo = 'gh_repo'
const sha = 'gh_sha'
const path = 'path'
process.env.GITHUB_REPOSITORY = repo
process.env.GITHUB_SHA = sha
expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}`
)
})
it('checks if url is http', () => {
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('https://www.test.com')).toBe(true)
expect(isHttpUrl('http://wwww.test.com')).toBe(true)
})
})
+54
View File
@@ -0,0 +1,54 @@
import {GitHubClient, OkStatusCode} from '../types/githubClient'
import * as core from '@actions/core'
export async function getWorkflowFilePath(
githubToken: string
): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW
if (!workflowFilePath.startsWith('.github/workflows/')) {
const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY,
githubToken
)
const response = await githubClient.getWorkflows()
if (response) {
if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path
break
}
}
}
} else if (response.status != OkStatusCode) {
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`)
}
}
return Promise.resolve(workflowFilePath)
}
export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = '.github/workflows/'
workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, '')
: workflowName
return workflowName.replace(/ /g, '_')
}
export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) {
//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 pathValue
}
export function isHttpUrl(url: string) {
return /^https?:\/\/.*$/.test(url)
}
+61
View File
@@ -0,0 +1,61 @@
import * as core from '@actions/core'
import {ExecOutput} from '@actions/exec'
import {checkForErrors} from './kubectlUtils'
describe('Kubectl utils', () => {
it('checks for errors', () => {
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0}
const successWithStderr: ExecOutput = {
stderr: 'error',
stdout: '',
exitCode: 0
}
const failWithExitCode: ExecOutput = {
stderr: '',
stdout: '',
exitCode: 1
}
const failWithExitWithStderr: ExecOutput = {
stderr: 'error',
stdout: '',
exitCode: 2
}
// with throw behavior
expect(() => checkForErrors([success])).not.toThrow()
expect(() => checkForErrors([successWithStderr])).not.toThrow()
expect(() => checkForErrors([success, successWithStderr])).not.toThrow()
expect(() => checkForErrors([failWithExitCode])).toThrow()
expect(() => checkForErrors([failWithExitWithStderr])).toThrow()
expect(() => checkForErrors([success, failWithExitCode])).toThrow()
expect(() =>
checkForErrors([successWithStderr, failWithExitCode])
).toThrow()
expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow()
expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow()
// with warn behavior
jest.spyOn(core, 'warning').mockImplementation(() => {})
let warningCalls = 0
expect(() => checkForErrors([success], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(warningCalls)
expect(() => checkForErrors([successWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() =>
checkForErrors([success, successWithStderr], true)
).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow()
expect(core.warning).toBeCalledTimes(++warningCalls)
})
})
+86
View File
@@ -0,0 +1,86 @@
import * as core from '@actions/core'
import {ExecOutput} from '@actions/exec'
import {Kubectl} from '../types/kubectl'
export function checkForErrors(
execResults: ExecOutput[],
warnIfError?: boolean
) {
let stderr = ''
execResults.forEach((result) => {
if (result?.exitCode !== 0) {
stderr += result?.stderr + ' \n'
} else if (result?.stderr) {
core.warning(result.stderr)
}
})
if (stderr.length > 0) {
if (warnIfError) {
core.warning(stderr.trim())
} else {
throw new Error(stderr.trim())
}
}
}
export async function getLastSuccessfulRunSha(
kubectl: Kubectl,
namespaceName: string,
annotationKey: string
): Promise<string> {
try {
const result = await kubectl.getResource('namespace', namespaceName)
if (result?.stderr) {
core.warning(result.stderr)
return process.env.GITHUB_SHA
} else if (result?.stdout) {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations
if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit
} else {
return 'NA'
}
}
} catch (ex) {
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`)
return ''
}
}
export async function annotateChildPods(
kubectl: Kubectl,
resourceType: string,
resourceName: string,
annotationKeyValStr: string,
allPods
): Promise<ExecOutput[]> {
let owner = resourceName
if (resourceType.toLowerCase().indexOf('deployment') > -1) {
owner = await kubectl.getNewReplicaSet(resourceName)
}
const commandExecutionResults = []
if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences
if (owners) {
for (const ownerRef of owners) {
if (ownerRef.name === owner) {
commandExecutionResults.push(
kubectl.annotate(
'pod',
pod.metadata.name,
annotationKeyValStr
)
)
break
}
}
}
})
}
return await Promise.all(commandExecutionResults)
}
+48
View File
@@ -0,0 +1,48 @@
import {KubernetesWorkload} from '../types/kubernetesTypes'
export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null
if (
inputObject.kind.toLowerCase() ===
KubernetesWorkload.CRON_JOB.toLowerCase()
)
return inputObject?.spec?.jobTemplate?.spec?.template?.spec
?.imagePullSecrets
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets
if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets
}
}
export function setImagePullSecrets(
inputObject: any,
newImagePullSecrets: any
) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return
if (
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
) {
inputObject.spec.imagePullSecrets = newImagePullSecrets
return
}
if (
inputObject.kind.toLowerCase() ===
KubernetesWorkload.CRON_JOB.toLowerCase()
) {
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
newImagePullSecrets
return
}
if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets
return
}
}
+73
View File
@@ -0,0 +1,73 @@
import {
InputObjectKindNotDefinedError,
isServiceEntity,
KubernetesWorkload,
NullInputObjectError
} from '../types/kubernetesTypes'
export function updateSpecLabels(
inputObject: any,
newLabels: Map<string, string>,
override: boolean
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (!newLabels) return
let existingLabels = getSpecLabels(inputObject)
if (override) {
existingLabels = newLabels
} else {
existingLabels = existingLabels || new Map<string, string>()
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
}
setSpecLabels(inputObject, existingLabels)
}
function getSpecLabels(inputObject: any) {
if (!inputObject) return null
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels
if (inputObject?.spec?.template?.metadata)
return inputObject.spec.template.metadata.labels
return null
}
function setSpecLabels(inputObject: any, newLabels: any) {
if (!inputObject || !newLabels) return null
if (
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
) {
inputObject.metadata.labels = newLabels
return
}
if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels
return
}
}
export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector
else return inputObject.spec.selector.matchLabels
}
}
export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels
else inputObject.spec.selector.matchLabels = newLabels
}
}
+189
View File
@@ -0,0 +1,189 @@
import * as core from '@actions/core'
import * as KubernetesConstants from '../types/kubernetesTypes'
import {Kubectl, Resource} from '../types/kubectl'
import {checkForErrors} from './kubectlUtils'
import {sleep} from './timeUtils'
export async function checkManifestStability(
kubectl: Kubectl,
resources: Resource[]
): Promise<void> {
let rolloutStatusHasErrors = false
for (let i = 0; i < resources.length; i++) {
const resource = resources[i]
if (
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
resource.type.toLowerCase()
) >= 0
) {
try {
const result = await kubectl.checkRolloutStatus(
resource.type,
resource.name
)
checkForErrors([result])
} catch (ex) {
core.error(ex)
await kubectl.describe(resource.type, resource.name)
rolloutStatusHasErrors = true
}
}
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
try {
await checkPodStatus(kubectl, resource.name)
} catch (ex) {
core.warning(
`Could not determine pod status: ${JSON.stringify(ex)}`
)
await kubectl.describe(resource.type, resource.name)
}
}
if (
resource.type ==
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
) {
try {
const service = await getService(kubectl, resource.name)
const {spec, status} = service
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
if (!isLoadBalancerIPAssigned(status)) {
await waitForServiceExternalIPAssignment(
kubectl,
resource.name
)
} else {
core.info(
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
)
}
}
} catch (ex) {
core.warning(
`Could not determine service status of: ${resource.name} Error: ${ex}`
)
await kubectl.describe(resource.type, resource.name)
}
}
}
if (rolloutStatusHasErrors) {
throw new Error('Rollout status error')
}
}
export async function checkPodStatus(
kubectl: Kubectl,
podName: string
): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout
let podStatus
let kubectlDescribeNeeded = false
for (let i = 0; i < iterations; i++) {
await sleep(sleepTimeout)
core.debug(`Polling for pod status: ${podName}`)
podStatus = await getPodStatus(kubectl, podName)
if (
podStatus &&
podStatus?.phase !== 'Pending' &&
podStatus?.phase !== 'Unknown'
) {
break
}
}
podStatus = await getPodStatus(kubectl, podName)
switch (podStatus.phase) {
case 'Succeeded':
case 'Running':
if (isPodReady(podStatus)) {
console.log(`pod/${podName} is successfully rolled out`)
} else {
kubectlDescribeNeeded = true
}
break
case 'Pending':
if (!isPodReady(podStatus)) {
core.warning(`pod/${podName} rollout status check timed out`)
kubectlDescribeNeeded = true
}
break
case 'Failed':
core.error(`pod/${podName} rollout failed`)
kubectlDescribeNeeded = true
break
default:
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`)
}
if (kubectlDescribeNeeded) {
await kubectl.describe('pod', podName)
}
}
async function getPodStatus(kubectl: Kubectl, podName: string) {
const podResult = await kubectl.getResource('pod', podName)
checkForErrors([podResult])
return JSON.parse(podResult.stdout).status
}
function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true
podStatus.containerStatuses.forEach((container) => {
if (container.ready === false) {
core.info(
`'${container.name}' status: ${JSON.stringify(container.state)}`
)
allContainersAreReady = false
}
})
if (!allContainersAreReady) {
core.warning('All containers not in ready state')
}
return allContainersAreReady
}
async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource(
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
serviceName
)
checkForErrors([serviceResult])
return JSON.parse(serviceResult.stdout)
}
async function waitForServiceExternalIPAssignment(
kubectl: Kubectl,
serviceName: string
): Promise<void> {
const sleepTimeout = 10 * 1000 // 10 seconds
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
for (let i = 0; i < iterations; i++) {
core.info(`Wait for service ip assignment : ${serviceName}`)
await sleep(sleepTimeout)
const status = (await getService(kubectl, serviceName)).status
if (isLoadBalancerIPAssigned(status)) {
core.info(
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
)
return
}
}
core.warning(`Wait for service ip assignment timed out${serviceName}`)
}
function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0
}
+313
View File
@@ -0,0 +1,313 @@
import * as core from '@actions/core'
import * as fs from 'fs'
import * as yaml from 'js-yaml'
import * as path from 'path'
import * as fileHelper from './fileUtils'
import {getTempDirectory} from './fileUtils'
import {
InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError,
isWorkloadEntity,
KubernetesWorkload,
NullInputObjectError
} from '../types/kubernetesTypes'
import {
getSpecSelectorLabels,
setSpecSelectorLabels
} from './manifestSpecLabelUtils'
import {
getImagePullSecrets,
setImagePullSecrets
} from './manifestPullSecretUtils'
import {Resource} from '../types/kubectl'
export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) {
throw new Error('Manifest files not provided')
}
// update container images
const containers: string[] = core.getInput('images').split('\n')
const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths,
containers
)
// update pull secrets
const imagePullSecrets: string[] = core
.getInput('imagepullsecrets')
.split('\n')
.filter((secret) => secret.trim().length > 0)
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets)
}
export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) {
return
}
// Unset cluster specific details in the object
if (!!resource) {
const {metadata, status} = resource
if (!!metadata) {
resource.metadata = {
annotations: metadata.annotations,
labels: metadata.labels,
name: metadata.name
}
}
if (!!status) {
resource.status = {}
}
}
}
function updateContainerImagesInManifestFiles(
filePaths: string[],
containers: string[]
): string[] {
if (filePaths?.length <= 0) return filePaths
const newFilePaths = []
// update container images
filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString()
containers.forEach((container: string) => {
let [imageName] = container.split(':')
if (imageName.indexOf('@') > 0) {
imageName = imageName.split('@')[0]
}
if (contents.indexOf(imageName) > 0)
contents = substituteImageNameInSpecFile(
contents,
imageName,
container
)
})
// write updated files
const tempDirectory = getTempDirectory()
const fileName = path.join(tempDirectory, path.basename(filePath))
fs.writeFileSync(path.join(fileName), contents)
newFilePaths.push(fileName)
})
return newFilePaths
}
/*
Example:
Input of
currentString: `image: "example/example-image"`
imageName: `example/example-image`
imageNameWithNewTag: `example/example-image:identifiertag`
would return
`image: "example/example-image:identifiertag"`
*/
export function substituteImageNameInSpecFile(
spec: string,
imageName: string,
imageNameWithNewTag: string
) {
if (spec.indexOf(imageName) < 0) return spec
return spec.split('\n').reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/)
if (imageKeyword) {
let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing
.split(':')
if (currentImageName?.indexOf(' ') > 0) {
currentImageName = currentImageName.split(' ')[0] // remove comments
}
if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`
}
}
return acc + line + '\n'
}, '')
}
export function getReplicaCount(inputObject: any): any {
if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) {
throw InputObjectKindNotDefinedError
}
const {kind} = inputObject
if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
)
return inputObject.spec.replicas
return 0
}
export function updateObjectLabels(
inputObject: any,
newLabels: Map<string, string>,
override: boolean = false
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!newLabels) return
if (override) {
inputObject.metadata.labels = newLabels
} else {
let existingLabels =
inputObject.metadata.labels || new Map<string, string>()
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
inputObject.metadata.labels = existingLabels
}
}
export function updateObjectAnnotations(
inputObject: any,
newAnnotations: Map<string, string>,
override: boolean = false
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
if (!newAnnotations) return
if (override) {
inputObject.metadata.annotations = newAnnotations
} else {
const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>()
Object.keys(newAnnotations).forEach(
(key) => (existingAnnotations[key] = newAnnotations[key])
)
inputObject.metadata.annotations = existingAnnotations
}
}
export function updateImagePullSecrets(
inputObject: any,
newImagePullSecrets: string[],
override: boolean = false
) {
if (!inputObject?.spec || !newImagePullSecrets) return
const newImagePullSecretsObjects = Array.from(
newImagePullSecrets,
(name) => {
return {name}
}
)
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
if (override) {
existingImagePullSecretObjects = newImagePullSecretsObjects
} else {
existingImagePullSecretObjects = existingImagePullSecretObjects || []
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
newImagePullSecretsObjects
)
}
setImagePullSecrets(inputObject, existingImagePullSecretObjects)
}
export function updateSelectorLabels(
inputObject: any,
newLabels: Map<string, string>,
override: boolean
) {
if (!inputObject) throw NullInputObjectError
if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (!newLabels) return
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return
let existingLabels = getSpecSelectorLabels(inputObject)
if (override) {
existingLabels = newLabels
} else {
existingLabels = existingLabels || new Map<string, string>()
Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key])
)
}
setSpecSelectorLabels(inputObject, existingLabels)
}
export function getResources(
filePaths: string[],
filterResourceTypes: string[]
): Resource[] {
if (!filePaths) return []
const resources: Resource[] = []
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject) => {
const inputObjectKind = inputObject?.kind || ''
if (
filterResourceTypes.filter(
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
).length > 0
) {
resources.push({
type: inputObject.kind,
name: inputObject.metadata.name
})
}
})
})
return resources
}
function updateImagePullSecretsInManifestFiles(
filePaths: string[],
imagePullSecrets: string[]
): string[] {
if (imagePullSecrets?.length <= 0) return filePaths
const newObjectsList = []
filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString()
yaml.safeLoadAll(fileContents, (inputObject: any) => {
if (inputObject?.kind) {
const {kind} = inputObject
if (isWorkloadEntity(kind)) {
updateImagePullSecrets(inputObject, imagePullSecrets)
}
newObjectsList.push(inputObject)
}
})
})
return fileHelper.writeObjectsToFile(newObjectsList)
}
+7
View File
@@ -0,0 +1,7 @@
export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout))
}
export function getCurrentTime(): number {
return new Date().getTime()
}
+18
View File
@@ -0,0 +1,18 @@
import {Kubectl} from '../types/kubectl'
const trafficSplitAPIVersionPrefix = 'split.smi-spec.io'
export async function getTrafficSplitAPIVersion(
kubectl: Kubectl
): Promise<string> {
const result = await kubectl.executeCommand('api-versions')
const trafficSplitAPIVersion = result.stdout
.split('\n')
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix))
if (!trafficSplitAPIVersion) {
throw new Error('Unable to find traffic split api version')
}
return trafficSplitAPIVersion
}
@@ -0,0 +1,20 @@
import {cleanLabel} from '../utilities/workflowAnnotationUtils'
describe('WorkflowAnnotationUtils', () => {
describe('cleanLabel', () => {
it('should clean label', () => {
const alreadyClean = 'alreadyClean'
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
'withS0MEinvalidchars'
)
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
})
it('should remove slashes from label', () => {
expect(
cleanLabel('Workflow Name / With Slashes / And Spaces')
).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces')
})
})
})
+47
View File
@@ -0,0 +1,47 @@
import {DeploymentConfig} from '../types/deploymentConfig'
const ANNOTATION_PREFIX = 'actions.github.com'
export function getWorkflowAnnotations(
lastSuccessRunSha: string,
workflowFilePath: string,
deploymentConfig: DeploymentConfig
): string {
const annotationObject = {
run: process.env.GITHUB_RUN_ID,
repository: process.env.GITHUB_REPOSITORY,
workflow: process.env.GITHUB_WORKFLOW,
workflowFileName: workflowFilePath.replace('.github/workflows/', ''),
jobName: process.env.GITHUB_JOB,
createdBy: process.env.GITHUB_ACTOR,
runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`,
commit: process.env.GITHUB_SHA,
lastSuccessRunCommit: lastSuccessRunSha,
branch: process.env.GITHUB_REF,
deployTimestamp: Date.now(),
dockerfilePaths: deploymentConfig.dockerfilePaths,
manifestsPaths: deploymentConfig.manifestFilePaths,
helmChartPaths: deploymentConfig.helmChartFilePaths,
provider: 'GitHub'
}
return JSON.stringify(annotationObject)
}
export function getWorkflowAnnotationKeyLabel(): string {
return `${ANNOTATION_PREFIX}/k8s-deploy`
}
/**
* Cleans label to match valid kubernetes label specification by removing invalid characters
* @param label
* @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] || ''
}
-22
View File
@@ -1,22 +0,0 @@
import * as os from 'os';
export function isEqual(str1: string, str2: string) {
if (!str1) str1 = "";
if (!str2) str2 = "";
return str1.toLowerCase() === str2.toLowerCase();
}
export function getRandomInt(max: number) {
return Math.floor(Math.random() * Math.floor(max));
}
export function getExecutableExtension(): string {
if (os.type().match(/^Win/)) {
return '.exe';
}
return '';
}
export function getCurrentTime(): number {
return new Date().getTime();
}
+12
View File
@@ -0,0 +1,12 @@
import subprocess, sys
kind = sys.argv[1]
name = sys.argv[2]
namespace = 'test-' + sys.argv[3]
try:
print('kubectl delete ' + kind + ' ' + name + ' -n ' + namespace)
deletion = subprocess.Popen(['kubectl', 'delete', kind, name, '--namespace', namespace])
result, err = deletion.communicate()
except Exception as ex:
print('Error occured during deletion', ex)
+33
View File
@@ -0,0 +1,33 @@
import os, sys, json
RESULT = 'false'
k8_object = None
kind = sys.argv[1]
name = sys.argv[2]
color = sys.argv[3]
namespace = 'test-' + sys.argv[4]
print('kubectl get '+kind+' '+name+' -n '+namespace+' -o json')
try:
k8_object = json.load(os.popen('kubectl get '+kind+' '+name+' -n '+namespace+' -o json'))
except:
sys.exit(kind+' '+name+' not created')
try:
if kind == 'Deployment' and k8_object['spec']['selector']['matchLabels']['k8s.deploy.color'] == str(color):
RESULT = 'true'
if kind == 'Service' and k8_object['spec']['selector']['k8s.deploy.color'] == str(color):
RESULT = 'true'
if kind == 'Ingress':
suffix = ''
if str(color) == 'green':
suffix = '-green'
if k8_object['spec']['rules'][0]['http']['paths'][0]['backend']['serviceName']=='nginx-service'+suffix and k8_object['spec']['rules'][0]['http']['paths'][1]['backend']['serviceName']=='unrouted-service':
RESULT = 'true'
except:
pass
if RESULT=='false':
sys.exit(kind+' '+name+' not labelled properly')
print('Test passed')
@@ -0,0 +1,52 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
name: nginx-ingress
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- http:
paths:
- path: /testpath
backend:
serviceName: nginx-service
servicePort: 80
- path: /testpath2
backend:
serviceName: unrouted-service
servicePort: 80
@@ -0,0 +1,33 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
+22
View File
@@ -0,0 +1,22 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
+21
View File
@@ -0,0 +1,21 @@
apiVersion: v2
name: test-chart
description: A Helm chart for Kubernetes
# A chart can be either an 'application' or a 'library' chart.
#
# Application charts are a collection of templates that can be packaged into versioned archives
# to be deployed.
#
# Library charts provide useful utilities or functions for the chart developer. They're included as
# a dependency of application charts to inject those utilities and functions into the rendering
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
version: 0.1.0
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application.
appVersion: 1.16.0
@@ -0,0 +1,21 @@
1. Get the application URL by running these commands:
{{- if .Values.ingress.enabled }}
{{- range $host := .Values.ingress.hosts }}
{{- range .paths }}
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }}
{{- end }}
{{- end }}
{{- else if contains "NodePort" .Values.service.type }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "test-chart.fullname" . }})
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
echo http://$NODE_IP:$NODE_PORT
{{- else if contains "LoadBalancer" .Values.service.type }}
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "test-chart.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "test-chart.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
echo http://$SERVICE_IP:{{ .Values.service.port }}
{{- else if contains "ClusterIP" .Values.service.type }}
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "test-chart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
{{- end }}
@@ -0,0 +1,63 @@
{{/* vim: set filetype=mustache: */}}
{{/*
Expand the name of the chart.
*/}}
{{- define "test-chart.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{/*
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "test-chart.fullname" -}}
{{- if .Values.fullnameOverride -}}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
{{- else -}}
{{- $name := default .Chart.Name .Values.nameOverride -}}
{{- if contains $name .Release.Name -}}
{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
{{- else -}}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{/*
Create chart name and version as used by the chart label.
*/}}
{{- define "test-chart.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{/*
Common labels
*/}}
{{- define "test-chart.labels" -}}
helm.sh/chart: {{ include "test-chart.chart" . }}
{{ include "test-chart.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end -}}
{{/*
Selector labels
*/}}
{{- define "test-chart.selectorLabels" -}}
app.kubernetes.io/name: {{ include "test-chart.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end -}}
{{/*
Create the name of the service account to use
*/}}
{{- define "test-chart.serviceAccountName" -}}
{{- if .Values.serviceAccount.create -}}
{{ default (include "test-chart.fullname" .) .Values.serviceAccount.name }}
{{- else -}}
{{ default "default" .Values.serviceAccount.name }}
{{- end -}}
{{- end -}}
@@ -0,0 +1,21 @@
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

Some files were not shown because too many files have changed in this diff Show More