Compare commits

..

2 Commits

Author SHA1 Message Date
Oliver King 0b0b5178d5 fix broken yaml 2022-07-06 10:27:14 -04:00
Oliver King d43ff40a3e fix typo 2022-06-13 12:57:31 -04:00
95 changed files with 15980 additions and 18224 deletions
-36
View File
@@ -1,36 +0,0 @@
name: Bug Report
description: File a bug report specifying all inputs you provided for the action, we will respond to this thread with any questions.
title: 'Bug: '
labels: ['bug', 'triage']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: What-happened
attributes:
label: What happened?
description: Tell us what happened and how is it different from the expected?
placeholder: Tell us what you see!
validations:
required: true
- type: checkboxes
id: Version
attributes:
label: Version
options:
- label: I am using the latest version
required: true
- type: input
id: Runner
attributes:
label: Runner
description: What runner are you using?
placeholder: Mention the runner info (self-hosted, operating system)
validations:
required: true
- type: textarea
id: Logs
attributes:
label: Relevant log output
description: Run in debug mode for the most verbose logs. Please feel free to attach a screenshot of the logs
validations:
required: true
-6
View File
@@ -1,6 +0,0 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Action "k8s-deploy" Support
url: https://github.com/Azure/k8s-deploy
security: https://github.com/Azure/k8s-deploy/blob/main/SECURITY.md
about: Please ask and answer questions here.
@@ -1,13 +0,0 @@
name: Feature Request
description: File a Feature Request form, we will respond to this thread with any questions.
title: 'Feature Request: '
labels: ['Feature']
assignees: '@Azure/aks-atlanta'
body:
- type: textarea
id: Feature_request
attributes:
label: Feature request
description: Provide example functionality and links to relevant docs
validations:
required: true
+40 -39
View File
@@ -1,51 +1,52 @@
name: 'Code scanning - action' name: "Code scanning - action"
on: on:
push: push:
pull_request: pull_request:
schedule: schedule:
- cron: '0 19 * * 0' - cron: '0 19 * * 0'
jobs: jobs:
CodeQL-Build: CodeQL-Build:
# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest
steps: # CodeQL runs on ubuntu-latest and windows-latest
- name: Checkout repository runs-on: ubuntu-latest
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 steps:
# the head of the pull request instead of the merge commit. - name: Checkout repository
- run: git checkout HEAD^2 uses: actions/checkout@v2
if: ${{ github.event_name == 'pull_request' }} 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
# Initializes the CodeQL tools for scanning. # If this run was triggered by a pull request event, then checkout
- name: Initialize CodeQL # the head of the pull request instead of the merge commit.
uses: github/codeql-action/init@v1 - run: git checkout HEAD^2
# Override language selection by uncommenting this and choosing your languages if: ${{ github.event_name == 'pull_request' }}
# with:
# languages: go, javascript, csharp, python, cpp, java # 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). # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below) # If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild - name: Autobuild
uses: github/codeql-action/autobuild@v1 uses: github/codeql-action/autobuild@v1
# ️ Command-line programs to run using the OS shell. # ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl # 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project # and modify them (or add more) to build your code if your project
# uses a compiled language # uses a compiled language
#- run: | #- run: |
# make bootstrap # make bootstrap
# make release # make release
- name: Perform CodeQL Analysis - name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1 uses: github/codeql-action/analyze@v1
+29 -28
View File
@@ -1,35 +1,36 @@
name: setting-default-labels name: setting-default-labels
# Controls when the action will run. # Controls when the action will run.
on: on:
schedule: schedule:
- cron: '0 0/3 * * *' - cron: "0 0/3 * * *"
# A workflow run is made up of one or more jobs that can run sequentially or in parallel # A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs: jobs:
build: build:
# The type of runner that the job will run on # The type of runner that the job will run on
runs-on: ubuntu-latest runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job # Steps represent a sequence of tasks that will be executed as part of the job
steps: steps:
- uses: actions/stale@v3
name: Setting issue as idle - uses: actions/stale@v3
with: name: Setting issue as idle
repo-token: ${{ secrets.GITHUB_TOKEN }} with:
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.' repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-label: 'idle' stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
days-before-stale: 14 stale-issue-label: 'idle'
days-before-close: -1 days-before-stale: 14
operations-per-run: 100 days-before-close: -1
exempt-issue-labels: 'backlog' operations-per-run: 100
exempt-issue-labels: 'backlog'
- uses: actions/stale@v3
name: Setting PR as idle - uses: actions/stale@v3
with: name: Setting PR as idle
repo-token: ${{ secrets.GITHUB_TOKEN }} with:
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.' repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-label: 'idle' stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
days-before-stale: 14 stale-pr-label: 'idle'
days-before-close: -1 days-before-stale: 14
operations-per-run: 100 days-before-close: -1
operations-per-run: 100
-18
View File
@@ -1,18 +0,0 @@
name: 'Run prettify'
on:
pull_request:
push:
branches: [main]
jobs:
prettier:
name: Prettier Check
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v2
- name: Enforce Prettier
uses: actionsx/prettier@v2
with:
args: --check .
+9 -9
View File
@@ -1,14 +1,14 @@
name: Create release PR name: Create release PR
on: on:
workflow_dispatch: workflow_dispatch:
inputs: inputs:
release: release:
description: 'Define release version (ex: v1, v2, v3)' description: "Define release version (ex: v1, v2, v3)"
required: true required: true
jobs: jobs:
release-pr: release-pr:
uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
with: with:
release: ${{ github.event.inputs.release }} release: ${{ github.event.inputs.release }}
+184 -184
View File
@@ -1,215 +1,215 @@
name: Minikube Integration Tests name: Minikube Integration Tests
on: on:
pull_request: pull_request:
branches: branches:
- master - master
- main - main
- 'releases/*' - "releases/*"
push: push:
branches: branches:
- master - master
- main - main
- 'releases/*' - "releases/*"
workflow_dispatch: workflow_dispatch:
jobs: jobs:
run-integration-test: run-integration-test:
name: Run Minikube Integration Tests name: Run Minikube Integration Tests
runs-on: ubuntu-latest runs-on: ubuntu-latest
env: env:
KUBECONFIG: /home/runner/.kube/config KUBECONFIG: /home/runner/.kube/config
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Install dependencies - name: Install dependencies
run: | run: |
rm -rf node_modules/ rm -rf node_modules/
npm install npm install
- name: Install ncc - name: Install ncc
run: npm i -g @vercel/ncc run: npm i -g @vercel/ncc
- name: Build - name: Build
run: ncc build src/run.ts -o lib run: ncc build src/run.ts -o lib
- name: Set name of ns - name: Set name of ns
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)" run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
shell: bash shell: bash
id: ns id: ns
- uses: Azure/setup-kubectl@v1 - uses: Azure/setup-kubectl@v1
name: Install Kubectl name: Install Kubectl
- id: setup-minikube - id: setup-minikube
name: Setup Minikube name: Setup Minikube
uses: manusa/actions-setup-minikube@v2.4.2 uses: manusa/actions-setup-minikube@v2.4.2
with: with:
minikube version: 'v1.24.0' minikube version: "v1.24.0"
kubernetes version: 'v1.17.8' kubernetes version: "v1.17.8"
driver: 'none' driver: "none"
timeout-minutes: 3 timeout-minutes: 3
- name: Create namespace to run tests - name: Create namespace to run tests
run: kubectl create ns test-${{ steps.ns.outputs.name }} run: kubectl create ns test-${{ steps.ns.outputs.name }}
- uses: actions/setup-python@v2 - uses: actions/setup-python@v2
name: Install Python name: Install Python
with: with:
python-version: '3.x' python-version: "3.x"
- name: Cleaning any previously created items - name: Cleaning any previously created items
run: | run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
- name: Executing deploy action - name: Executing deploy action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: deploy action: deploy
- name: Checking if deploments and services were created with green labels - name: Checking if deploments and services were created with green labels
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action - name: Executing promote action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: promote action: promote
- name: Checking if deploments and services were created with none labels after promote - name: Checking if deploments and services were created with none labels after promote
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action on - name: Executing deploy action on
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: deploy action: deploy
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy - name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
- name: Executing reject action - name: Executing reject action
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-service.yml test/integration/manifests/test-service.yml
strategy: blue-green strategy: blue-green
route-method: service route-method: service
action: reject action: reject
- name: Checking if deploments and services were routed back to none labels after reject - name: Checking if deploments and services were routed back to none labels after reject
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
- name: Cleaning up current set up - name: Cleaning up current set up
run: | run: |
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress - name: Executing deploy action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: deploy action: deploy
- name: Checking if deploments, services and ingresses were created with green labels - name: Checking if deploments, services and ingresses were created with green labels
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing promote action for ingress - name: Executing promote action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.14.2 images: nginx:1.14.2
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: promote action: promote
- name: Checking if deploments, services and ingresses were created with none labels after promote - name: Checking if deploments, services and ingresses were created with none labels after promote
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- name: Executing deploy action for ingress - name: Executing deploy action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: deploy action: deploy
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists - name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
- name: Executing reject action for ingress - name: Executing reject action for ingress
uses: ./ uses: ./
with: with:
namespace: test-${{ steps.ns.outputs.name }} namespace: test-${{ steps.ns.outputs.name }}
images: nginx:1.19.1 images: nginx:1.19.1
manifests: | manifests: |
test/integration/manifests/test-ingress.yml test/integration/manifests/test-ingress.yml
strategy: blue-green strategy: blue-green
route-method: ingress route-method: ingress
action: reject action: reject
- name: Checking if deploments, services and ingresses were created with none labels after reject - name: Checking if deploments, services and ingresses were created with none labels after reject
run: | run: |
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }} python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
- if: ${{ always() }} - if: ${{ always() }}
name: Delete created namespace name: Delete created namespace
run: kubectl delete ns test-${{ steps.ns.outputs.name }} run: kubectl delete ns test-${{ steps.ns.outputs.name }}
- if: ${{ always() }} - if: ${{ always() }}
name: Posting result back to PR name: Posting result back to PR
run: | run: |
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
shell: bash shell: bash
+5 -5
View File
@@ -1,10 +1,10 @@
name: Tag and create release draft name: Tag and create release draft
on: on:
push: push:
branches: branches:
- releases/* - releases/*
jobs: jobs:
tag-and-release: tag-and-release:
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
+16 -16
View File
@@ -1,19 +1,19 @@
name: 'Run unit tests.' name: "Run unit tests."
on: # rebuild any PRs and main branch changes on: # rebuild any PRs and main branch changes
pull_request: pull_request:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
push: push:
branches: branches:
- main - master
- 'releases/*' - "releases/*"
jobs: jobs:
build: # make sure build/ci works properly build: # make sure build/ci works properly
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- run: | - run: |
npm install npm install
npm test npm test
+1 -3
View File
@@ -2,6 +2,4 @@ node_modules
.DS_Store .DS_Store
.idea .idea
lib/ lib/
coverage/
-4
View File
@@ -1,4 +0,0 @@
# dependencies
/node_modules
coverage
/lib
-8
View File
@@ -1,8 +0,0 @@
{
"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
+434 -477
View File
@@ -1,477 +1,434 @@
# Deploy manifests action for Kubernetes # Deploy manifests action for Kubernetes
This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action). This action is used to deploy manifests to Kubernetes clusters. It requires that the cluster context be set earlier in the workflow by using either the [Azure/aks-set-context](https://github.com/Azure/aks-set-context/tree/releases/v1) action or the [Azure/k8s-set-context](https://github.com/Azure/k8s-set-context/tree/releases/v1) action. It also requires Kubectl to be installed (you can use the [Azure/setup-kubectl](https://github.com/Azure/setup-kubectl) action).
If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
This action requires the following permissions from your workflow: ## Action capabilities
```yaml Following are the key capabilities of this action:
permissions:
id-token: write - **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.
contents: read
actions: read - **Object stability checks**: Rollout status is checked for the Kubernetes objects deployed. This is done to incorporate stability checks while computing the action status as success/failure.
```
- **Secret handling**: The secret names specified as inputs in the action are used to augment the input manifest files with imagePullSecrets values before deploying to the cluster. Also, checkout the [Azure/k8s-create-secret](https://github.com/Azure/k8s-create-secret) action for creation of generic or docker-registry secrets in the cluster.
## Action capabilities
- **Deployment strategy** Supports both canary and blue-green deployment strategies
Following are the key capabilities of this action:
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
- **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. - **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers).
- **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary.
- **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. - **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:
- **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. - **Service route-method**: Identified services are configured to target the green deployments.
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services.
- **Deployment strategy** Supports both canary and blue-green deployment strategies - **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.
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported: 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.
- **Service Mesh Interface**: Service Mesh Interface abstraction allows for plug-and-play configuration with service mesh providers such as [Linkerd](https://linkerd.io/) and [Istio](https://istio.io/). Meanwhile, this action takes away the hard work of mapping SMI's TrafficSplit objects to the stable, baseline and canary services during the lifecycle of the deployment strategy. Service mesh based canary deployments using this action are more accurate as service mesh providers enable granular percentage traffic split (via service registry and sidecar containers injected into pods alongside application containers).
- **Only Kubernetes (no service mesh)**: In the absence of service mesh, while it may not be possible to achieve exact percentage split at the request level, it is still possible to perform canary deployments by deploying -baseline and -canary workload variants next to the stable variant. The service routes requests to pods of all three workload variants as the selector-label constraints are met (KubernetesManifest will honor these when creating -baseline and -canary variants). This achieves the intended effect of routing only a portion of total requests to the canary. ## Action inputs
- **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
<table>
- **Service route-method**: Identified services are configured to target the green deployments. <thead>
- **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. <tr>
- **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster. <th>Action inputs</th>
<th>Description</th>
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. </tr>
</thead>
## Action inputs <tr>
<td>action </br></br>(Required)</td>
<table> <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>
<thead> </tr>
<tr> <tr>
<th>Action inputs</th> <td>manifests </br></br>(Required)</td>
<th>Description</th> <td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
</tr> </tr>
</thead> <tr>
<tr> <td>namespace </br></br>(Optional)
<td>action </br></br>(Required)</td> <td>Namespace within the cluster to deploy to.</td>
<td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td> </tr>
</tr> <tr>
<tr> <td>images </br></br>(Optional)</td>
<td>manifests </br></br>(Required)</td> <td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br>
<td>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> <code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br>
</tr> In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td>
<tr> </tr>
<td>strategy </br></br>(Required)</td> <tr>
<td>Acceptable values: basic/canary/blue-green. <br> <td>imagepullsecrets </br></br>(Optional)</td>
Default value: basic <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>
<br>Deployment strategy to be used while applying manifest files on the cluster. </tr>
<br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy <tr>
<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td> <td>pull-images</br></br>(Optional)</td>
</tr> <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
<tr> </tr>
<td>namespace </br></br>(Optional) <tr>
<td>Namespace within the cluster to deploy to.</td> <td>strategy </br></br>(Optional)</td>
</tr> <td>Acceptable values: none/canary/blue-green. <br>
<tr> Deployment strategy to be used while applying manifest files on the cluster.<br>none - No deployment strategy is used when deploying.<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
<td>images </br></br>(Optional)</td> </tr>
<td>Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files. This multiline input accepts specifying multiple artifact substitutions in newline separated form. For example:<br> <tr>
<code><br>images: |<br>&nbsp&nbspcontosodemo.azurecr.io/foo:test1<br>&nbsp&nbspcontosodemo.azurecr.io/bar:test2<br></code><br> <td>traffic-split-method </br></br>(Optional)</td>
In this example, all references to contosodemo.azurecr.io/foo and contosodemo.azurecr.io/bar are searched for in the image field of the input manifest files. For the matches found, the tags test1 and test2 are substituted.</td> <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>
</tr> </tr>
<tr> <tr>
<td>imagepullsecrets </br></br>(Optional)</td> <td>percentage </br></br>(Optional but required if strategy is canary)</td>
<td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td> <td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td>
</tr> </tr>
<tr> <tr>
<td>pull-images</br></br>(Optional)</td> <td>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</td>
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td> <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>
</tr> </tr>
<tr> <tr>
<td>traffic-split-method </br></br>(Optional)</td> <td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</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> <td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
</tr> <br>Service: Service selector labels are updated to target '-green' workloads.
<tr> <br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
<td>traffic-split-annotations </br></br>(Optional)</td> <br>SMI: A <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> object is created for each required service to route traffic to new workloads.</td>
<td>Annotations in the form of key/value pair to be added to TrafficSplit.</td> </tr>
<tr> <tr>
<td>percentage </br></br>(Optional but required if strategy is canary)</td> <td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
<td>Used to compute the number of replicas of &#39;-baseline&#39; and &#39;-canary&#39; variants of the workloads found in manifest files. For the specified percentage input, if (percentage * numberOfDesirerdReplicas)/100 is not a round number, the floor of this number is used while creating &#39;-baseline&#39; and &#39;-canary&#39;.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with &#39;replicas: 4&#39; and if &#39;strategy: canary&#39; and &#39;percentage: 25&#39; are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The &#39;-baseline&#39; variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the &#39;-canary&#39; variant is created with the image and tag corresponding to the new changes being deployed</td> <td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
</tr> </tr>
<tr> <tr>
<td>baseline-and-canary-replicas </br></br> (Optional and relevant only if strategy is canary and traffic-split-method is smi)</td> <td>force </br></br>(Optional)</td>
<td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code>&nbsp;&nbsp;&nbsp;&nbsp;strategy: canary<br>&nbsp;&nbsp;&nbsp;&nbsp;trafficSplitMethod: smi<br>&nbsp;&nbsp;&nbsp;&nbsp;percentage: 20<br>&nbsp;&nbsp;&nbsp;&nbsp;baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas each, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td> <td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
</tr> </tr>
<tr> <tr>
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td> <td>annotate-namespace</br></br>(Optional)</td>
<td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input. <td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
<br>Service: Service selector labels are updated to target '-green' workloads. </tr>
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments. </table>
<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>
</tr> ## Usage Examples
<tr>
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td> ### Basic deployment (without any deployment strategy)
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
</tr> ```yaml
<tr> - uses: Azure/k8s-deploy@v3.1
<td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td> with:
<td>Acceptable values: true, false</br>Default value: false.</td> namespace: "myapp"
</tr> manifests: |
<tr> dir/manifestsDirectory
<td>force </br></br>(Optional)</td> images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
<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> imagepullsecrets: |
</tr> image-pull-secret1
<tr> image-pull-secret2
<td>annotate-namespace</br></br>(Optional)</td> ```
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
</tr> ### Canary deployment without service mesh
</table>
```yaml
## Usage Examples - uses: Azure/k8s-deploy@v3.1
with:
### Basic deployment (without any deployment strategy) namespace: "myapp"
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
```yaml imagepullsecrets: |
- uses: Azure/k8s-deploy@v3.1 image-pull-secret1
with: image-pull-secret2
namespace: 'myapp' manifests: |
manifests: | deployment.yaml
dir/manifestsDirectory service.yaml
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' dir/manifestsDirectory
imagepullsecrets: | strategy: canary
image-pull-secret1 action: deploy
image-pull-secret2 percentage: 20
``` ```
### Private cluster deployment To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v4 - uses: Azure/k8s-deploy@v3.1
with: with:
resource-group: yourResourceGroup namespace: "myapp"
name: yourClusterName images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
action: deploy imagepullsecrets: |
strategy: basic image-pull-secret1
image-pull-secret2
private-cluster: true manifests: |
manifests: | deployment.yaml
manifests/azure-vote-backend-deployment.yaml service.yaml
manifests/azure-vote-backend-service.yaml dir/manifestsDirectory
manifests/azure-vote-frontend-deployment.yaml strategy: canary
manifests/azure-vote-frontend-service.yaml action: promote # substitute reject if you want to reject
images: | ```
registry.azurecr.io/containername
``` ### Canary deployment based on Service Mesh Interface
### Canary deployment without service mesh ```yaml
- uses: Azure/k8s-deploy@v3.1
```yaml with:
- uses: Azure/k8s-deploy@v3.1 namespace: "myapp"
with: images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
namespace: 'myapp' imagepullsecrets: |
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' image-pull-secret1
imagepullsecrets: | image-pull-secret2
image-pull-secret1 manifests: |
image-pull-secret2 deployment.yaml
manifests: | service.yaml
deployment.yaml dir/manifestsDirectory
service.yaml strategy: canary
dir/manifestsDirectory action: deploy
strategy: canary traffic-split-method: smi
action: deploy percentage: 20
percentage: 20 baseline-and-canary-replicas: 1
``` ```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
dir/manifestsDirectory dir/manifestsDirectory
strategy: canary strategy: canary
action: promote # substitute reject if you want to reject traffic-split-method: smi
``` action: reject # substitute promote if you want to promote
```
### Canary deployment based on Service Mesh Interface
### Blue-Green deployment with different route methods
```yaml
- uses: Azure/k8s-deploy@v3.1 ```yaml
with: - uses: Azure/k8s-deploy@v3.1
namespace: 'myapp' with:
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' namespace: "myapp"
imagepullsecrets: | images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
image-pull-secret1 imagepullsecrets: |
image-pull-secret2 image-pull-secret1
manifests: | image-pull-secret2
deployment.yaml manifests: |
service.yaml deployment.yaml
dir/manifestsDirectory service.yaml
strategy: canary ingress.yml
action: deploy strategy: blue-green
traffic-split-method: smi action: deploy
percentage: 20 route-method: ingress # substitute with service/smi as per need
baseline-and-canary-replicas: 1 version-switch-buffer: 15
``` ```
To promote/reject the canary created by the above snippet, the following YAML snippet could be used: To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
```yaml ```yaml
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-deploy@v3.1
with: with:
namespace: 'myapp' namespace: "myapp"
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} ' images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
imagepullsecrets: | imagepullsecrets: |
image-pull-secret1 image-pull-secret1
image-pull-secret2 image-pull-secret2
manifests: | manifests: |
deployment.yaml deployment.yaml
service.yaml service.yaml
dir/manifestsDirectory ingress.yml
strategy: canary strategy: blue-green
traffic-split-method: smi route-method: ingress # should be the same as the value when action was deploy
action: reject # substitute promote if you want to promote action: promote # substitute reject if you want to reject
``` ```
### Blue-Green deployment with different route methods ## End to end workflows
```yaml 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:
- uses: Azure/k8s-deploy@v3.1
with: ### Build container image and deploy to Azure Kubernetes Service cluster
namespace: 'myapp'
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}' ```yaml
imagepullsecrets: | on: [push]
image-pull-secret1
image-pull-secret2 jobs:
manifests: | build:
deployment.yaml runs-on: ubuntu-latest
service.yaml steps:
ingress.yml - uses: actions/checkout@master
strategy: blue-green
action: deploy - uses: Azure/docker-login@v1
route-method: ingress # substitute with service/smi as per need with:
version-switch-buffer: 15 login-server: contoso.azurecr.io
``` username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
- run: |
```yaml docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: Azure/k8s-deploy@v3.1 docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
with:
namespace: 'myapp' - uses: azure/setup-kubectl@v2.0
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
imagepullsecrets: | # Set the target AKS cluster.
image-pull-secret1 - uses: Azure/aks-set-context@v1
image-pull-secret2 with:
manifests: | creds: "${{ secrets.AZURE_CREDENTIALS }}"
deployment.yaml cluster-name: contoso
service.yaml resource-group: contoso-rg
ingress.yml
strategy: blue-green - uses: Azure/k8s-create-secret@v1.1
route-method: ingress # should be the same as the value when action was deploy with:
action: promote # substitute reject if you want to reject container-registry-url: contoso.azurecr.io
``` container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
## End to end workflows secret-name: demo-k8s-secret
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: - uses: Azure/k8s-deploy@v3.1
with:
### Build container image and deploy to Azure Kubernetes Service cluster action: deploy
manifests: |
```yaml manifests/deployment.yml
on: [push] manifests/service.yml
images: |
jobs: demo.azurecr.io/k8sdemo:${{ github.sha }}
build: imagepullsecrets: |
runs-on: ubuntu-latest demo-k8s-secret
steps: ```
- uses: actions/checkout@master
### Build container image and deploy to any Azure Kubernetes Service cluster
- uses: Azure/docker-login@v1
with: ```yaml
login-server: contoso.azurecr.io on: [push]
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} jobs:
build:
- run: | runs-on: ubuntu-latest
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} steps:
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} - uses: actions/checkout@master
- uses: azure/setup-kubectl@v2.0 - uses: Azure/docker-login@v1
with:
# Set the target AKS cluster. login-server: contoso.azurecr.io
- uses: Azure/aks-set-context@v1 username: ${{ secrets.REGISTRY_USERNAME }}
with: password: ${{ secrets.REGISTRY_PASSWORD }}
creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso - run: |
resource-group: contoso-rg docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: Azure/k8s-create-secret@v1.1
with: - uses: azure/setup-kubectl@v2.0
container-registry-url: contoso.azurecr.io
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} - uses: Azure/k8s-set-context@v2
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} with:
secret-name: demo-k8s-secret kubeconfig: ${{ secrets.KUBE_CONFIG }}
- uses: Azure/k8s-deploy@v3.1 - uses: Azure/k8s-create-secret@v1.1
with: with:
action: deploy container-registry-url: contoso.azurecr.io
manifests: | container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
manifests/deployment.yml container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
manifests/service.yml secret-name: demo-k8s-secret
images: |
demo.azurecr.io/k8sdemo:${{ github.sha }} - uses: Azure/k8s-deploy@v3.1
imagepullsecrets: | with:
demo-k8s-secret action: deploy
``` manifests: |
manifests/deployment.yml
### Build container image and deploy to any Azure Kubernetes Service cluster manifests/service.yml
images: |
```yaml demo.azurecr.io/k8sdemo:${{ github.sha }}
on: [push] imagepullsecrets: |
demo-k8s-secret
jobs: ```
build:
runs-on: ubuntu-latest ### Build image and add `dockerfile-path` label to it
steps:
- uses: actions/checkout@master We can use this image in other workflows once built.
- uses: Azure/docker-login@v1 ```yaml
with: on: [push]
login-server: contoso.azurecr.io env:
username: ${{ secrets.REGISTRY_USERNAME }} NAMESPACE: demo-ns2
password: ${{ secrets.REGISTRY_PASSWORD }}
jobs:
- run: | build:
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} runs-on: ubuntu-latest
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }} steps:
- uses: actions/checkout@master
- uses: azure/setup-kubectl@v2.0
- uses: Azure/docker-login@v1
- uses: Azure/k8s-set-context@v2 with:
with: login-server: contoso.azurecr.io
kubeconfig: ${{ secrets.KUBE_CONFIG }} username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }}
- uses: Azure/k8s-create-secret@v1.1
with: - run: |
container-registry-url: contoso.azurecr.io docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
container-registry-username: ${{ secrets.REGISTRY_USERNAME }} docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} ```
secret-name: demo-k8s-secret
### Use bake action to get manifests deploying to a Kubernetes cluster
- uses: Azure/k8s-deploy@v3.1
with: ```yaml
action: deploy on: [push]
manifests: | env:
manifests/deployment.yml NAMESPACE: demo-ns2
manifests/service.yml
images: | jobs:
demo.azurecr.io/k8sdemo:${{ github.sha }} deploy:
imagepullsecrets: | runs-on: ubuntu-latest
demo-k8s-secret steps:
``` - uses: actions/checkout@master
### Build image and add `dockerfile-path` label to it - uses: Azure/docker-login@v1
with:
We can use this image in other workflows once built. login-server: contoso.azurecr.io
username: ${{ secrets.REGISTRY_USERNAME }}
```yaml password: ${{ secrets.REGISTRY_PASSWORD }}
on: [push]
env: - uses: azure/setup-kubectl@v2.0
NAMESPACE: demo-ns2
# Set the target AKS cluster.
jobs: - uses: Azure/aks-set-context@v1
build: with:
runs-on: ubuntu-latest creds: "${{ secrets.AZURE_CREDENTIALS }}"
steps: cluster-name: contoso
- uses: actions/checkout@master resource-group: contoso-rg
- uses: Azure/docker-login@v1 - uses: Azure/k8s-create-secret@v1.1
with: with:
login-server: contoso.azurecr.io namespace: ${{ env.NAMESPACE }}
username: ${{ secrets.REGISTRY_USERNAME }} container-registry-url: contoso.azurecr.io
password: ${{ secrets.REGISTRY_PASSWORD }} container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
- run: | secret-name: demo-k8s-secret
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 }} - uses: azure/k8s-bake@v2
``` with:
renderEngine: "helm"
### Use bake action to get manifests deploying to a Kubernetes cluster helmChart: "./aks-helloworld/"
overrideFiles: "./aks-helloworld/values-override.yaml"
```yaml overrides: |
on: [push] replicas:2
env: helm-version: "latest"
NAMESPACE: demo-ns2 id: bake
jobs: - uses: Azure/k8s-deploy@v1.2
deploy: with:
runs-on: ubuntu-latest action: deploy
steps: manifests: ${{ steps.bake.outputs.manifestsBundle }}
- uses: actions/checkout@master images: |
contoso.azurecr.io/k8sdemo:${{ github.sha }}
- uses: Azure/docker-login@v1 imagepullsecrets: |
with: demo-k8s-secret
login-server: contoso.azurecr.io ```
username: ${{ secrets.REGISTRY_USERNAME }}
password: ${{ secrets.REGISTRY_PASSWORD }} ## Traceability Fields Support
- uses: azure/setup-kubectl@v2.0 - 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.
# Set the target AKS cluster. - 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.
- uses: Azure/aks-set-context@v1
with: ## Contributing
creds: '${{ secrets.AZURE_CREDENTIALS }}'
cluster-name: contoso This project welcomes contributions and suggestions. Most contributions require you to agree to a
resource-group: contoso-rg 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.
- uses: Azure/k8s-create-secret@v1.1
with: When you submit a pull request, a CLA bot will automatically determine whether you need to provide
namespace: ${{ env.NAMESPACE }} a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
container-registry-url: contoso.azurecr.io provided by the bot. You will only need to do this once across all repos using our CLA.
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }} This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
secret-name: demo-k8s-secret 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.
- uses: azure/k8s-bake@v2
with:
renderEngine: 'helm'
helmChart: './aks-helloworld/'
overrideFiles: './aks-helloworld/values-override.yaml'
overrides: |
replicas:2
helm-version: 'latest'
id: bake
- uses: Azure/k8s-deploy@v1.2
with:
action: deploy
manifests: ${{ steps.bake.outputs.manifestsBundle }}
images: |
contoso.azurecr.io/k8sdemo:${{ github.sha }}
imagepullsecrets: |
demo-k8s-secret
```
## Traceability Fields Support
- Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests.
- Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability.
- Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Support
k8s-deploy is an open source project that is [**not** covered by the Microsoft Azure support policy](https://support.microsoft.com/en-us/help/2941892/support-for-linux-and-open-source-technology-in-azure). [Please search open issues here](https://github.com/Azure/k8s-deploy/issues), and if your issue isn't already represented please [open a new one](https://github.com/Azure/k8s-deploy/issues/new/choose). The project maintainers will respond to the best of their abilities.
+35 -35
View File
@@ -1,35 +1,35 @@
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK --> <!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
## Security ## Security
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/). Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [many more](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>) of a security vulnerability, please report it to us as described below. If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [definition](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
## Reporting Security Issues ## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155). **Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them to the Microsoft Security Response Center at [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://technet.microsoft.com/en-us/security/dn606155).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
- Full paths of source file(s) related to the manifestation of the issue * Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL) * The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue * Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue * Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible) * Proof-of-concept or exploit code (if possible)
- Impact of the issue, including how an attacker might exploit the issue * Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly. This information will help us triage your report more quickly.
## Preferred Languages ## Preferred Languages
We prefer all communications to be in English. We prefer all communications to be in English.
## Policy ## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
<!-- END MICROSOFT SECURITY.MD BLOCK --> <!-- END MICROSOFT SECURITY.MD BLOCK -->
+67 -80
View File
@@ -1,80 +1,67 @@
name: 'Deploy to Kubernetes cluster' name: "Deploy to Kubernetes cluster"
description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters' description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters"
inputs: inputs:
# Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action # Please ensure you have used either azure/k8s-actions/aks-set-context or azure/k8s-actions/k8s-set-context in the workflow before this action
# You also need to have kubectl installed (azure/setup-kubectl) # You also need to have kubectl installed (azure/setup-kubectl)
namespace: namespace:
description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.' description: "Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace."
required: false required: false
manifests: manifests:
description: 'Path to the manifest files which will be used for deployment.' description: "Path to the manifest files which will be used for deployment."
required: true required: true
images: images:
description: 'Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test' description: "Fully qualified resource URL of the image(s) to be used for substitutions on the manifest files Example: contosodemo.azurecr.io/helloworld:test"
required: false required: false
imagepullsecrets: imagepullsecrets:
description: 'Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files' description: "Name of a docker-registry secret that has already been set up within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files"
required: false required: false
pull-images: pull-images:
description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations" description: "Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations"
required: false required: false
default: true default: true
strategy: strategy:
description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green' description: "Deployment strategy to be used. Allowed values are none, canary and blue-green"
required: true required: false
default: 'basic' default: "none"
route-method: route-method:
description: 'Route based on service, ingress or SMI for blue-green strategy' description: "Route based on service, ingress or SMI for blue-green strategy"
required: false required: false
default: 'service' default: "service"
version-switch-buffer: version-switch-buffer:
description: 'Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)' description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)"
required: false required: false
default: 0 default: 0
traffic-split-method: traffic-split-method:
description: 'Traffic split method to be used. Allowed values are pod and smi' description: "Traffic split method to be used. Allowed values are pod and smi"
required: false required: false
default: 'pod' default: "pod"
traffic-split-annotations: baseline-and-canary-replicas:
description: 'Annotations in the form of key/value pair to be added to TrafficSplit. Relevant only if deployement strategy is blue-green or canary' description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)"
required: false required: false
baseline-and-canary-replicas: default: 0
description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)' percentage:
required: false description: "Percentage of traffic redirect to canary deployment"
default: '' required: false
percentage: default: 0
description: 'Percentage of traffic redirect to canary deployment' action:
required: false description: "deploy, promote, or reject"
default: 0 required: true
action: default: "deploy"
description: 'deploy, promote, or reject' force:
required: true description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command"
default: 'deploy' required: false
force: default: false
description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command' token:
required: false description: "Github token"
default: false default: ${{ github.token }}
token: required: true
description: 'Github token' annotate-namespace:
default: ${{ github.token }} description: "Annotate the target namespace"
required: true required: false
annotate-namespace: default: true
description: 'Annotate the target namespace'
required: false branding:
default: true color: "green"
private-cluster: runs:
description: 'True if cluster is AKS private cluster' using: "node12"
required: false main: "lib/index.js"
default: false
resource-group:
description: 'Name of resource group - Only required if using private cluster'
required: false
name:
description: 'Resource group name - Only required if using private cluster'
required: false
branding:
color: 'green'
runs:
using: 'node16'
main: 'lib/index.js'
+8 -8
View File
@@ -1,10 +1,10 @@
module.exports = { module.exports = {
clearMocks: true, clearMocks: true,
moduleFileExtensions: ['js', 'ts'], moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node', testEnvironment: 'node',
testMatch: ['**/*.test.ts'], testMatch: ['**/*.test.ts'],
transform: { transform: {
'^.+\\.ts$': 'ts-jest' '^.+\\.ts$': 'ts-jest'
}, },
verbose: true verbose: true
} }
+10822 -11313
View File
File diff suppressed because it is too large Load Diff
+28 -32
View File
@@ -1,32 +1,28 @@
{ {
"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": "ncc build src/run.ts -o lib", "build": "tsc --outDir ./lib --rootDir ./src",
"test": "jest", "test": "jest"
"coverage": "jest --coverage=true", },
"format": "prettier --write .", "dependencies": {
"format-check": "prettier --check ." "@actions/core": "^1.2.6",
}, "@actions/exec": "^1.0.0",
"dependencies": { "@actions/io": "^1.0.0",
"@actions/core": "^1.9.1", "@actions/tool-cache": "1.1.2",
"@actions/exec": "^1.0.0", "@octokit/core": "^3.5.1",
"@actions/io": "^1.0.0", "@octokit/plugin-retry": "^3.0.9",
"@actions/tool-cache": "1.1.2", "@types/minipass": "^3.1.2",
"@octokit/core": "^3.5.1", "js-yaml": "3.13.1"
"@octokit/plugin-retry": "^3.0.9", },
"@types/minipass": "^3.1.2", "devDependencies": {
"js-yaml": "3.13.1" "@types/jest": "^26.0.0",
}, "@types/js-yaml": "^3.12.7",
"devDependencies": { "@types/node": "^12.20.41",
"@types/jest": "^26.0.0", "jest": "^26.0.0",
"@types/js-yaml": "^3.12.7", "ts-jest": "^25.5.1",
"@types/node": "^12.20.41", "typescript": "3.9.5"
"jest": "^26.0.0", }
"prettier": "^2.7.1", }
"ts-jest": "^26.0.0",
"typescript": "3.9.5"
}
}
+75 -69
View File
@@ -1,79 +1,85 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper";
import { import {
annotateAndLabelResources, annotateAndLabelResources,
checkManifestStability, checkManifestStability,
deployManifests deployManifests,
} from '../strategyHelpers/deploymentHelper' } from "../strategyHelpers/deploymentHelper";
import {DeploymentStrategy} from '../types/deploymentStrategy' import { DeploymentStrategy } from "../types/deploymentStrategy";
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod' import { parseTrafficSplitMethod } from "../types/trafficSplitMethod";
import { parseRouteStrategy } from "../types/routeStrategy";
export async function deploy( export async function deploy(
kubectl: Kubectl, kubectl: Kubectl,
manifestFilePaths: string[], manifestFilePaths: string[],
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
// update manifests // update manifests
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths) const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths);
core.debug(`Input manifest files: ${inputManifestFiles}`) core.debug("Input manifest files: " + inputManifestFiles);
// deploy manifests // deploy manifests
core.startGroup('Deploying manifests') core.info("Deploying manifests");
const trafficSplitMethod = parseTrafficSplitMethod( const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput('traffic-split-method', {required: true}) core.getInput("traffic-split-method", { required: true })
) );
const deployedManifestFiles = await deployManifests( const deployedManifestFiles = await deployManifests(
inputManifestFiles, inputManifestFiles,
deploymentStrategy, deploymentStrategy,
kubectl, kubectl,
trafficSplitMethod trafficSplitMethod
) );
core.debug(`Deployed manifest files: ${deployedManifestFiles}`) core.debug("Deployed manifest files: " + deployedManifestFiles);
core.endGroup()
// check manifest stability // check manifest stability
core.startGroup('Checking manifest stability') core.info("Checking manifest stability");
const resourceTypes: Resource[] = getResources( const resourceTypes: Resource[] = getResources(
deployedManifestFiles, deployedManifestFiles,
models.DEPLOYMENT_TYPES.concat([ models.DEPLOYMENT_TYPES.concat([
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
]) ])
) );
await checkManifestStability(kubectl, resourceTypes) await checkManifestStability(kubectl, resourceTypes);
core.endGroup()
// print ingresses if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
core.startGroup('Printing ingresses') core.info("Routing blue green");
const ingressResources: Resource[] = getResources(deployedManifestFiles, [ const routeStrategy = parseRouteStrategy(
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS core.getInput("route-method", { required: true })
]) );
for (const ingressResource of ingressResources) { await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy);
await kubectl.getResource( }
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
ingressResource.name
)
}
core.endGroup()
// annotate resources // print ingresses
core.startGroup('Annotating resources') core.info("Printing ingresses");
let allPods const ingressResources: Resource[] = getResources(deployedManifestFiles, [
try { KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
allPods = JSON.parse((await kubectl.getAllPods()).stdout) ]);
} catch (e) { for (const ingressResource of ingressResources) {
core.debug(`Unable to parse pods: ${e}`) await kubectl.getResource(
} KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
await annotateAndLabelResources( ingressResource.name
deployedManifestFiles, );
kubectl, }
resourceTypes,
allPods // annotate resources
) core.info("Annotating resources");
core.endGroup() 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
);
} }
+172 -189
View File
@@ -1,189 +1,172 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as deploy from "./deploy";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as PodCanaryHelper from '../strategyHelpers/canary/podCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import { import {
getResources, getResources,
updateManifestFiles updateManifestFiles,
} from '../utilities/manifestUpdateUtils' } from "../utilities/manifestUpdateUtils";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import { import {
deleteGreenObjects, BlueGreenManifests,
getManifestObjects, deleteWorkloadsAndServicesWithLabel,
NONE_LABEL_VALUE deleteWorkloadsWithLabel,
} from '../strategyHelpers/blueGreen/blueGreenHelper' getManifestObjects,
GREEN_LABEL_VALUE,
import {BlueGreenManifests} from '../types/blueGreenTypes' NONE_LABEL_VALUE,
} from "../strategyHelpers/blueGreen/blueGreenHelper";
import { import {
promoteBlueGreenIngress, promoteBlueGreenService,
promoteBlueGreenService, routeBlueGreenService,
promoteBlueGreenSMI } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
} from '../strategyHelpers/blueGreen/promote' import {
promoteBlueGreenIngress,
import { routeBlueGreenIngress,
routeBlueGreenService, } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
routeBlueGreenIngressUnchanged, import {
routeBlueGreenSMI cleanupSMI,
} from '../strategyHelpers/blueGreen/route' promoteBlueGreenSMI,
routeBlueGreenSMI,
import {cleanupSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper' } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {DeploymentStrategy} from '../types/deploymentStrategy' import { DeploymentStrategy } from "../types/deploymentStrategy";
import { import {
parseTrafficSplitMethod, parseTrafficSplitMethod,
TrafficSplitMethod TrafficSplitMethod,
} from '../types/trafficSplitMethod' } from "../types/trafficSplitMethod";
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
export async function promote( export async function promote(
kubectl: Kubectl, kubectl: Kubectl,
manifests: string[], manifests: string[],
deploymentStrategy: DeploymentStrategy deploymentStrategy: DeploymentStrategy
) { ) {
switch (deploymentStrategy) { switch (deploymentStrategy) {
case DeploymentStrategy.CANARY: case DeploymentStrategy.CANARY:
await promoteCanary(kubectl, manifests) await promoteCanary(kubectl, manifests);
break break;
case DeploymentStrategy.BLUE_GREEN: case DeploymentStrategy.BLUE_GREEN:
await promoteBlueGreen(kubectl, manifests) await promoteBlueGreen(kubectl, manifests);
break break;
default: default:
throw Error('Invalid promote deployment strategy') throw Error("Invalid promote deployment strategy");
} }
} }
async function promoteCanary(kubectl: Kubectl, manifests: string[]) { async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
let includeServices = false let includeServices = false;
const manifestFilesForDeployment: string[] = updateManifestFiles(manifests) const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true })
const trafficSplitMethod = parseTrafficSplitMethod( );
core.getInput('traffic-split-method', {required: true}) if (trafficSplitMethod == TrafficSplitMethod.SMI) {
) includeServices = 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
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to core.info("Redirecting traffic to canary deployment");
// canary deployment, then update stable deployment and then redirect traffic to stable deployment await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
core.startGroup('Redirecting traffic to canary deployment') kubectl,
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment( manifests
kubectl, );
manifests
) core.info("Deploying input manifests with SMI canary strategy");
core.endGroup() await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
core.startGroup( core.info("Redirecting traffic to stable deployment");
'Deploying input manifests with SMI canary strategy from promote' await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
) kubectl,
await SMICanaryDeploymentHelper.deploySMICanary( manifests
manifestFilesForDeployment, );
kubectl, } else {
true core.info("Deploying input manifests");
) await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
core.endGroup() }
core.startGroup('Redirecting traffic to stable deployment') core.info("Deleting canary and baseline workloads");
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( try {
kubectl, await canaryDeploymentHelper.deleteCanaryDeployment(
manifests kubectl,
) manifests,
core.endGroup() includeServices
} else { );
core.startGroup('Deploying input manifests from promote') } catch (ex) {
await PodCanaryHelper.deployPodCanary( core.warning(
manifestFilesForDeployment, "Exception occurred while deleting canary and baseline workloads: " + ex
kubectl, );
true }
) }
core.endGroup()
} async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
// update container images and pull secrets
core.startGroup('Deleting canary and baseline workloads') const inputManifestFiles: string[] = updateManifestFiles(manifests);
try { const manifestObjects: BlueGreenManifests =
await canaryDeploymentHelper.deleteCanaryDeployment( getManifestObjects(inputManifestFiles);
kubectl,
manifests, const routeStrategy = parseRouteStrategy(
includeServices core.getInput("route-method", { required: true })
) );
} catch (ex) {
core.warning( core.info("Deleting old deployment and making new one");
`Exception occurred while deleting canary and baseline workloads: ${ex}` let result;
) if (routeStrategy == RouteStrategy.INGRESS) {
} result = await promoteBlueGreenIngress(kubectl, manifestObjects);
core.endGroup() } else if (routeStrategy == RouteStrategy.SMI) {
} result = await promoteBlueGreenSMI(kubectl, manifestObjects);
} else {
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) { result = await promoteBlueGreenService(kubectl, manifestObjects);
// update container images and pull secrets }
const inputManifestFiles: string[] = updateManifestFiles(manifests)
const manifestObjects: BlueGreenManifests = // checking stability of newly created deployments
getManifestObjects(inputManifestFiles) core.info("Checking manifest stability");
const deployedManifestFiles = result.newFilePaths;
const routeStrategy = parseRouteStrategy( const resources: Resource[] = getResources(
core.getInput('route-method', {required: true}) deployedManifestFiles,
) models.DEPLOYMENT_TYPES.concat([
models.DiscoveryAndLoadBalancerResource.SERVICE,
core.startGroup('Deleting old deployment and making new stable deployment') ])
);
const {deployResult} = await (async () => { await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
switch (routeStrategy) {
case RouteStrategy.INGRESS: core.info(
return await promoteBlueGreenIngress(kubectl, manifestObjects) "Routing to new deployments and deleting old workloads and services"
case RouteStrategy.SMI: );
return await promoteBlueGreenSMI(kubectl, manifestObjects) if (routeStrategy == RouteStrategy.INGRESS) {
default: await routeBlueGreenIngress(
return await promoteBlueGreenService(kubectl, manifestObjects) kubectl,
} null,
})() manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
core.endGroup() );
await deleteWorkloadsAndServicesWithLabel(
// checking stability of newly created deployments kubectl,
core.startGroup('Checking manifest stability') GREEN_LABEL_VALUE,
const deployedManifestFiles = deployResult.manifestFiles manifestObjects.deploymentEntityList,
const resources: Resource[] = getResources( manifestObjects.serviceEntityList
deployedManifestFiles, );
models.DEPLOYMENT_TYPES.concat([ } else if (routeStrategy == RouteStrategy.SMI) {
models.DiscoveryAndLoadBalancerResource.SERVICE await routeBlueGreenSMI(
]) kubectl,
) NONE_LABEL_VALUE,
await KubernetesManifestUtility.checkManifestStability(kubectl, resources) manifestObjects.serviceEntityList
core.endGroup() );
await deleteWorkloadsWithLabel(
core.startGroup( kubectl,
'Routing to new deployments and deleting old workloads and services' GREEN_LABEL_VALUE,
) manifestObjects.deploymentEntityList
if (routeStrategy == RouteStrategy.INGRESS) { );
await routeBlueGreenIngressUnchanged( await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
kubectl, } else {
manifestObjects.serviceNameMap, await routeBlueGreenService(
manifestObjects.ingressEntityList kubectl,
) NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
await deleteGreenObjects( );
kubectl, await deleteWorkloadsWithLabel(
[].concat( kubectl,
manifestObjects.deploymentEntityList, GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList manifestObjects.deploymentEntityList
) );
) }
} 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()
}
+68 -77
View File
@@ -1,77 +1,68 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper' import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper' import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
import {BlueGreenManifests} from '../types/blueGreenTypes' import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
import { import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
rejectBlueGreenIngress, import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
rejectBlueGreenService, import { DeploymentStrategy } from "../types/deploymentStrategy";
rejectBlueGreenSMI import {
} from '../strategyHelpers/blueGreen/reject' parseTrafficSplitMethod,
import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper' TrafficSplitMethod,
import {DeploymentStrategy} from '../types/deploymentStrategy' } from "../types/trafficSplitMethod";
import { import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
parseTrafficSplitMethod,
TrafficSplitMethod export async function reject(
} from '../types/trafficSplitMethod' kubectl: Kubectl,
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy' manifests: string[],
deploymentStrategy: DeploymentStrategy
export async function reject( ) {
kubectl: Kubectl, switch (deploymentStrategy) {
manifests: string[], case DeploymentStrategy.CANARY:
deploymentStrategy: DeploymentStrategy await rejectCanary(kubectl, manifests);
) { break;
switch (deploymentStrategy) { case DeploymentStrategy.BLUE_GREEN:
case DeploymentStrategy.CANARY: await rejectBlueGreen(kubectl, manifests);
await rejectCanary(kubectl, manifests) break;
break default:
case DeploymentStrategy.BLUE_GREEN: throw "Invalid delete deployment strategy";
await rejectBlueGreen(kubectl, manifests) }
break }
default:
throw 'Invalid delete deployment strategy' async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
} let includeServices = false;
}
const trafficSplitMethod = parseTrafficSplitMethod(
async function rejectCanary(kubectl: Kubectl, manifests: string[]) { core.getInput("traffic-split-method", { required: true })
let includeServices = false );
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
const trafficSplitMethod = parseTrafficSplitMethod( core.info("Rejecting deployment with SMI canary strategy");
core.getInput('traffic-split-method', {required: true}) includeServices = true;
) await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
if (trafficSplitMethod == TrafficSplitMethod.SMI) { kubectl,
core.startGroup('Rejecting deployment with SMI canary strategy') manifests
includeServices = true );
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment( }
kubectl,
manifests core.info("Deleting baseline and canary workloads");
) await canaryDeploymentHelper.deleteCanaryDeployment(
core.endGroup() kubectl,
} manifests,
includeServices
core.startGroup('Deleting baseline and canary workloads') );
await canaryDeploymentHelper.deleteCanaryDeployment( }
kubectl,
manifests, async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
includeServices core.info("Rejecting deployment with blue green strategy");
)
core.endGroup() const routeStrategy = parseRouteStrategy(
} core.getInput("route-method", { required: true })
);
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) { if (routeStrategy == RouteStrategy.INGRESS) {
const routeStrategy = parseRouteStrategy( await rejectBlueGreenIngress(kubectl, manifests);
core.getInput('route-method', {required: true}) } else if (routeStrategy == RouteStrategy.SMI) {
) await rejectBlueGreenSMI(kubectl, manifests);
core.startGroup('Rejecting deployment with blue green strategy') } else {
core.info(`using routeMethod ${routeStrategy}`) await rejectBlueGreenService(kubectl, manifests);
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
@@ -1,16 +0,0 @@
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
}
+56 -69
View File
@@ -1,69 +1,56 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {getKubectlPath, Kubectl} from './types/kubectl' import { getKubectlPath, Kubectl } from "./types/kubectl";
import {deploy} from './actions/deploy' import { deploy } from "./actions/deploy";
import {promote} from './actions/promote' import { promote } from "./actions/promote";
import {reject} from './actions/reject' import { reject } from "./actions/reject";
import {Action, parseAction} from './types/action' import { Action, parseAction } from "./types/action";
import {parseDeploymentStrategy} from './types/deploymentStrategy' import { parseDeploymentStrategy } from "./types/deploymentStrategy";
import {getFilesFromDirectories} from './utilities/fileUtils' import { getFilesFromDirectories } from "./utilities/fileUtils";
import {PrivateKubectl} from './types/privatekubectl'
export async function run() {
export async function run() { // verify kubeconfig is set
// verify kubeconfig is set if (!process.env["KUBECONFIG"])
if (!process.env['KUBECONFIG']) core.warning(
core.warning( "KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action."
'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.' );
)
// get inputs
// get inputs const action: Action | undefined = parseAction(
const action: Action | undefined = parseAction( core.getInput("action", { required: true })
core.getInput('action', {required: true}) );
) const strategy = parseDeploymentStrategy(core.getInput("strategy"));
const strategy = parseDeploymentStrategy(core.getInput('strategy')) const manifestsInput = core.getInput("manifests", { required: true });
const manifestsInput = core.getInput('manifests', {required: true}) const manifestFilePaths = manifestsInput
const manifestFilePaths = manifestsInput .split(/[\n,;]+/) // split into each individual manifest
.split(/[\n,;]+/) // split into each individual manifest .map((manifest) => manifest.trim()) // remove surrounding whitespace
.map((manifest) => manifest.trim()) // remove surrounding whitespace .filter((manifest) => manifest.length > 0); // remove any blanks
.filter((manifest) => manifest.length > 0) // remove any blanks
const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths) // create kubectl
const kubectlPath = await getKubectlPath() const kubectlPath = await getKubectlPath();
const namespace = core.getInput('namespace') || 'default' const namespace = core.getInput("namespace") || "default";
const isPrivateCluster = const kubectl = new Kubectl(kubectlPath, namespace, true);
core.getInput('private-cluster').toLowerCase() === 'true'
const resourceGroup = core.getInput('resource-group') || '' // run action
const resourceName = core.getInput('name') || '' switch (action) {
case Action.DEPLOY: {
const kubectl = isPrivateCluster await deploy(kubectl, fullManifestFilePaths, strategy);
? new PrivateKubectl( break;
kubectlPath, }
namespace, case Action.PROMOTE: {
true, await promote(kubectl, fullManifestFilePaths, strategy);
resourceGroup, break;
resourceName }
) case Action.REJECT: {
: new Kubectl(kubectlPath, namespace, true) await reject(kubectl, fullManifestFilePaths, strategy);
break;
// run action }
switch (action) { default: {
case Action.DEPLOY: { throw Error(
await deploy(kubectl, fullManifestFilePaths, strategy) 'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
break );
} }
case Action.PROMOTE: { }
await promote(kubectl, fullManifestFilePaths, strategy) }
break
} run().catch(core.setFailed);
case Action.REJECT: {
await reject(kubectl, fullManifestFilePaths, strategy)
break
}
default: {
throw Error(
'Not a valid action. The allowed actions are "deploy", "promote", and "reject".'
)
}
}
}
run().catch(core.setFailed)
@@ -1,196 +0,0 @@
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')
})
})
+298 -209
View File
@@ -1,266 +1,355 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import { Kubectl } from "../../types/kubectl";
import {DeployResult} from '../../types/deployResult'
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import { import {
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
KubernetesWorkload KubernetesWorkload,
} from '../../types/kubernetesTypes' } from "../../types/kubernetesTypes";
import * as fileHelper from "../../utilities/fileUtils";
import { routeBlueGreenService } from "./serviceBlueGreenHelper";
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
import { import {
BlueGreenDeployment, UnsetClusterSpecificDetails,
BlueGreenManifests updateObjectLabels,
} from '../../types/blueGreenTypes' updateSelectorLabels,
import * as fileHelper from '../../utilities/fileUtils' } from "../../utilities/manifestUpdateUtils";
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils' import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import {checkForErrors} from '../../utilities/kubectlUtils' import { checkForErrors } from "../../utilities/kubectlUtils";
import { import { sleep } from "../../utilities/timeUtils";
UnsetClusterSpecificDetails, import { RouteStrategy } from "../../types/routeStrategy";
updateObjectLabels,
updateSelectorLabels
} from '../../utilities/manifestUpdateUtils'
export const GREEN_LABEL_VALUE = 'green' export const GREEN_LABEL_VALUE = "green";
export const NONE_LABEL_VALUE = 'None' export const NONE_LABEL_VALUE = "None";
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color' export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color";
export const GREEN_SUFFIX = '-green' export const GREEN_SUFFIX = "-green";
export const STABLE_SUFFIX = '-stable' export const STABLE_SUFFIX = "-stable";
export async function deleteGreenObjects( export interface BlueGreenManifests {
kubectl: Kubectl, serviceEntityList: any[];
toDelete: K8sObject[] serviceNameMap: Map<string, string>;
): Promise<K8sDeleteObject[]> { unroutedServiceEntityList: any[];
// const resourcesToDelete: K8sDeleteObject[] = [] deploymentEntityList: any[];
const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => { ingressEntityList: any[];
return { otherObjects: any[];
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( export async function routeBlueGreen(
kubectl: Kubectl, kubectl: Kubectl,
deleteList: K8sDeleteObject[] inputManifestFiles: string[],
routeStrategy: RouteStrategy
) { ) {
// delete services and deployments // sleep for buffer time
for (const delObject of deleteList) { const bufferTime: number = parseInt(
try { core.getInput("version-switch-buffer") || "0"
const result = await kubectl.delete([delObject.kind, delObject.name]) );
checkForErrors([result]) if (bufferTime < 0 || bufferTime > 300)
} catch (ex) { throw Error("Version switch buffer must be between 0 and 300 (inclusive)");
core.debug(`failed to delete object ${delObject.name}: ${ex}`) 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);
core.debug("Manifest objects: " + JSON.stringify(manifestObjects));
// route to new deployments
if (routeStrategy == RouteStrategy.INGRESS) {
await routeBlueGreenIngress(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
} else if (routeStrategy == RouteStrategy.SMI) {
await routeBlueGreenSMI(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
} else {
await routeBlueGreenService(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.serviceEntityList
);
}
}
export async function deleteWorkloadsWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[]
) {
const resourcesToDelete = [];
deploymentEntityList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable deployments
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete new green deployments
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteWorkloadsAndServicesWithLabel(
kubectl: Kubectl,
deleteLabel: string,
deploymentEntityList: any[],
serviceEntityList: any[]
) {
// need to delete services and deployments
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
const resourcesToDelete = [];
deletionEntitiesList.forEach((inputObject) => {
const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (deleteLabel === NONE_LABEL_VALUE) {
// delete stable objects
const resourceToDelete = { name, kind };
resourcesToDelete.push(resourceToDelete);
} else {
// delete green labels
const resourceToDelete = {
name: getBlueGreenResourceName(name, GREEN_SUFFIX),
kind: kind,
};
resourcesToDelete.push(resourceToDelete);
}
});
await deleteObjects(kubectl, resourcesToDelete);
}
export async function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
// delete services and deployments
for (const delObject of deleteList) {
try {
const result = await kubectl.delete([delObject.kind, delObject.name]);
checkForErrors([result]);
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
}
} }
// other common functions // other common functions
export function getManifestObjects(filePaths: string[]): BlueGreenManifests { export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
const deploymentEntityList: K8sObject[] = [] const deploymentEntityList = [];
const routedServiceEntityList: K8sObject[] = [] const routedServiceEntityList = [];
const unroutedServiceEntityList: K8sObject[] = [] const unroutedServiceEntityList = [];
const ingressEntityList: K8sObject[] = [] const ingressEntityList = [];
const otherEntitiesList: K8sObject[] = [] const otherEntitiesList = [];
const serviceNameMap = new Map<string, string>() const serviceNameMap = new Map<string, string>();
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString() const fileContents = fs.readFileSync(filePath).toString();
yaml.safeLoadAll(fileContents, (inputObject) => { yaml.safeLoadAll(fileContents, (inputObject) => {
if (!!inputObject) { if (!!inputObject) {
const kind = inputObject.kind const kind = inputObject.kind;
const name = inputObject.metadata.name const name = inputObject.metadata.name;
if (isDeploymentEntity(kind)) { if (isDeploymentEntity(kind)) {
deploymentEntityList.push(inputObject) deploymentEntityList.push(inputObject);
} else if (isServiceEntity(kind)) { } else if (isServiceEntity(kind)) {
if (isServiceRouted(inputObject, deploymentEntityList)) { if (isServiceRouted(inputObject, deploymentEntityList)) {
routedServiceEntityList.push(inputObject) routedServiceEntityList.push(inputObject);
serviceNameMap.set( serviceNameMap.set(
name, name,
getBlueGreenResourceName(name, GREEN_SUFFIX) getBlueGreenResourceName(name, GREEN_SUFFIX)
) );
} else { } else {
unroutedServiceEntityList.push(inputObject) unroutedServiceEntityList.push(inputObject);
} }
} else if (isIngressEntity(kind)) { } else if (isIngressEntity(kind)) {
ingressEntityList.push(inputObject) ingressEntityList.push(inputObject);
} else { } else {
otherEntitiesList.push(inputObject) otherEntitiesList.push(inputObject);
} }
} }
}) });
}) });
return { return {
serviceEntityList: routedServiceEntityList, serviceEntityList: routedServiceEntityList,
serviceNameMap: serviceNameMap, serviceNameMap: serviceNameMap,
unroutedServiceEntityList: unroutedServiceEntityList, unroutedServiceEntityList: unroutedServiceEntityList,
deploymentEntityList: deploymentEntityList, deploymentEntityList: deploymentEntityList,
ingressEntityList: ingressEntityList, ingressEntityList: ingressEntityList,
otherObjects: otherEntitiesList otherObjects: otherEntitiesList,
} };
} }
export function isServiceRouted( export function isServiceRouted(
serviceObject: any[], serviceObject: any[],
deploymentEntityList: any[] deploymentEntityList: any[]
): boolean { ): boolean {
const serviceSelector: any = getServiceSelector(serviceObject) let shouldBeRouted: boolean = false;
const serviceSelector: any = getServiceSelector(serviceObject);
return ( if (serviceSelector) {
serviceSelector && if (
deploymentEntityList.some((depObject) => { deploymentEntityList.some((depObject) => {
// finding if there is a deployment in the given manifests the service targets // finding if there is a deployment in the given manifests the service targets
const matchLabels: any = getDeploymentMatchLabels(depObject) const matchLabels: any = getDeploymentMatchLabels(depObject);
return ( return (
matchLabels && matchLabels &&
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels) isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
) );
}) })
) ) {
shouldBeRouted = true;
}
}
return shouldBeRouted;
} }
export async function deployWithLabel( export async function createWorkloadsWithLabel(
kubectl: Kubectl, kubectl: Kubectl,
deploymentObjectList: any[], deploymentObjectList: any[],
nextLabel: string nextLabel: string
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = deploymentObjectList.map((inputObject) => const newObjectsList = [];
getNewBlueGreenObject(inputObject, nextLabel) deploymentObjectList.forEach((inputObject) => {
) // creating deployment with label
const newBlueGreenObject = getNewBlueGreenObject(inputObject, nextLabel);
core.debug(
"New blue-green object is: " + JSON.stringify(newBlueGreenObject)
);
newObjectsList.push(newBlueGreenObject);
});
core.debug( const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
`objects deployed with label are ${JSON.stringify(newObjectsList)}` const result = await kubectl.apply(manifestFiles);
)
const deployResult = await deployObjects(kubectl, newObjectsList) return { result: result, newFilePaths: manifestFiles };
return {deployResult, objects: newObjectsList}
} }
export function getNewBlueGreenObject( export function getNewBlueGreenObject(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Updating name only if label is green label is given // Updating name only if label is green label is given
if (labelValue === GREEN_LABEL_VALUE) { if (labelValue === GREEN_LABEL_VALUE) {
newObject.metadata.name = getBlueGreenResourceName( newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
GREEN_SUFFIX GREEN_SUFFIX
) );
} }
// Adding labels and annotations // Adding labels and annotations
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export function addBlueGreenLabelsAndAnnotations( export function addBlueGreenLabelsAndAnnotations(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
) { ) {
//creating the k8s.deploy.color label //creating the k8s.deploy.color label
const newLabels = new Map<string, string>() const newLabels = new Map<string, string>();
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
// updating object labels and selector labels // updating object labels and selector labels
updateObjectLabels(inputObject, newLabels, false) updateObjectLabels(inputObject, newLabels, false);
updateSelectorLabels(inputObject, newLabels, false) updateSelectorLabels(inputObject, newLabels, false);
// updating spec labels if it is not a service // updating spec labels if it is a service
if (!isServiceEntity(inputObject.kind)) { if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false) updateSpecLabels(inputObject, newLabels, false);
} }
} }
export function getBlueGreenResourceName(name: string, suffix: string) { export function getBlueGreenResourceName(name: string, suffix: string) {
return `${name}${suffix}` return `${name}${suffix}`;
} }
export function getDeploymentMatchLabels(deploymentObject: any): any { export function getDeploymentMatchLabels(deploymentObject: any): any {
if ( if (
deploymentObject?.kind?.toUpperCase() == deploymentObject?.kind?.toUpperCase() ==
KubernetesWorkload.POD.toUpperCase() && KubernetesWorkload.POD.toUpperCase() &&
deploymentObject?.metadata?.labels deploymentObject?.metadata?.labels
) { ) {
return deploymentObject.metadata.labels return deploymentObject.metadata.labels;
} else if (deploymentObject?.spec?.selector?.matchLabels) { } else if (deploymentObject?.spec?.selector?.matchLabels) {
return deploymentObject.spec.selector.matchLabels return deploymentObject.spec.selector.matchLabels;
} }
} }
export function getServiceSelector(serviceObject: any): any { export function getServiceSelector(serviceObject: any): any {
if (serviceObject?.spec?.selector) { if (serviceObject?.spec?.selector) {
return serviceObject.spec.selector return serviceObject.spec.selector;
} }
} }
export function isServiceSelectorSubsetOfMatchLabel( export function isServiceSelectorSubsetOfMatchLabel(
serviceSelector: any, serviceSelector: any,
matchLabels: any matchLabels: any
): boolean { ): boolean {
const serviceSelectorMap = new Map() const serviceSelectorMap = new Map();
const matchLabelsMap = new Map() const matchLabelsMap = new Map();
JSON.parse(JSON.stringify(serviceSelector), (key, value) => { JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
serviceSelectorMap.set(key, value) serviceSelectorMap.set(key, value);
}) });
JSON.parse(JSON.stringify(matchLabels), (key, value) => { JSON.parse(JSON.stringify(matchLabels), (key, value) => {
matchLabelsMap.set(key, value) matchLabelsMap.set(key, value);
}) });
let isMatch = true let isMatch = true;
serviceSelectorMap.forEach((value, key) => { serviceSelectorMap.forEach((value, key) => {
if ( if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value)
!!key && isMatch = false;
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value });
)
isMatch = false
})
return isMatch return isMatch;
} }
export async function fetchResource( export async function fetchResource(
kubectl: Kubectl, kubectl: Kubectl,
kind: string, kind: string,
name: string name: string
): Promise<K8sObject> { ) {
const result = await kubectl.getResource(kind, name) const result = await kubectl.getResource(kind, name);
if (result == null || !!result.stderr) { if (result == null || !!result.stderr) {
return null return null;
} }
if (!!result.stdout) { if (!!result.stdout) {
const resource = JSON.parse(result.stdout) as K8sObject const resource = JSON.parse(result.stdout);
try { try {
UnsetClusterSpecificDetails(resource) UnsetClusterSpecificDetails(resource);
return resource return resource;
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while Parsing ${resource} in Json object: ${ex}` `Exception occurred while Parsing ${resource} in Json object: ${ex}`
) );
} }
} }
}
export async function deployObjects(
kubectl: Kubectl,
objectsList: any[]
): Promise<DeployResult> {
const manifestFiles = fileHelper.writeObjectsToFile(objectsList)
const execResult = await kubectl.apply(manifestFiles)
return {execResult, manifestFiles}
} }
@@ -1,75 +0,0 @@
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
@@ -1,136 +0,0 @@
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)
}
}
@@ -1,123 +0,0 @@
import {getManifestObjects, GREEN_LABEL_VALUE} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {
getUpdatedBlueGreenIngress,
isIngressRouted,
validateIngresses
} from './ingressBlueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
const betaFilepath = ['test/unit/manifests/test-ingress.yml']
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const kubectl = new Kubectl('')
jest.mock('../../types/kubectl')
describe('ingress blue green helpers', () => {
let testObjects
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('it should correctly classify ingresses', () => {
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
testObjects.ingressEntityList[0].spec.rules[0].http.paths = {}
expect(
isIngressRouted(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(false)
expect(
isIngressRouted(
getManifestObjects(betaFilepath).ingressEntityList[0],
testObjects.serviceNameMap
)
).toBe(true)
})
test('it should correctly update ingresses', () => {
const updatedIng = getUpdatedBlueGreenIngress(
testObjects.ingressEntityList[0],
testObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.name).toBe('nginx-ingress')
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
const oldIngObjects = getManifestObjects(betaFilepath)
const oldIng = getUpdatedBlueGreenIngress(
oldIngObjects.ingressEntityList[0],
oldIngObjects.serviceNameMap,
GREEN_LABEL_VALUE
)
expect(updatedIng.metadata.labels['k8s.deploy.color']).toBe('green')
expect(updatedIng.spec.rules[0].http.paths[0].backend.service.name).toBe(
'nginx-service-green'
)
})
test('it should validate ingresses', async () => {
// what if nothing gets returned from fetchResource?
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
let validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test valid ingress
let mockIngress = JSON.parse(
JSON.stringify(testObjects.ingressEntityList[0])
)
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service-green'
const mockLabels = new Map<string, string>()
mockLabels[bgHelper.BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
mockIngress.metadata.labels = mockLabels
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockIngress))
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(true)
// test invalid labels
mockIngress.metadata.labels[bgHelper.BLUE_GREEN_VERSION_LABEL] =
bgHelper.NONE_LABEL_VALUE
mockIngress.spec.rules[0].http.paths[0].backend.service.name =
'nginx-service'
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
// test missing fields
mockIngress = {}
validResponse = await validateIngresses(
kubectl,
testObjects.ingressEntityList,
testObjects.serviceNameMap
)
expect(validResponse.areValid).toBe(false)
})
})
@@ -1,120 +1,229 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sIngress} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
GREEN_LABEL_VALUE, BlueGreenManifests,
fetchResource createWorkloadsWithLabel,
} from './blueGreenHelper' deleteWorkloadsAndServicesWithLabel,
import {Kubectl} from '../../types/kubectl' fetchResource,
getManifestObjects,
getNewBlueGreenObject,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
import * as core from "@actions/core";
const BACKEND = 'backend' const BACKEND = "BACKEND";
export function getUpdatedBlueGreenIngress( export async function deployBlueGreenIngress(
inputObject: any, kubectl: Kubectl,
serviceNameMap: Map<string, string>, filePaths: string[]
type: string ) {
): K8sIngress { // get all kubernetes objects defined in manifest files
const newObject = JSON.parse(JSON.stringify(inputObject)) const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type)
// update ingress labels // create deployments with green label value
if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') { const result = createWorkloadsWithLabel(
return updateIngressBackendBetaV1(newObject, serviceNameMap) kubectl,
} manifestObjects.deploymentEntityList,
return updateIngressBackend(newObject, serviceNameMap) GREEN_LABEL_VALUE
);
// create new services and other objects
let newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
newObjectsList = newObjectsList
.concat(manifestObjects.otherObjects)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
} }
export function updateIngressBackendBetaV1( export async function promoteBlueGreenIngress(
inputObject: any, kubectl: Kubectl,
serviceNameMap: Map<string, string> manifestObjects
): any { ) {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { //checking if anything to promote
if (key.toLowerCase() === BACKEND) { if (
const {serviceName} = value !validateIngressesState(
if (serviceNameMap.has(serviceName)) { kubectl,
// update service name with corresponding bluegreen name only if service is provied in given manifests manifestObjects.ingressEntityList,
value.serviceName = serviceNameMap.get(serviceName) manifestObjects.serviceNameMap
} )
) {
throw "Ingress not in promote state";
}
// create stable deployments with new configuration
const result = createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
// create stable services with new configuration
const newObjectsList = [];
manifestObjects.serviceEntityList.forEach((inputObject) => {
const newBlueGreenObject = getNewBlueGreenObject(
inputObject,
NONE_LABEL_VALUE
);
newObjectsList.push(newBlueGreenObject);
});
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
return result;
}
export async function rejectBlueGreenIngress(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route ingress to stables services
await routeBlueGreenIngress(
kubectl,
null,
manifestObjects.serviceNameMap,
manifestObjects.ingressEntityList
);
// delete green services and deployments
await deleteWorkloadsAndServicesWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList,
manifestObjects.serviceEntityList
);
}
export async function routeBlueGreenIngress(
kubectl: Kubectl,
nextLabel: string,
serviceNameMap: Map<string, string>,
ingressEntityList: any[]
) {
let newObjectsList = [];
if (!nextLabel) {
newObjectsList = ingressEntityList.filter((ingress) =>
isIngressRouted(ingress, serviceNameMap)
);
} else {
ingressEntityList.forEach((inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
inputObject,
serviceNameMap,
GREEN_LABEL_VALUE
);
newObjectsList.push(newBlueGreenIngressObject);
} else {
newObjectsList.push(inputObject);
} }
});
}
return value core.debug("New objects: " + JSON.stringify(newObjectsList));
}) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
return inputObject export function validateIngressesState(
kubectl: Kubectl,
ingressEntityList: any[],
serviceNameMap: Map<string, string>
): boolean {
let areIngressesTargetingNewServices: boolean = true;
ingressEntityList.forEach(async (inputObject) => {
if (isIngressRouted(inputObject, serviceNameMap)) {
//querying existing ingress
const existingIngress = await fetchResource(
kubectl,
inputObject.kind,
inputObject.metadata.name
);
if (!!existingIngress) {
const currentLabel: string =
existingIngress?.metadata?.labels[BLUE_GREEN_VERSION_LABEL];
// if not green label, then wrong configuration
if (currentLabel != GREEN_LABEL_VALUE)
areIngressesTargetingNewServices = false;
} else {
// no ingress at all, so nothing to promote
areIngressesTargetingNewServices = false;
}
}
});
return areIngressesTargetingNewServices;
}
function isIngressRouted(
ingressObject: any,
serviceNameMap: Map<string, string>
): boolean {
let isIngressRouted: boolean = false;
// check if ingress targets a service in the given manifests
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
if (key === "serviceName" && serviceNameMap.has(value)) {
isIngressRouted = true;
}
return value;
});
return isIngressRouted;
}
export function getUpdatedBlueGreenIngress(
inputObject: any,
serviceNameMap: Map<string, string>,
type: string
): object {
if (!type) {
return inputObject;
}
const newObject = JSON.parse(JSON.stringify(inputObject));
// add green labels and values
addBlueGreenLabelsAndAnnotations(newObject, type);
// update ingress labels
return updateIngressBackend(newObject, serviceNameMap);
} }
export function updateIngressBackend( export function updateIngressBackend(
inputObject: any, inputObject: any,
serviceNameMap: Map<string, string> serviceNameMap: Map<string, string>
): any { ): any {
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => { inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
if ( if (key.toUpperCase() === BACKEND) {
key.toLowerCase() === BACKEND && const { serviceName } = value;
serviceNameMap.has(value.service.name) if (serviceNameMap.has(serviceName)) {
) { // update service name with corresponding bluegreen name only if service is provied in given manifests
value.service.name = serviceNameMap.get(value.service.name) value.serviceName = serviceNameMap.get(serviceName);
} }
return value }
})
return inputObject return value;
} });
export function isIngressRouted( return inputObject;
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}
} }
@@ -1,158 +0,0 @@
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
@@ -1,81 +0,0 @@
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
)
}
@@ -1,66 +0,0 @@
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
@@ -1,81 +0,0 @@
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
@@ -1,119 +0,0 @@
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
@@ -1,141 +0,0 @@
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}
}
@@ -1,65 +0,0 @@
import * as core from '@actions/core'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE
} from './blueGreenHelper'
import * as bgHelper from './blueGreenHelper'
import {Kubectl} from '../../types/kubectl'
import {
getServiceSpecLabel,
getUpdatedBlueGreenService,
validateServicesState
} from './serviceBlueGreenHelper'
let testObjects
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
jest.mock('../../types/kubectl')
const kubectl = new Kubectl('')
describe('blue/green service helper tests', () => {
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
testObjects = getManifestObjects(ingressFilepath)
})
test('getUpdatedBlueGreenService', () => {
const newService = getUpdatedBlueGreenService(
testObjects.serviceEntityList[0],
GREEN_LABEL_VALUE
)
expect(newService.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
expect(newService.spec.selector[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateServicesState', async () => {
const mockLabels = new Map<string, string>()
mockLabels[BLUE_GREEN_VERSION_LABEL] = bgHelper.GREEN_LABEL_VALUE
const mockSelectors = new Map<string, string>()
mockSelectors[BLUE_GREEN_VERSION_LABEL] = GREEN_LABEL_VALUE
jest.spyOn(bgHelper, 'fetchResource').mockImplementation(() =>
Promise.resolve({
kind: 'Service',
spec: {selector: mockSelectors},
metadata: {labels: mockLabels, name: 'nginx-service-green'}
})
)
expect(
await validateServicesState(kubectl, testObjects.serviceEntityList)
).toBe(true)
})
test('getServiceSpecLabel', () => {
testObjects.serviceEntityList[0].spec.selector[BLUE_GREEN_VERSION_LABEL] =
GREEN_LABEL_VALUE
expect(getServiceSpecLabel(testObjects.serviceEntityList[0])).toBe(
GREEN_LABEL_VALUE
)
})
})
@@ -1,49 +1,146 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {K8sServiceObject} from '../../types/k8sObject' import * as fileHelper from "../../utilities/fileUtils";
import {Kubectl} from '../../types/kubectl'
import { import {
addBlueGreenLabelsAndAnnotations, addBlueGreenLabelsAndAnnotations,
BLUE_GREEN_VERSION_LABEL, BLUE_GREEN_VERSION_LABEL,
fetchResource, BlueGreenManifests,
GREEN_LABEL_VALUE createWorkloadsWithLabel,
} from './blueGreenHelper' deleteWorkloadsWithLabel,
fetchResource,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE,
} from "./blueGreenHelper";
export async function deployBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// create deployments with green label value
const result = await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
// create other non deployment and non service entities
const newObjectsList = manifestObjects.otherObjects
.concat(manifestObjects.ingressEntityList)
.concat(manifestObjects.unroutedServiceEntityList);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
if (manifestFiles.length > 0) await kubectl.apply(manifestFiles);
// returning deployment details to check for rollout stability
return result;
}
export async function promoteBlueGreenService(
kubectl: Kubectl,
manifestObjects
) {
// checking if services are in the right state ie. targeting green deployments
if (
!(await validateServicesState(kubectl, manifestObjects.serviceEntityList))
) {
throw "Not inP promote state";
}
// creating stable deployments with new configurations
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
}
export async function rejectBlueGreenService(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
// route to stable objects
await routeBlueGreenService(
kubectl,
NONE_LABEL_VALUE,
manifestObjects.serviceEntityList
);
// delete new deployments with green suffix
await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
}
export async function routeBlueGreenService(
kubectl: Kubectl,
nextLabel: string,
serviceEntityList: any[]
) {
const newObjectsList = [];
serviceEntityList.forEach((serviceObject) => {
const newBlueGreenServiceObject = getUpdatedBlueGreenService(
serviceObject,
nextLabel
);
newObjectsList.push(newBlueGreenServiceObject);
});
// configures the services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
}
// add green labels to configure existing service // add green labels to configure existing service
export function getUpdatedBlueGreenService( function getUpdatedBlueGreenService(
inputObject: any, inputObject: any,
labelValue: string labelValue: string
): K8sServiceObject { ): object {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObject = JSON.parse(JSON.stringify(inputObject));
// Adding labels and annotations. // Adding labels and annotations.
addBlueGreenLabelsAndAnnotations(newObject, labelValue) addBlueGreenLabelsAndAnnotations(newObject, labelValue);
return newObject return newObject;
} }
export async function validateServicesState( export async function validateServicesState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let areServicesGreen: boolean = true let areServicesGreen: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
// finding the existing routed service // finding the existing routed service
const existingService = await fetchResource( const existingService = await fetchResource(
kubectl, kubectl,
serviceObject.kind, serviceObject.kind,
serviceObject.metadata.name serviceObject.metadata.name
) );
let isServiceGreen = if (!!existingService) {
!!existingService && const currentLabel: string = getServiceSpecLabel(existingService);
getServiceSpecLabel(existingService as K8sServiceObject) == if (currentLabel != GREEN_LABEL_VALUE) {
GREEN_LABEL_VALUE // service should be targeting deployments with green label
areServicesGreen = areServicesGreen && isServiceGreen areServicesGreen = false;
} }
} else {
// service targeting deployment doesn't exist
areServicesGreen = false;
}
}
return areServicesGreen return areServicesGreen;
} }
export function getServiceSpecLabel(inputObject: K8sServiceObject): string { export function getServiceSpecLabel(inputObject: any): string {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL] if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL];
}
return "";
} }
@@ -1,203 +0,0 @@
import * as core from '@actions/core'
import {TrafficSplitObject} from '../../types/k8sObject'
import {Kubectl} from '../../types/kubectl'
import * as fileHelper from '../../utilities/fileUtils'
import * as TSutils from '../../utilities/trafficSplitUtils'
import {BlueGreenManifests} from '../../types/blueGreenTypes'
import {
BLUE_GREEN_VERSION_LABEL,
getManifestObjects,
GREEN_LABEL_VALUE,
NONE_LABEL_VALUE
} from './blueGreenHelper'
import {
cleanupSMI,
createTrafficSplitObject,
getGreenSMIServiceResource,
getStableSMIServiceResource,
MAX_VAL,
MIN_VAL,
setupSMI,
TRAFFIC_SPLIT_OBJECT,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX,
validateTrafficSplitsState
} from './smiBlueGreenHelper'
import * as bgHelper from './blueGreenHelper'
jest.mock('../../types/kubectl')
const kc = new Kubectl('')
const ingressFilepath = ['test/unit/manifests/test-ingress-new.yml']
const mockTsObject: TrafficSplitObject = {
apiVersion: 'v1alpha3',
kind: TRAFFIC_SPLIT_OBJECT,
metadata: {
name: 'nginx-service-trafficsplit',
labels: new Map<string, string>(),
annotations: new Map<string, string>()
},
spec: {
service: 'nginx-service',
backends: [
{
service: 'nginx-service-stable',
weight: MIN_VAL
},
{
service: 'nginx-service-green',
weight: MAX_VAL
}
]
}
}
describe('SMI Helper tests', () => {
let testObjects: BlueGreenManifests
beforeEach(() => {
//@ts-ignore
Kubectl.mockClear()
jest
.spyOn(TSutils, 'getTrafficSplitAPIVersion')
.mockImplementation(() => Promise.resolve(''))
testObjects = getManifestObjects(ingressFilepath)
jest
.spyOn(fileHelper, 'writeObjectsToFile')
.mockImplementationOnce(() => [''])
})
test('setupSMI tests', async () => {
const smiResults = await setupSMI(kc, testObjects.serviceEntityList)
let found = 0
for (const obj of smiResults.objects) {
if (obj.metadata.name === 'nginx-service-stable') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(obj.spec.selector.app).toBe('nginx')
found++
}
if (obj.metadata.name === 'nginx-service-green') {
expect(obj.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
found++
}
if (obj.metadata.name === 'nginx-service-trafficsplit') {
found++
// expect stable weight to be max val
const casted = obj as TrafficSplitObject
expect(casted.spec.backends).toHaveLength(2)
for (const be of casted.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
}
}
expect(found).toBe(3)
})
test('createTrafficSplitObject tests', async () => {
const noneTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
NONE_LABEL_VALUE
)
expect(noneTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (let be of noneTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MAX_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MIN_VAL)
}
}
const greenTsObject: TrafficSplitObject = await createTrafficSplitObject(
kc,
testObjects.serviceEntityList[0].metadata.name,
GREEN_LABEL_VALUE
)
expect(greenTsObject.metadata.name).toBe('nginx-service-trafficsplit')
for (const be of greenTsObject.spec.backends) {
if (be.service === 'nginx-service-stable') {
expect(be.weight).toBe(MIN_VAL)
}
if (be.service === 'nginx-service-green') {
expect(be.weight).toBe(MAX_VAL)
}
}
})
test('getSMIServiceResource test', () => {
const stableResult = getStableSMIServiceResource(
testObjects.serviceEntityList[0]
)
const greenResult = getGreenSMIServiceResource(
testObjects.serviceEntityList[0]
)
expect(stableResult.metadata.name).toBe('nginx-service-stable')
expect(stableResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
NONE_LABEL_VALUE
)
expect(greenResult.metadata.name).toBe('nginx-service-green')
expect(greenResult.metadata.labels[BLUE_GREEN_VERSION_LABEL]).toBe(
GREEN_LABEL_VALUE
)
})
test('validateTrafficSplitsState', async () => {
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsObject))
let valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(true)
const mockTsCopy = JSON.parse(JSON.stringify(mockTsObject))
mockTsCopy.spec.backends[0].weight = MAX_VAL
jest
.spyOn(bgHelper, 'fetchResource')
.mockImplementation(() => Promise.resolve(mockTsCopy))
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
jest.spyOn(bgHelper, 'fetchResource').mockImplementation()
valResult = await validateTrafficSplitsState(
kc,
testObjects.serviceEntityList
)
expect(valResult).toBe(false)
})
test('cleanupSMI test', async () => {
const deleteObjects = await cleanupSMI(kc, testObjects.serviceEntityList)
expect(deleteObjects).toHaveLength(3)
expect(deleteObjects[0].name).toBe('nginx-service-trafficsplit')
expect(deleteObjects[1].name).toBe('nginx-service-green')
expect(deleteObjects[1].kind).toBe('Service')
expect(deleteObjects[2].name).toBe('nginx-service-stable')
expect(deleteObjects[2].kind).toBe('Service')
})
})
@@ -1,210 +1,272 @@
import * as core from '@actions/core' import { Kubectl } from "../../types/kubectl";
import {Kubectl} from '../../types/kubectl' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as fileHelper from "../../utilities/fileUtils";
import { import {
deleteObjects, BlueGreenManifests,
deployObjects, createWorkloadsWithLabel,
fetchResource, deleteObjects,
getBlueGreenResourceName, deleteWorkloadsWithLabel,
getNewBlueGreenObject, fetchResource,
GREEN_LABEL_VALUE, getBlueGreenResourceName,
GREEN_SUFFIX, getManifestObjects,
NONE_LABEL_VALUE, getNewBlueGreenObject,
STABLE_SUFFIX GREEN_LABEL_VALUE,
} from './blueGreenHelper' GREEN_SUFFIX,
import {BlueGreenDeployment} from '../../types/blueGreenTypes' NONE_LABEL_VALUE,
import { STABLE_SUFFIX,
K8sDeleteObject, } from "./blueGreenHelper";
K8sObject,
TrafficSplitObject
} from '../../types/k8sObject'
import {DeployResult} from '../../types/deployResult'
import {inputAnnotations} from '../../inputUtils'
export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit' const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit";
export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit' const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export const MIN_VAL = 0 const MIN_VAL = 0;
export const MAX_VAL = 100 const MAX_VAL = 100;
export async function setupSMI( export async function deployBlueGreenSMI(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] filePaths: string[]
): Promise<BlueGreenDeployment> { ) {
const newObjectsList = [] // get all kubernetes objects defined in manifest files
const trafficObjectList = [] const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
serviceEntityList.forEach((serviceObject) => { // create services and other objects
// create a trafficsplit for service const newObjectsList = manifestObjects.otherObjects
trafficObjectList.push(serviceObject) .concat(manifestObjects.serviceEntityList)
// set up the services for trafficsplit .concat(manifestObjects.ingressEntityList)
const newStableService = getStableSMIServiceResource(serviceObject) .concat(manifestObjects.unroutedServiceEntityList);
const newGreenService = getGreenSMIServiceResource(serviceObject) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
newObjectsList.push(newStableService) await kubectl.apply(manifestFiles);
newObjectsList.push(newGreenService)
})
const tsObjects: TrafficSplitObject[] = [] // make extraservices and trafficsplit
// route to stable service await setupSMI(kubectl, manifestObjects.serviceEntityList);
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 new deloyments
return await createWorkloadsWithLabel(
kubectl,
manifestObjects.deploymentEntityList,
GREEN_LABEL_VALUE
);
}
// create services export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
const smiDeploymentResult: DeployResult = await deployObjects( // checking if there is something to promote
if (
!(await validateTrafficSplitsState(
kubectl, kubectl,
objectsToDeploy manifestObjects.serviceEntityList
) ))
) {
throw Error("Not in promote state SMI");
}
return { // create stable deployments with new configuration
objects: objectsToDeploy, return await createWorkloadsWithLabel(
deployResult: smiDeploymentResult kubectl,
} manifestObjects.deploymentEntityList,
NONE_LABEL_VALUE
);
} }
let trafficSplitAPIVersion = '' export async function rejectBlueGreenSMI(
kubectl: Kubectl,
filePaths: string[]
) {
// get all kubernetes objects defined in manifest files
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
export async function createTrafficSplitObject( // route trafficsplit to stable deploymetns
kubectl: Kubectl, await routeBlueGreenSMI(
name: string, kubectl,
nextLabel: string NONE_LABEL_VALUE,
): Promise<TrafficSplitObject> { manifestObjects.serviceEntityList
// cache traffic split api version );
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
)
// retrieve annotations for TS object // delete rejected new bluegreen deployments
const annotations = inputAnnotations await deleteWorkloadsWithLabel(
kubectl,
GREEN_LABEL_VALUE,
manifestObjects.deploymentEntityList
);
// decide weights based on nextlabel // delete trafficsplit and extra services
const stableWeight: number = await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
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 { export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
const newObject = JSON.parse(JSON.stringify(inputObject)) const newObjectsList = [];
// adding stable suffix to service name const trafficObjectList = [];
newObject.metadata.name = getBlueGreenResourceName(
serviceEntityList.forEach((serviceObject) => {
// create a trafficsplit for service
trafficObjectList.push(serviceObject);
// set up the services for trafficsplit
const newStableService = getSMIServiceResource(
serviceObject,
STABLE_SUFFIX
);
const newGreenService = getSMIServiceResource(serviceObject, GREEN_SUFFIX);
newObjectsList.push(newStableService);
newObjectsList.push(newGreenService);
});
// create services
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
await kubectl.apply(manifestFiles);
// route to stable service
trafficObjectList.forEach((inputObject) => {
createTrafficSplitObject(
kubectl,
inputObject.metadata.name,
NONE_LABEL_VALUE
);
});
}
let trafficSplitAPIVersion = "";
async function createTrafficSplitObject(
kubectl: Kubectl,
name: string,
nextLabel: string
): Promise<any> {
// cache traffic split api version
if (!trafficSplitAPIVersion)
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl
);
// decide weights based on nextlabel
const stableWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL;
const greenWeight: number =
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL;
const trafficSplitObject = JSON.stringify({
apiVersion: trafficSplitAPIVersion,
kind: "TrafficSplit",
metadata: {
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
},
spec: {
service: name,
backends: [
{
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
weight: stableWeight,
},
{
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
weight: greenWeight,
},
],
},
});
// create traffic split object
const trafficSplitManifestFile = fileHelper.writeManifestToFile(
trafficSplitObject,
TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
);
await kubectl.apply(trafficSplitManifestFile);
}
export function getSMIServiceResource(
inputObject: any,
suffix: string
): object {
const newObject = JSON.parse(JSON.stringify(inputObject));
if (suffix === STABLE_SUFFIX) {
// adding stable suffix to service name
newObject.metadata.name = getBlueGreenResourceName(
inputObject.metadata.name, inputObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
) );
return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE) return getNewBlueGreenObject(newObject, NONE_LABEL_VALUE);
} else {
// green label will be added for these
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE);
}
} }
export function getGreenSMIServiceResource(inputObject: K8sObject): K8sObject { export async function routeBlueGreenSMI(
const newObject = JSON.parse(JSON.stringify(inputObject)) kubectl: Kubectl,
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE) nextLabel: string,
serviceEntityList: any[]
) {
for (const serviceObject of serviceEntityList) {
// route trafficsplit to given label
await createTrafficSplitObject(
kubectl,
serviceObject.metadata.name,
nextLabel
);
}
} }
export async function validateTrafficSplitsState( export async function validateTrafficSplitsState(
kubectl: Kubectl, kubectl: Kubectl,
serviceEntityList: any[] serviceEntityList: any[]
): Promise<boolean> { ): Promise<boolean> {
let trafficSplitsInRightState: boolean = true let trafficSplitsInRightState: boolean = true;
for (const serviceObject of serviceEntityList) { for (const serviceObject of serviceEntityList) {
const name = serviceObject.metadata.name const name = serviceObject.metadata.name;
let trafficSplitObject = await fetchResource( let trafficSplitObject = await fetchResource(
kubectl, kubectl,
TRAFFIC_SPLIT_OBJECT, TRAFFIC_SPLIT_OBJECT,
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX) getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
) );
core.debug(
`ts object extracted was ${JSON.stringify(trafficSplitObject)}` if (!trafficSplitObject) {
) // no traffic split exits
if (!trafficSplitObject) { trafficSplitsInRightState = false;
core.debug(`no traffic split exits for ${name}`) }
trafficSplitsInRightState = false
continue trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
trafficSplitObject.spec.backends.forEach((element) => {
// checking if trafficsplit in right state to deploy
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
} }
trafficSplitObject.spec.backends.forEach((element) => { if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) {
// checking if trafficsplit in right state to deploy if (element.weight != MIN_VAL) trafficSplitsInRightState = false;
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) { }
trafficSplitsInRightState = });
trafficSplitsInRightState && element.weight == MAX_VAL }
}
if ( return trafficSplitsInRightState;
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
) {
trafficSplitsInRightState =
trafficSplitsInRightState && element.weight == MIN_VAL
}
})
}
return trafficSplitsInRightState
} }
export async function cleanupSMI( export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
kubectl: Kubectl, const deleteList = [];
serviceEntityList: any[]
): Promise<K8sDeleteObject[]> {
const deleteList: K8sDeleteObject[] = []
serviceEntityList.forEach((serviceObject) => { serviceEntityList.forEach((serviceObject) => {
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
), ),
kind: TRAFFIC_SPLIT_OBJECT kind: TRAFFIC_SPLIT_OBJECT,
}) });
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX),
serviceObject.metadata.name, kind: serviceObject.kind,
GREEN_SUFFIX });
),
kind: serviceObject.kind
})
deleteList.push({ deleteList.push({
name: getBlueGreenResourceName( name: getBlueGreenResourceName(
serviceObject.metadata.name, serviceObject.metadata.name,
STABLE_SUFFIX STABLE_SUFFIX
), ),
kind: serviceObject.kind kind: serviceObject.kind,
}) });
}) });
// delete all objects // delete all objects
await deleteObjects(kubectl, deleteList) await deleteObjects(kubectl, deleteList);
return deleteList
} }
+196 -222
View File
@@ -1,222 +1,196 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import {
import { isDeploymentEntity,
isDeploymentEntity, isServiceEntity,
isServiceEntity, KubernetesWorkload,
KubernetesWorkload } from "../../types/kubernetesTypes";
} from '../../types/kubernetesTypes' import * as utils from "../../utilities/manifestUpdateUtils";
import * as utils from '../../utilities/manifestUpdateUtils' import {
import { updateObjectAnnotations,
updateObjectAnnotations, updateObjectLabels,
updateObjectLabels, updateSelectorLabels,
updateSelectorLabels } from "../../utilities/manifestUpdateUtils";
} from '../../utilities/manifestUpdateUtils' import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils' import { checkForErrors } from "../../utilities/kubectlUtils";
import {checkForErrors} from '../../utilities/kubectlUtils'
export const CANARY_VERSION_LABEL = "workflow/version";
export const CANARY_VERSION_LABEL = 'workflow/version' const BASELINE_SUFFIX = "-baseline";
const BASELINE_SUFFIX = '-baseline' export const BASELINE_LABEL_VALUE = "baseline";
export const BASELINE_LABEL_VALUE = 'baseline' const CANARY_SUFFIX = "-canary";
const CANARY_SUFFIX = '-canary' export const CANARY_LABEL_VALUE = "canary";
export const CANARY_LABEL_VALUE = 'canary' export const STABLE_SUFFIX = "-stable";
export const STABLE_SUFFIX = '-stable' export const STABLE_LABEL_VALUE = "stable";
export const STABLE_LABEL_VALUE = 'stable'
export async function deleteCanaryDeployment(
export async function deleteCanaryDeployment( kubectl: Kubectl,
kubectl: Kubectl, manifestFilePaths: string[],
manifestFilePaths: string[], includeServices: boolean
includeServices: boolean ) {
) { if (manifestFilePaths == null || manifestFilePaths.length == 0) {
if (manifestFilePaths == null || manifestFilePaths.length == 0) { throw new Error("Manifest file not found");
throw new Error('Manifest files for deleting canary deployment not found') }
}
await cleanUpCanary(kubectl, manifestFilePaths, includeServices);
await cleanUpCanary(kubectl, manifestFilePaths, includeServices) }
}
export function markResourceAsStable(inputObject: any): object {
export function markResourceAsStable(inputObject: any): object { if (isResourceMarkedAsStable(inputObject)) {
if (isResourceMarkedAsStable(inputObject)) { return inputObject;
return inputObject }
}
const newObject = JSON.parse(JSON.stringify(inputObject));
const newObject = JSON.parse(JSON.stringify(inputObject)) addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE);
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE) return newObject;
return newObject }
}
export function isResourceMarkedAsStable(inputObject: any): boolean {
export function isResourceMarkedAsStable(inputObject: any): boolean { return (
return ( inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE );
) }
}
export function getStableResource(inputObject: any): object {
export function getStableResource(inputObject: any): object { const replicaCount = specContainsReplicas(inputObject.kind)
const replicaCount = specContainsReplicas(inputObject.kind) ? inputObject.metadata.replicas
? inputObject.spec.replicas : 0;
: 0
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE) }
}
export function getNewBaselineResource(
export function getNewBaselineResource( stableObject: any,
stableObject: any, replicas?: number
replicas?: number ): object {
): object { return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE);
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE) }
}
export function getNewCanaryResource(
export function getNewCanaryResource( inputObject: any,
inputObject: any, replicas?: number
replicas?: number ): object {
): object { return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE);
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE) }
}
export async function fetchResource(
export async function fetchResource( kubectl: Kubectl,
kubectl: Kubectl, kind: string,
kind: string, name: string
name: string ) {
) { const result = await kubectl.getResource(kind, name);
let result: ExecOutput
try { if (!result || result?.stderr) {
result = await kubectl.getResource(kind, name) return null;
} catch (e) { }
core.debug(`detected error while fetching resources: ${e}`)
} if (result.stdout) {
const resource = JSON.parse(result.stdout);
if (!result || result?.stderr) {
return null try {
} utils.UnsetClusterSpecificDetails(resource);
return resource;
if (result.stdout) { } catch (ex) {
const resource = JSON.parse(result.stdout) core.debug(
`Exception occurred while Parsing ${resource} in JSON object: ${ex}`
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 getCanaryResourceName(name: string) { }
return name + CANARY_SUFFIX
} export function getStableResourceName(name: string) {
return name + STABLE_SUFFIX;
export function getBaselineResourceName(name: string) { }
return name + BASELINE_SUFFIX
} function getNewCanaryObject(
inputObject: any,
export function getStableResourceName(name: string) { replicas: number,
return name + STABLE_SUFFIX type: string
} ): object {
const newObject = JSON.parse(JSON.stringify(inputObject));
export function getBaselineDeploymentFromStableDeployment(
inputObject: any, // Updating name
replicaCount: number if (type === CANARY_LABEL_VALUE) {
): object { newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name);
// TODO: REFACTOR TO MAKE EVERYTHING TYPE SAFE } else if (type === STABLE_LABEL_VALUE) {
const oldName = inputObject.metadata.name newObject.metadata.name = getStableResourceName(inputObject.metadata.name);
const newName = } else {
oldName.substring(0, oldName.length - STABLE_SUFFIX.length) + newObject.metadata.name = getBaselineResourceName(
BASELINE_SUFFIX inputObject.metadata.name
);
const newObject = getNewCanaryObject( }
inputObject,
replicaCount, addCanaryLabelsAndAnnotations(newObject, type);
BASELINE_LABEL_VALUE
) as any if (specContainsReplicas(newObject.kind)) {
newObject.metadata.name = newName newObject.spec.replicas = replicas;
}
return newObject
} return newObject;
}
function getNewCanaryObject(
inputObject: any, function specContainsReplicas(kind: string) {
replicas: number, return (
type: string kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
): object { kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
const newObject = JSON.parse(JSON.stringify(inputObject)) !isServiceEntity(kind)
);
// Updating name }
if (type === CANARY_LABEL_VALUE) {
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name) function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
} else if (type === STABLE_LABEL_VALUE) { const newLabels = new Map<string, string>();
newObject.metadata.name = getStableResourceName(inputObject.metadata.name) newLabels[CANARY_VERSION_LABEL] = type;
} else {
newObject.metadata.name = getBaselineResourceName( updateObjectLabels(inputObject, newLabels, false);
inputObject.metadata.name updateObjectAnnotations(inputObject, newLabels, false);
) updateSelectorLabels(inputObject, newLabels, false);
}
if (!isServiceEntity(inputObject.kind)) {
addCanaryLabelsAndAnnotations(newObject, type) updateSpecLabels(inputObject, newLabels, false);
}
if (specContainsReplicas(newObject.kind)) { }
newObject.spec.replicas = replicas
} async function cleanUpCanary(
kubectl: Kubectl,
return newObject files: string[],
} includeServices: boolean
) {
function specContainsReplicas(kind: string) { const deleteObject = async function (kind, name) {
return ( try {
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && const result = await kubectl.delete([kind, name]);
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() && checkForErrors([result]);
!isServiceEntity(kind) } catch (ex) {
) // Ignore failures of delete if it doesn't exist
} }
};
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
const newLabels = new Map<string, string>() for (const filePath of files) {
newLabels[CANARY_VERSION_LABEL] = type const fileContents = fs.readFileSync(filePath).toString();
updateObjectLabels(inputObject, newLabels, false) const parsedYaml = yaml.safeLoadAll(fileContents);
updateObjectAnnotations(inputObject, newLabels, false) for (const inputObject of parsedYaml) {
updateSelectorLabels(inputObject, newLabels, false) const name = inputObject.metadata.name;
const kind = inputObject.kind;
if (!isServiceEntity(inputObject.kind)) {
updateSpecLabels(inputObject, newLabels, false) if (
} isDeploymentEntity(kind) ||
} (includeServices && isServiceEntity(kind))
) {
async function cleanUpCanary( const canaryObjectName = getCanaryResourceName(name);
kubectl: Kubectl, const baselineObjectName = getBaselineResourceName(name);
files: string[],
includeServices: boolean await deleteObject(kind, canaryObjectName);
) { await deleteObject(kind, baselineObjectName);
const deleteObject = async function (kind, name) { }
try { }
const result = await kubectl.delete([kind, name]) }
checkForErrors([result]) }
} catch (ex) {
// Ignore failures of delete if it doesn't exist
}
}
for (const filePath of files) {
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) {
const name = inputObject.metadata.name
const kind = inputObject.kind
if (
isDeploymentEntity(kind) ||
(includeServices && isServiceEntity(kind))
) {
const canaryObjectName = getCanaryResourceName(name)
const baselineObjectName = getBaselineResourceName(name)
await deleteObject(kind, canaryObjectName)
await deleteObject(kind, baselineObjectName)
}
}
}
}
+90 -84
View File
@@ -1,84 +1,90 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import {isDeploymentEntity} from '../../types/kubernetesTypes' import { isDeploymentEntity } from "../../types/kubernetesTypes";
import {getReplicaCount} from '../../utilities/manifestUpdateUtils' import { getReplicaCount } from "../../utilities/manifestUpdateUtils";
export async function deployPodCanary( export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
filePaths: string[], const newObjectsList = [];
kubectl: Kubectl, const percentage = parseInt(core.getInput("percentage"));
onlyDeployStable: boolean = false
) { if (percentage < 0 || percentage > 100)
const newObjectsList = [] throw Error("Percentage must be between 0 and 100");
const percentage = parseInt(core.getInput('percentage', {required: true}))
for (const filePath of filePaths) {
if (percentage < 0 || percentage > 100) const fileContents = fs.readFileSync(filePath).toString();
throw Error('Percentage must be between 0 and 100') const parsedYaml = yaml.safeLoadAll(fileContents);
for (const inputObject of parsedYaml) {
for (const filePath of filePaths) { const name = inputObject.metadata.name;
const fileContents = fs.readFileSync(filePath).toString() const kind = inputObject.kind;
const parsedYaml = yaml.safeLoadAll(fileContents)
for (const inputObject of parsedYaml) { if (isDeploymentEntity(kind)) {
const name = inputObject.metadata.name core.debug("Calculating replica count for canary");
const kind = inputObject.kind const canaryReplicaCount = calculateReplicaCountForCanary(
inputObject,
if (!onlyDeployStable && isDeploymentEntity(kind)) { percentage
core.debug('Calculating replica count for canary') );
const canaryReplicaCount = calculateReplicaCountForCanary( core.debug("Replica count is " + canaryReplicaCount);
inputObject,
percentage // Get stable object
) core.debug("Querying stable object");
core.debug('Replica count is ' + canaryReplicaCount) const stableObject = await canaryDeploymentHelper.fetchResource(
kubectl,
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( kind,
inputObject, name
canaryReplicaCount );
)
newObjectsList.push(newCanaryObject) if (!stableObject) {
core.debug("Stable object not found. Creating canary object");
// if there's already a stable object, deploy baseline as well const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
const stableObject = await canaryDeploymentHelper.fetchResource( inputObject,
kubectl, canaryReplicaCount
kind, );
name newObjectsList.push(newCanaryObject);
) } else {
if (stableObject) { core.debug(
core.debug( "Creating canary and baseline objects. Stable object found: " +
`Stable object found for ${kind} ${name}. Creating baseline objects` JSON.stringify(stableObject)
) );
const newBaselineObject =
canaryDeploymentHelper.getNewBaselineResource( const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
stableObject, inputObject,
canaryReplicaCount canaryReplicaCount
) );
core.debug( core.debug("New canary object: " + JSON.stringify(newCanaryObject));
'New baseline object: ' + JSON.stringify(newBaselineObject)
) const newBaselineObject =
newObjectsList.push(newBaselineObject) canaryDeploymentHelper.getNewBaselineResource(
} stableObject,
} else { canaryReplicaCount
// deploy non deployment entity or regular deployments for promote as they are );
newObjectsList.push(inputObject) core.debug(
} "New baseline object: " + JSON.stringify(newBaselineObject)
} );
}
newObjectsList.push(newCanaryObject);
core.debug('New objects list: ' + JSON.stringify(newObjectsList)) newObjectsList.push(newBaselineObject);
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList) }
const forceDeployment = core.getInput('force').toLowerCase() === 'true' } else {
// update non deployment entity as it is
const result = await kubectl.apply(manifestFiles, forceDeployment) newObjectsList.push(inputObject);
return {result, newFilePaths: manifestFiles} }
} }
}
export function calculateReplicaCountForCanary(
inputObject: any, core.debug("New objects list: " + JSON.stringify(newObjectsList));
percentage: number const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
) { const forceDeployment = core.getInput("force").toLowerCase() === "true";
const inputReplicaCount = getReplicaCount(inputObject)
return Math.max(1, Math.round((inputReplicaCount * percentage) / 100)) 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);
}
+319 -351
View File
@@ -1,351 +1,319 @@
import {Kubectl} from '../../types/kubectl' import { Kubectl } from "../../types/kubectl";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as fileHelper from '../../utilities/fileUtils' import * as fileHelper from "../../utilities/fileUtils";
import * as kubectlUtils from '../../utilities/trafficSplitUtils' import * as kubectlUtils from "../../utilities/trafficSplitUtils";
import * as canaryDeploymentHelper from './canaryHelper' import * as canaryDeploymentHelper from "./canaryHelper";
import * as podCanaryHelper from './podCanaryHelper' import {
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes' isDeploymentEntity,
import {checkForErrors} from '../../utilities/kubectlUtils' isServiceEntity,
import {inputAnnotations} from '../../inputUtils' } from "../../types/kubernetesTypes";
import { checkForErrors } from "../../utilities/kubectlUtils";
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit' const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout";
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
export async function deploySMICanary(
filePaths: string[], export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
kubectl: Kubectl, const canaryReplicaCount = parseInt(
onlyDeployStable: boolean = false core.getInput("baseline-and-canary-replicas")
) { );
const canaryReplicasInput = core.getInput('baseline-and-canary-replicas') if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
let canaryReplicaCount throw Error("Baseline-and-canary-replicas must be between 0 and 100");
let calculateReplicas = true
if (canaryReplicasInput !== '') { const newObjectsList = [];
canaryReplicaCount = parseInt(canaryReplicasInput) filePaths.forEach((filePath: string) => {
calculateReplicas = false const fileContents = fs.readFileSync(filePath).toString();
core.debug( yaml.safeLoadAll(fileContents, (inputObject) => {
`read replica count ${canaryReplicaCount} from input: ${canaryReplicasInput}` const name = inputObject.metadata.name;
) const kind = inputObject.kind;
}
if (isDeploymentEntity(kind)) {
if (canaryReplicaCount < 0 && canaryReplicaCount > 100) const stableObject = canaryDeploymentHelper.fetchResource(
throw Error('Baseline-and-canary-replicas must be between 0 and 100') kubectl,
kind,
const newObjectsList = [] name
for await (const filePath of filePaths) { );
const fileContents = fs.readFileSync(filePath).toString()
const inputObjects = yaml.safeLoadAll(fileContents) if (!stableObject) {
for (const inputObject of inputObjects) { core.debug("Stable object not found. Creating only canary object");
const name = inputObject.metadata.name const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
const kind = inputObject.kind inputObject,
canaryReplicaCount
if (!onlyDeployStable && isDeploymentEntity(kind)) { );
if (calculateReplicas) { newObjectsList.push(newCanaryObject);
// calculate for each object } else {
const percentage = parseInt( if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) {
core.getInput('percentage', {required: true}) throw Error(`StableSpecSelectorNotExist : ${name}`);
) }
canaryReplicaCount =
podCanaryHelper.calculateReplicaCountForCanary( core.debug(
inputObject, "Stable object found. Creating canary and baseline objects"
percentage );
) const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
core.debug(`calculated replica count ${canaryReplicaCount}`) inputObject,
} canaryReplicaCount
);
core.debug('Creating canary object') const newBaselineObject =
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource( canaryDeploymentHelper.getNewBaselineResource(
inputObject, stableObject,
canaryReplicaCount canaryReplicaCount
) );
newObjectsList.push(newCanaryObject) newObjectsList.push(newCanaryObject);
newObjectsList.push(newBaselineObject);
const stableObject = await canaryDeploymentHelper.fetchResource( }
kubectl, } else {
kind, // Update non deployment entity as it is
canaryDeploymentHelper.getStableResourceName(name) newObjectsList.push(inputObject);
) }
if (stableObject) { });
core.debug( });
`Stable object found for ${kind} ${name}. Creating baseline objects`
) const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList);
const newBaselineObject = const forceDeployment = core.getInput("force").toLowerCase() === "true";
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment( const result = await kubectl.apply(newFilePaths, forceDeployment);
stableObject, await createCanaryService(kubectl, filePaths);
canaryReplicaCount return { result, newFilePaths };
) }
newObjectsList.push(newBaselineObject)
} async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
} else if (isDeploymentEntity(kind)) { const newObjectsList = [];
core.debug( const trafficObjectsList = [];
`creating stable deployment with ${inputObject.spec.replicas} replicas`
) for (const filePath of filePaths) {
const stableDeployment = const fileContents = fs.readFileSync(filePath).toString();
canaryDeploymentHelper.getStableResource(inputObject) const parsedYaml = yaml.safeLoadAll(fileContents);
newObjectsList.push(stableDeployment) for (const inputObject of parsedYaml) {
} else { const name = inputObject.metadata.name;
// Update non deployment entity or stable deployment as it is const kind = inputObject.kind;
newObjectsList.push(inputObject)
} if (isServiceEntity(kind)) {
} const newCanaryServiceObject =
} canaryDeploymentHelper.getNewCanaryResource(inputObject);
core.debug( newObjectsList.push(newCanaryServiceObject);
`deploying canary objects with SMI: \n ${JSON.stringify(newObjectsList)}`
) const newBaselineServiceObject =
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList) canaryDeploymentHelper.getNewBaselineResource(inputObject);
const forceDeployment = core.getInput('force').toLowerCase() === 'true' newObjectsList.push(newBaselineServiceObject);
const result = await kubectl.apply(newFilePaths, forceDeployment)
await createCanaryService(kubectl, filePaths) const stableObject = await canaryDeploymentHelper.fetchResource(
return {result, newFilePaths} kubectl,
} kind,
canaryDeploymentHelper.getStableResourceName(name)
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) { );
const newObjectsList = [] if (!stableObject) {
const trafficObjectsList: string[] = [] const newStableServiceObject =
canaryDeploymentHelper.getStableResource(inputObject);
for (const filePath of filePaths) { newObjectsList.push(newStableServiceObject);
const fileContents = fs.readFileSync(filePath).toString()
const parsedYaml = yaml.safeLoadAll(fileContents) core.debug("Creating the traffic object for service: " + name);
for (const inputObject of parsedYaml) { const trafficObject = await createTrafficSplitManifestFile(
const name = inputObject.metadata.name kubectl,
const kind = inputObject.kind name,
0,
if (isServiceEntity(kind)) { 0,
core.debug(`Creating services for ${kind} ${name}`) 1000
const newCanaryServiceObject = );
canaryDeploymentHelper.getNewCanaryResource(inputObject)
newObjectsList.push(newCanaryServiceObject) trafficObjectsList.push(trafficObject);
} else {
const newBaselineServiceObject = let updateTrafficObject = true;
canaryDeploymentHelper.getNewBaselineResource(inputObject) const trafficObject = await canaryDeploymentHelper.fetchResource(
newObjectsList.push(newBaselineServiceObject) kubectl,
TRAFFIC_SPLIT_OBJECT,
const stableObject = await canaryDeploymentHelper.fetchResource( getTrafficSplitResourceName(name)
kubectl, );
kind,
canaryDeploymentHelper.getStableResourceName(name) if (trafficObject) {
) const trafficJObject = JSON.parse(JSON.stringify(trafficObject));
if (!stableObject) { if (trafficJObject?.spec?.backends) {
const newStableServiceObject = trafficJObject.spec.backends.forEach((s) => {
canaryDeploymentHelper.getStableResource(inputObject) if (
newObjectsList.push(newStableServiceObject) s.service ===
canaryDeploymentHelper.getCanaryResourceName(name) &&
core.debug('Creating the traffic object for service: ' + name) s.weight === "1000m"
const trafficObject = await createTrafficSplitManifestFile( ) {
kubectl, core.debug("Update traffic objcet not required");
name, updateTrafficObject = false;
0, }
0, });
1000 }
) }
trafficObjectsList.push(trafficObject) if (updateTrafficObject) {
} else { core.debug(
let updateTrafficObject = true "Stable service object present so updating the traffic object for service: " +
const trafficObject = await canaryDeploymentHelper.fetchResource( name
kubectl, );
TRAFFIC_SPLIT_OBJECT, trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
getTrafficSplitResourceName(name) }
) }
}
if (trafficObject) { }
const trafficJObject = JSON.parse( }
JSON.stringify(trafficObject)
) const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
if (trafficJObject?.spec?.backends) { manifestFiles.push(...trafficObjectsList);
trafficJObject.spec.backends.forEach((s) => { const forceDeployment = core.getInput("force").toLowerCase() === "true";
if (
s.service === const result = await kubectl.apply(manifestFiles, forceDeployment);
canaryDeploymentHelper.getCanaryResourceName( checkForErrors([result]);
name }
) &&
s.weight === '1000m' export async function redirectTrafficToCanaryDeployment(
) { kubectl: Kubectl,
core.debug('Update traffic objcet not required') manifestFilePaths: string[]
updateTrafficObject = false ) {
} await adjustTraffic(kubectl, manifestFilePaths, 0, 1000);
}) }
}
} export async function redirectTrafficToStableDeployment(
kubectl: Kubectl,
if (updateTrafficObject) { manifestFilePaths: string[]
core.debug( ) {
'Stable service object present so updating the traffic object for service: ' + await adjustTraffic(kubectl, manifestFilePaths, 1000, 0);
name }
)
trafficObjectsList.push( async function adjustTraffic(
await updateTrafficSplitObject(kubectl, name) kubectl: Kubectl,
) manifestFilePaths: string[],
} stableWeight: number,
} canaryWeight: number
} ) {
} if (!manifestFilePaths || manifestFilePaths?.length == 0) {
} return;
}
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
manifestFiles.push(...trafficObjectsList) const trafficSplitManifests = [];
const forceDeployment = core.getInput('force').toLowerCase() === 'true' for (const filePath of manifestFilePaths) {
const fileContents = fs.readFileSync(filePath).toString();
const result = await kubectl.apply(manifestFiles, forceDeployment) const parsedYaml = yaml.safeLoadAll(fileContents);
checkForErrors([result]) for (const inputObject of parsedYaml) {
} const name = inputObject.metadata.name;
const kind = inputObject.kind;
export async function redirectTrafficToCanaryDeployment(
kubectl: Kubectl, if (isServiceEntity(kind)) {
manifestFilePaths: string[] trafficSplitManifests.push(
) { await createTrafficSplitManifestFile(
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000) kubectl,
} name,
stableWeight,
export async function redirectTrafficToStableDeployment( 0,
kubectl: Kubectl, canaryWeight
manifestFilePaths: string[] )
) { );
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0) }
} }
}
async function adjustTraffic(
kubectl: Kubectl, if (trafficSplitManifests.length <= 0) {
manifestFilePaths: string[], return;
stableWeight: number, }
canaryWeight: number
) { const forceDeployment = core.getInput("force").toLowerCase() === "true";
if (!manifestFilePaths || manifestFilePaths?.length == 0) { const result = await kubectl.apply(trafficSplitManifests, forceDeployment);
return checkForErrors([result]);
} }
const trafficSplitManifests = [] async function updateTrafficSplitObject(
for (const filePath of manifestFilePaths) { kubectl: Kubectl,
const fileContents = fs.readFileSync(filePath).toString() serviceName: string
const parsedYaml = yaml.safeLoadAll(fileContents) ): Promise<string> {
for (const inputObject of parsedYaml) { const percentage = parseInt(core.getInput("percentage"));
const name = inputObject.metadata.name if (percentage < 0 || percentage > 100)
const kind = inputObject.kind throw Error("Percentage must be between 0 and 100");
if (isServiceEntity(kind)) { const percentageWithMuliplier = percentage * 10;
trafficSplitManifests.push( const baselineAndCanaryWeight = percentageWithMuliplier / 2;
await createTrafficSplitManifestFile( const stableDeploymentWeight = 1000 - percentageWithMuliplier;
kubectl,
name, core.debug(
stableWeight, "Creating the traffic object with canary weight: " +
0, baselineAndCanaryWeight +
canaryWeight ",baseling weight: " +
) baselineAndCanaryWeight +
) ",stable: " +
} stableDeploymentWeight
} );
} return await createTrafficSplitManifestFile(
kubectl,
if (trafficSplitManifests.length <= 0) { serviceName,
return stableDeploymentWeight,
} baselineAndCanaryWeight,
baselineAndCanaryWeight
const forceDeployment = core.getInput('force').toLowerCase() === 'true' );
const result = await kubectl.apply(trafficSplitManifests, forceDeployment) }
checkForErrors([result])
} async function createTrafficSplitManifestFile(
kubectl: Kubectl,
async function updateTrafficSplitObject( serviceName: string,
kubectl: Kubectl, stableWeight: number,
serviceName: string baselineWeight: number,
): Promise<string> { canaryWeight: number
const percentage = parseInt(core.getInput('percentage', {required: true})) ): Promise<string> {
if (percentage < 0 || percentage > 100) const smiObjectString = await getTrafficSplitObject(
throw Error('Percentage must be between 0 and 100') kubectl,
serviceName,
const percentageWithMuliplier = percentage * 10 stableWeight,
const baselineAndCanaryWeight = percentageWithMuliplier / 2 baselineWeight,
const stableDeploymentWeight = 1000 - percentageWithMuliplier canaryWeight
);
core.debug( const manifestFile = fileHelper.writeManifestToFile(
'Creating the traffic object with canary weight: ' + smiObjectString,
baselineAndCanaryWeight + TRAFFIC_SPLIT_OBJECT,
', baseline weight: ' + serviceName
baselineAndCanaryWeight + );
', stable weight: ' +
stableDeploymentWeight if (!manifestFile) {
) throw new Error("Unable to create traffic split manifest file");
return await createTrafficSplitManifestFile( }
kubectl,
serviceName, return manifestFile;
stableDeploymentWeight, }
baselineAndCanaryWeight,
baselineAndCanaryWeight let trafficSplitAPIVersion = "";
)
} async function getTrafficSplitObject(
kubectl: Kubectl,
async function createTrafficSplitManifestFile( name: string,
kubectl: Kubectl, stableWeight: number,
serviceName: string, baselineWeight: number,
stableWeight: number, canaryWeight: number
baselineWeight: number, ): Promise<string> {
canaryWeight: number // cached version
): Promise<string> { if (!trafficSplitAPIVersion) {
const smiObjectString = await getTrafficSplitObject( trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
kubectl, kubectl
serviceName, );
stableWeight, }
baselineWeight,
canaryWeight return JSON.stringify({
) apiVersion: trafficSplitAPIVersion,
const manifestFile = fileHelper.writeManifestToFile( kind: "TrafficSplit",
smiObjectString, metadata: {
TRAFFIC_SPLIT_OBJECT, name: getTrafficSplitResourceName(name),
serviceName },
) spec: {
backends: [
if (!manifestFile) { {
throw new Error('Unable to create traffic split manifest file') service: canaryDeploymentHelper.getStableResourceName(name),
} weight: stableWeight,
},
return manifestFile {
} service: canaryDeploymentHelper.getBaselineResourceName(name),
weight: baselineWeight,
let trafficSplitAPIVersion = '' },
{
async function getTrafficSplitObject( service: canaryDeploymentHelper.getCanaryResourceName(name),
kubectl: Kubectl, weight: canaryWeight,
name: string, },
stableWeight: number, ],
baselineWeight: number, service: name,
canaryWeight: number },
): Promise<string> { });
// cached version }
if (!trafficSplitAPIVersion) {
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion( function getTrafficSplitResourceName(name: string) {
kubectl return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX;
) }
}
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
}
+218 -230
View File
@@ -1,230 +1,218 @@
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as canaryDeploymentHelper from './canary/canaryHelper' import * as canaryDeploymentHelper from "./canary/canaryHelper";
import * as models from '../types/kubernetesTypes' import * as models from "../types/kubernetesTypes";
import {isDeploymentEntity} from '../types/kubernetesTypes' import { isDeploymentEntity } from "../types/kubernetesTypes";
import * as fileHelper from '../utilities/fileUtils' import * as fileHelper from "../utilities/fileUtils";
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils' import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {deployPodCanary} from './canary/podCanaryHelper' import { deployPodCanary } from "./canary/podCanaryHelper";
import {deploySMICanary} from './canary/smiCanaryHelper' import { deploySMICanary } from "./canary/smiCanaryHelper";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import { import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper";
deployBlueGreen, import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper";
deployBlueGreenIngress, import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper";
deployBlueGreenService import { DeploymentStrategy } from "../types/deploymentStrategy";
} from './blueGreen/deploy' import * as core from "@actions/core";
import {deployBlueGreenSMI} from './blueGreen/deploy' import {
import {DeploymentStrategy} from '../types/deploymentStrategy' parseTrafficSplitMethod,
import * as core from '@actions/core' TrafficSplitMethod,
import { } from "../types/trafficSplitMethod";
parseTrafficSplitMethod, import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
TrafficSplitMethod import { ExecOutput } from "@actions/exec";
} from '../types/trafficSplitMethod' import {
import {parseRouteStrategy} from '../types/routeStrategy' getWorkflowAnnotationKeyLabel,
import {ExecOutput} from '@actions/exec' getWorkflowAnnotations,
import { } from "../utilities/workflowAnnotationUtils";
getWorkflowAnnotationKeyLabel, import {
getWorkflowAnnotations, annotateChildPods,
cleanLabel checkForErrors,
} from '../utilities/workflowAnnotationUtils' getLastSuccessfulRunSha,
import { } from "../utilities/kubectlUtils";
annotateChildPods, import {
checkForErrors, getWorkflowFilePath,
getLastSuccessfulRunSha normalizeWorkflowStrLabel,
} from '../utilities/kubectlUtils' } from "../utilities/githubUtils";
import { import { getDeploymentConfig } from "../utilities/dockerUtils";
getWorkflowFilePath,
normalizeWorkflowStrLabel export async function deployManifests(
} from '../utilities/githubUtils' files: string[],
import {getDeploymentConfig} from '../utilities/dockerUtils' deploymentStrategy: DeploymentStrategy,
kubectl: Kubectl,
export async function deployManifests( trafficSplitMethod: TrafficSplitMethod
files: string[], ): Promise<string[]> {
deploymentStrategy: DeploymentStrategy, switch (deploymentStrategy) {
kubectl: Kubectl, case DeploymentStrategy.CANARY: {
trafficSplitMethod: TrafficSplitMethod const { result, newFilePaths } =
): Promise<string[]> { trafficSplitMethod == TrafficSplitMethod.SMI
switch (deploymentStrategy) { ? await deploySMICanary(files, kubectl)
case DeploymentStrategy.CANARY: { : await deployPodCanary(files, kubectl);
const {result, newFilePaths} =
trafficSplitMethod == TrafficSplitMethod.SMI checkForErrors([result]);
? await deploySMICanary(files, kubectl) return newFilePaths;
: await deployPodCanary(files, kubectl) }
checkForErrors([result]) case DeploymentStrategy.BLUE_GREEN: {
return newFilePaths const routeStrategy = parseRouteStrategy(
} core.getInput("route-method", { required: true })
);
case DeploymentStrategy.BLUE_GREEN: {
const routeStrategy = parseRouteStrategy( const { result, newFilePaths } = await Promise.resolve(
core.getInput('route-method', {required: true}) (routeStrategy == RouteStrategy.INGRESS &&
) deployBlueGreenIngress(kubectl, files)) ||
const blueGreenDeployment = await deployBlueGreen( (routeStrategy == RouteStrategy.SMI &&
kubectl, deployBlueGreenSMI(kubectl, files)) ||
files, deployBlueGreenService(kubectl, files)
routeStrategy );
)
core.debug( checkForErrors([result]);
`objects deployed for ${routeStrategy}: ${JSON.stringify( return newFilePaths;
blueGreenDeployment.objects }
)} `
) case undefined: {
core.warning("Deployment strategy is not recognized.");
checkForErrors([blueGreenDeployment.deployResult.execResult]) }
return blueGreenDeployment.deployResult.manifestFiles default: {
} const trafficSplitMethod = parseTrafficSplitMethod(
core.getInput("traffic-split-method", { required: true })
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 forceDeployment = core.getInput('force').toLowerCase() === 'true'
if (trafficSplitMethod === TrafficSplitMethod.SMI) { const result = await kubectl.apply(updatedManifests, forceDeployment);
const updatedManifests = appendStableVersionLabelToResource(files) checkForErrors([result]);
} else {
const result = await kubectl.apply( const result = await kubectl.apply(files, forceDeployment);
updatedManifests, checkForErrors([result]);
forceDeployment }
)
checkForErrors([result]) return files;
} else { }
const result = await kubectl.apply(files, forceDeployment) }
checkForErrors([result]) }
}
function appendStableVersionLabelToResource(files: string[]): string[] {
return files const manifestFiles = [];
} const newObjectsList = [];
default: { files.forEach((filePath: string) => {
throw new Error('Deployment strategy is not recognized.') const fileContents = fs.readFileSync(filePath).toString();
}
} yaml.safeLoadAll(fileContents, function (inputObject) {
} const { kind } = inputObject;
function appendStableVersionLabelToResource(files: string[]): string[] { if (isDeploymentEntity(kind)) {
const manifestFiles = [] const updatedObject =
const newObjectsList = [] canaryDeploymentHelper.markResourceAsStable(inputObject);
newObjectsList.push(updatedObject);
files.forEach((filePath: string) => { } else {
const fileContents = fs.readFileSync(filePath).toString() manifestFiles.push(filePath);
}
yaml.safeLoadAll(fileContents, function (inputObject) { });
const {kind} = inputObject });
if (isDeploymentEntity(kind)) { const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
const updatedObject = manifestFiles.push(...updatedManifestFiles);
canaryDeploymentHelper.markResourceAsStable(inputObject)
newObjectsList.push(updatedObject) return manifestFiles;
} else { }
manifestFiles.push(filePath)
} export async function checkManifestStability(
}) kubectl: Kubectl,
}) resources: Resource[]
): Promise<void> {
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList) await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
manifestFiles.push(...updatedManifestFiles) }
return manifestFiles export async function annotateAndLabelResources(
} files: string[],
kubectl: Kubectl,
export async function checkManifestStability( resourceTypes: Resource[],
kubectl: Kubectl, allPods: any
resources: Resource[] ) {
): Promise<void> { const githubToken = core.getInput("token");
await KubernetesManifestUtility.checkManifestStability(kubectl, resources) const workflowFilePath = await getWorkflowFilePath(githubToken);
}
const deploymentConfig = await getDeploymentConfig();
export async function annotateAndLabelResources( const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath);
files: string[],
kubectl: Kubectl, await annotateResources(
resourceTypes: Resource[], files,
allPods: any kubectl,
) { resourceTypes,
const githubToken = core.getInput('token') allPods,
const workflowFilePath = await getWorkflowFilePath(githubToken) annotationKeyLabel,
workflowFilePath,
const deploymentConfig = await getDeploymentConfig() deploymentConfig
const annotationKeyLabel = getWorkflowAnnotationKeyLabel() );
await labelResources(files, kubectl, annotationKeyLabel);
await annotateResources( }
files,
kubectl, async function annotateResources(
resourceTypes, files: string[],
allPods, kubectl: Kubectl,
annotationKeyLabel, resourceTypes: Resource[],
workflowFilePath, allPods: any,
deploymentConfig annotationKey: string,
) workflowFilePath: string,
await labelResources(files, kubectl, annotationKeyLabel) deploymentConfig: DeploymentConfig
} ) {
const annotateResults: ExecOutput[] = [];
async function annotateResources( const namespace = core.getInput("namespace") || "default";
files: string[], const lastSuccessSha = await getLastSuccessfulRunSha(
kubectl: Kubectl, kubectl,
resourceTypes: Resource[], namespace,
allPods: any, annotationKey
annotationKey: string, );
workflowFilePath: string,
deploymentConfig: DeploymentConfig const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
) { lastSuccessSha,
const annotateResults: ExecOutput[] = [] workflowFilePath,
const namespace = core.getInput('namespace') || 'default' deploymentConfig
const lastSuccessSha = await getLastSuccessfulRunSha( )}`;
kubectl,
namespace, const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false");
annotationKey if (annotateNamespace) {
) annotateResults.push(
await kubectl.annotate("namespace", namespace, annotationKeyValStr)
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations( );
lastSuccessSha, }
workflowFilePath, annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr));
deploymentConfig
)}` for (const resource of resourceTypes) {
if (
const annotateNamespace = !( resource.type.toLowerCase() !==
core.getInput('annotate-namespace').toLowerCase() === 'false' models.KubernetesWorkload.POD.toLowerCase()
) ) {
if (annotateNamespace) { (
annotateResults.push( await annotateChildPods(
await kubectl.annotate('namespace', namespace, annotationKeyValStr) kubectl,
) resource.type,
} resource.name,
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr)) annotationKeyValStr,
allPods
for (const resource of resourceTypes) { )
if ( ).forEach((execResult) => annotateResults.push(execResult));
resource.type.toLowerCase() !== }
models.KubernetesWorkload.POD.toLowerCase() }
) {
;( checkForErrors(annotateResults, true);
await annotateChildPods( }
kubectl,
resource.type, async function labelResources(
resource.name, files: string[],
annotationKeyValStr, kubectl: Kubectl,
allPods label: string
) ) {
).forEach((execResult) => annotateResults.push(execResult)) const labels = [
} `workflowFriendlyName=${normalizeWorkflowStrLabel(
} process.env.GITHUB_WORKFLOW
)}`,
checkForErrors(annotateResults, true) `workflow=${label}`,
} ];
async function labelResources( checkForErrors([await kubectl.labelFiles(files, labels)], true);
files: string[], }
kubectl: Kubectl,
label: string
) {
const labels = [
`workflowFriendlyName=${cleanLabel(
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
)}`,
`workflow=${cleanLabel(label)}`
]
checkForErrors([await kubectl.labelFiles(files, labels)], true)
}
+19 -19
View File
@@ -1,22 +1,22 @@
import {Action, parseAction} from './action' import { Action, parseAction } from "./action";
describe('Action type', () => { describe("Action type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(Action) const vals = <any>Object.values(Action);
expect(vals.includes('deploy')).toBe(true) expect(vals.includes("deploy")).toBe(true);
expect(vals.includes('promote')).toBe(true) expect(vals.includes("promote")).toBe(true);
expect(vals.includes('reject')).toBe(true) expect(vals.includes("reject")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseAction('deploy')).toBe(Action.DEPLOY) expect(parseAction("deploy")).toBe(Action.DEPLOY);
expect(parseAction('Deploy')).toBe(Action.DEPLOY) expect(parseAction("Deploy")).toBe(Action.DEPLOY);
expect(parseAction('DEPLOY')).toBe(Action.DEPLOY) expect(parseAction("DEPLOY")).toBe(Action.DEPLOY);
expect(parseAction('deploY')).toBe(Action.DEPLOY) expect(parseAction("deploY")).toBe(Action.DEPLOY);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseAction('invalid')).toBe(undefined) expect(parseAction("invalid")).toBe(undefined);
expect(parseAction('unsupportedType')).toBe(undefined) expect(parseAction("unsupportedType")).toBe(undefined);
}) });
}) });
+8 -8
View File
@@ -1,7 +1,7 @@
export enum Action { export enum Action {
DEPLOY = 'deploy', DEPLOY = "deploy",
PROMOTE = 'promote', PROMOTE = "promote",
REJECT = 'reject' REJECT = "reject",
} }
/** /**
@@ -10,8 +10,8 @@ export enum Action {
* @returns The Action enum or undefined if it can't be parsed * @returns The Action enum or undefined if it can't be parsed
*/ */
export const parseAction = (str: string): Action | undefined => export const parseAction = (str: string): Action | undefined =>
Action[ Action[
Object.keys(Action).filter( Object.keys(Action).filter(
(k) => Action[k].toString().toLowerCase() === str.toLowerCase() (k) => Action[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof Action )[0] as keyof typeof Action
] ];
-8
View File
@@ -1,8 +0,0 @@
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
@@ -1,21 +0,0 @@
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
@@ -1,6 +0,0 @@
import {ExecOutput} from '@actions/exec'
export interface DeployResult {
execResult: ExecOutput
manifestFiles: string[]
}
+3 -3
View File
@@ -1,5 +1,5 @@
export interface DeploymentConfig { export interface DeploymentConfig {
manifestFilePaths: string[] manifestFilePaths: string[];
helmChartFilePaths: string[] helmChartFilePaths: string[];
dockerfilePaths: any dockerfilePaths: any;
} }
+25 -23
View File
@@ -1,25 +1,27 @@
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy' import {
DeploymentStrategy,
parseDeploymentStrategy,
} from "./deploymentStrategy";
describe('Deployment strategy type', () => { describe("Deployment strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(DeploymentStrategy) const vals = <any>Object.values(DeploymentStrategy);
expect(vals.includes('canary')).toBe(true) expect(vals.includes("canary")).toBe(true);
expect(vals.includes('blue-green')).toBe(true) expect(vals.includes("blue-green")).toBe(true);
expect(vals.includes('basic')).toBe(true) });
})
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseDeploymentStrategy('blue-green')).toBe( expect(parseDeploymentStrategy("blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('Blue-green')).toBe( expect(parseDeploymentStrategy("Blue-green")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe( expect(parseDeploymentStrategy("BLUE-GREEN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
expect(parseDeploymentStrategy('blue-greeN')).toBe( expect(parseDeploymentStrategy("blue-greeN")).toBe(
DeploymentStrategy.BLUE_GREEN DeploymentStrategy.BLUE_GREEN
) );
}) });
}) });
+9 -10
View File
@@ -1,7 +1,6 @@
export enum DeploymentStrategy { export enum DeploymentStrategy {
BASIC = 'basic', CANARY = "canary",
CANARY = 'canary', BLUE_GREEN = "blue-green",
BLUE_GREEN = 'blue-green'
} }
/** /**
@@ -10,11 +9,11 @@ export enum DeploymentStrategy {
* @returns The DeploymentStrategy enum or undefined if it can't be parsed * @returns The DeploymentStrategy enum or undefined if it can't be parsed
*/ */
export const parseDeploymentStrategy = ( export const parseDeploymentStrategy = (
str: string str: string
): DeploymentStrategy | undefined => ): DeploymentStrategy | undefined =>
DeploymentStrategy[ DeploymentStrategy[
Object.keys(DeploymentStrategy).filter( Object.keys(DeploymentStrategy).filter(
(k) => (k) =>
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase() DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof DeploymentStrategy )[0] as keyof typeof DeploymentStrategy
] ];
+82 -82
View File
@@ -1,98 +1,98 @@
import {DockerExec} from './docker' import { DockerExec } from "./docker";
import * as actions from '@actions/exec' import * as actions from "@actions/exec";
const dockerPath = 'dockerPath' const dockerPath = "dockerPath";
const image = 'image' const image = "image";
const args = ['arg1', 'arg2', 'arg3'] const args = ["arg1", "arg2", "arg3"];
describe('Docker class', () => { describe("Docker class", () => {
const docker = new DockerExec(dockerPath) const docker = new DockerExec(dockerPath);
describe('with a success exec return', () => { describe("with a success exec return", () => {
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''} const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await docker.pull(image, args) await docker.pull(image, args);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{silent: false} { silent: false }
) );
}) });
test('pulls an image silently', async () => { test("pulls an image silently", async () => {
await docker.pull(image, args, true) await docker.pull(image, args, true);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['pull', image, ...args], ["pull", image, ...args],
{silent: true} { silent: true }
) );
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await docker.inspect(image, args) const result = await docker.inspect(image, args);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{silent: false} { silent: false }
) );
}) });
test('inspects a docker image silently', async () => { test("inspects a docker image silently", async () => {
const result = await docker.inspect(image, args, true) const result = await docker.inspect(image, args, true);
expect(result).toBe(execReturn.stdout) expect(result).toBe(execReturn.stdout);
expect(actions.getExecOutput).toBeCalledWith( expect(actions.getExecOutput).toBeCalledWith(
dockerPath, dockerPath,
['inspect', image, ...args], ["inspect", image, ...args],
{silent: true} { silent: true }
) );
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 3, stdout: '', stderr: ''} const execReturn = { exitCode: 3, stdout: "", stderr: "" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
describe('with an unsuccessful exec return code', () => { describe("with an unsuccessful exec return code", () => {
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'} const execReturn = { exitCode: 0, stdout: "", stderr: "Output" };
beforeEach(() => { beforeEach(() => {
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => { jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
return execReturn return execReturn;
}) });
}) });
test('pulls an image', async () => { test("pulls an image", async () => {
await expect(docker.pull(image, args)).rejects.toThrow() await expect(docker.pull(image, args)).rejects.toThrow();
}) });
test('inspects a docker image', async () => { test("inspects a docker image", async () => {
const result = await expect( const result = await expect(
docker.inspect(image, args) docker.inspect(image, args)
).rejects.toThrow() ).rejects.toThrow();
}) });
}) });
}) });
+32 -32
View File
@@ -1,32 +1,32 @@
import {getExecOutput} from '@actions/exec' import { getExecOutput } from "@actions/exec";
export class DockerExec { export class DockerExec {
private readonly dockerPath: string private readonly dockerPath: string;
constructor(dockerPath: string) { constructor(dockerPath: string) {
this.dockerPath = dockerPath this.dockerPath = dockerPath;
} }
public async pull(image: string, args: string[], silent?: boolean) { public async pull(image: string, args: string[], silent?: boolean) {
const result = await this.execute(['pull', image, ...args], silent) const result = await this.execute(["pull", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) { if (result.stderr != "" || result.exitCode != 0) {
throw new Error(`docker images pull failed: ${result.stderr}`) throw new Error(`docker images pull failed: ${result.stderr}`);
} }
} }
public async inspect( public async inspect(
image: string, image: string,
args: string[], args: string[],
silent: boolean = false silent: boolean = false
): Promise<string> { ): Promise<string> {
const result = await this.execute(['inspect', image, ...args], silent) const result = await this.execute(["inspect", image, ...args], silent);
if (result.stderr != '' || result.exitCode != 0) if (result.stderr != "" || result.exitCode != 0)
throw new Error(`docker inspect failed: ${result.stderr}`) throw new Error(`docker inspect failed: ${result.stderr}`);
return result.stdout return result.stdout;
} }
private async execute(args: string[], silent: boolean = false) { private async execute(args: string[], silent: boolean = false) {
return await getExecOutput(this.dockerPath, args, {silent}) return await getExecOutput(this.dockerPath, args, { silent });
} }
} }
+29 -31
View File
@@ -1,40 +1,38 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {Octokit} from '@octokit/core' import { Octokit } from "@octokit/core";
import {Endpoints} from '@octokit/types' import { Endpoints } from "@octokit/types";
import {retry} from '@octokit/plugin-retry' import { retry } from "@octokit/plugin-retry";
export const OkStatusCode = 200 export const OkStatusCode = 200;
const RetryOctokit = Octokit.plugin(retry) const RetryOctokit = Octokit.plugin(retry);
const RETRY_COUNT = 5 const RETRY_COUNT = 5;
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows' const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows";
type responseType = type responseType =
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response'] Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
export class GitHubClient { export class GitHubClient {
private readonly repository: string private readonly repository: string;
private readonly token: string private readonly token: string;
constructor(repository: string, token: string) { constructor(repository: string, token: string) {
this.repository = repository this.repository = repository;
this.token = token this.token = token;
} }
// prettier-ignore public async getWorkflows(): Promise<responseType> {
public async getWorkflows(): Promise<responseType> { const octokit = new RetryOctokit({
const octokit = new RetryOctokit({ auth: this.token,
auth: this.token, request: { retries: RETRY_COUNT },
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,
}) })
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
@@ -1,57 +0,0 @@
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
}
+301 -337
View File
@@ -1,367 +1,331 @@
import {getKubectlPath, Kubectl} from './kubectl' import { getKubectlPath, Kubectl } from "./kubectl";
import * as exec from '@actions/exec' import * as exec from "@actions/exec";
import * as io from '@actions/io' import * as io from "@actions/io";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import {config} from 'process' import { config } from "process";
describe('Kubectl path', () => { describe("Kubectl path", () => {
const version = '1.1' const version = "1.1";
const path = 'path' const path = "path";
it('gets the kubectl path', async () => { it("gets the kubectl path", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('gets the kubectl path with version', async () => { it("gets the kubectl path with version", async () => {
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version) jest.spyOn(core, "getInput").mockImplementationOnce(() => version);
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path) jest.spyOn(toolCache, "find").mockImplementationOnce(() => path);
expect(await getKubectlPath()).toBe(path) expect(await getKubectlPath()).toBe(path);
}) });
it('throws if kubectl not found', async () => { it("throws if kubectl not found", async () => {
// without version // without version
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
// with verision // with verision
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined) jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => getKubectlPath()).rejects.toThrow() await expect(() => getKubectlPath()).rejects.toThrow();
}) });
}) });
const kubectlPath = 'kubectlPath' const kubectlPath = "kubectlPath";
const testNamespace = 'testNamespace' const namespace = "namespace";
const defaultNamespace = 'default' describe("Kubectl class", () => {
describe('Kubectl class', () => { const kubectl = new Kubectl(kubectlPath, namespace);
describe('default namespace behavior', () => {
const kubectl = new Kubectl(kubectlPath, defaultNamespace)
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
beforeEach(() => { describe("with a success exec return", () => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => { const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
return execReturn
})
})
describe('omits default namespace from commands', () => { beforeEach(() => {
it('executes a command without appending --namespace arg', async () => { jest.spyOn(exec, "getExecOutput").mockImplementation(async () => {
// no args return execReturn;
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', () => { it("applies a configuration with a single config path", async () => {
const kubectl = new Kubectl(kubectlPath, testNamespace) const configPaths = "configPaths";
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''} const result = await kubectl.apply(configPaths);
expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
["apply", "-f", configPaths, "--namespace", namespace],
{ silent: false }
);
});
beforeEach(() => { it("applies a configuration with multiple config paths", async () => {
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => { const configPaths = ["configPath1", "configPath2", "configPath3"];
return execReturn const result = await kubectl.apply(configPaths);
}) expect(result).toBe(execReturn);
}) expect(exec.getExecOutput).toBeCalledWith(
kubectlPath,
[
"apply",
"-f",
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
"--namespace",
namespace,
],
{ silent: false }
);
});
it('applies a configuration with a single config path', async () => { it("applies a configuration with force when specified", async () => {
const configPaths = 'configPaths' const configPaths = ["configPath1", "configPath2", "configPath3"];
const result = await kubectl.apply(configPaths) const result = await kubectl.apply(configPaths, true);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
['apply', '-f', configPaths, '--namespace', testNamespace], [
{silent: false} "apply",
) "-f",
}) configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
"--force",
"--namespace",
namespace,
],
{ silent: false }
);
});
it('applies a configuration with multiple config paths', async () => { it("describes a resource", async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3'] const resourceType = "type";
const result = await kubectl.apply(configPaths) const resourceName = "name";
expect(result).toBe(execReturn) const result = await kubectl.describe(resourceType, resourceName);
expect(exec.getExecOutput).toBeCalledWith( expect(result).toBe(execReturn);
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
'apply', ["describe", resourceType, resourceName, "--namespace", namespace],
'-f', { silent: false }
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2], );
'--namespace', });
testNamespace
],
{silent: false}
)
})
it('applies a configuration with force when specified', async () => { it("describes a resource silently", async () => {
const configPaths = ['configPath1', 'configPath2', 'configPath3'] const resourceType = "type";
const result = await kubectl.apply(configPaths, true) const resourceName = "name";
expect(result).toBe(execReturn) const result = await kubectl.describe(resourceType, resourceName, true);
expect(exec.getExecOutput).toBeCalledWith( expect(result).toBe(execReturn);
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
'apply', ["describe", resourceType, resourceName, "--namespace", namespace],
'-f', { silent: true }
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2], );
'--force', });
'--namespace',
testNamespace
],
{silent: false}
)
})
it('describes a resource', async () => { it("annotates resource", async () => {
const resourceType = 'type' const resourceType = "type";
const resourceName = 'name' const resourceName = "name";
const result = await kubectl.describe(resourceType, resourceName) const annotation = "annotation";
expect(result).toBe(execReturn) const result = await kubectl.annotate(
expect(exec.getExecOutput).toBeCalledWith( resourceType,
kubectlPath, resourceName,
[ annotation
'describe', );
resourceType, expect(result).toBe(execReturn);
resourceName, expect(exec.getExecOutput).toBeCalledWith(
'--namespace', kubectlPath,
testNamespace [
], "annotate",
{silent: false} resourceType,
) resourceName,
}) annotation,
"--overwrite",
"--namespace",
namespace,
],
{ silent: false }
);
});
it('describes a resource silently', async () => { it("annotates files with single file", async () => {
const resourceType = 'type' const file = "file";
const resourceName = 'name' const annotation = "annotation";
const result = await kubectl.describe(resourceType, resourceName, true) const result = await kubectl.annotateFiles(file, annotation);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'describe', "annotate",
resourceType, "-f",
resourceName, file,
'--namespace', annotation,
testNamespace "--overwrite",
], "--namespace",
{silent: true} namespace,
) ],
}) { silent: false }
);
});
it('annotates resource', async () => { it("annotates files with mulitple files", async () => {
const resourceType = 'type' const files = ["file1", "file2", "file3"];
const resourceName = 'name' const annotation = "annotation";
const annotation = 'annotation' const result = await kubectl.annotateFiles(files, annotation);
const result = await kubectl.annotate( expect(result).toBe(execReturn);
resourceType, expect(exec.getExecOutput).toBeCalledWith(
resourceName, kubectlPath,
annotation [
) "annotate",
expect(result).toBe(execReturn) "-f",
expect(exec.getExecOutput).toBeCalledWith( files.join(","),
kubectlPath, annotation,
[ "--overwrite",
'annotate', "--namespace",
resourceType, namespace,
resourceName, ],
annotation, { silent: false }
'--overwrite', );
'--namespace', });
testNamespace
],
{silent: false}
)
})
it('annotates files with single file', async () => { it("labels files with single file", async () => {
const file = 'file' const file = "file";
const annotation = 'annotation' const labels = ["label1", "label2"];
const result = await kubectl.annotateFiles(file, annotation) const result = await kubectl.labelFiles(file, labels);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'annotate', "label",
'-f', "-f",
file, file,
annotation, ...labels,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{silent: false} { silent: false }
) );
}) });
it('annotates files with mulitple files', async () => { it("labels files with multiple files", async () => {
const files = ['file1', 'file2', 'file3'] const files = ["file1", "file2", "file3"];
const annotation = 'annotation' const labels = ["label1", "label2"];
const result = await kubectl.annotateFiles(files, annotation) const result = await kubectl.labelFiles(files, labels);
expect(result).toBe(execReturn) expect(result).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[ [
'annotate', "label",
'-f', "-f",
files.join(','), files.join(","),
annotation, ...labels,
'--overwrite', "--overwrite",
'--namespace', "--namespace",
testNamespace namespace,
], ],
{silent: false} { silent: false }
) );
}) });
it('labels files with single file', async () => { it("gets all pods", async () => {
const file = 'file' expect(await kubectl.getAllPods()).toBe(execReturn);
const labels = ['label1', 'label2'] expect(exec.getExecOutput).toBeCalledWith(
const result = await kubectl.labelFiles(file, labels) kubectlPath,
expect(result).toBe(execReturn) ["get", "pods", "-o", "json", "--namespace", namespace],
expect(exec.getExecOutput).toBeCalledWith( { silent: true }
kubectlPath, );
[ });
'label',
'-f',
file,
...labels,
'--overwrite',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('labels files with multiple files', async () => { it("checks rollout status", async () => {
const files = ['file1', 'file2', 'file3'] const resourceType = "type";
const labels = ['label1', 'label2'] const name = "name";
const result = await kubectl.labelFiles(files, labels) expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
expect(result).toBe(execReturn) execReturn
expect(exec.getExecOutput).toBeCalledWith( );
kubectlPath, expect(exec.getExecOutput).toBeCalledWith(
[ kubectlPath,
'label', [
'-f', "rollout",
files.join(','), "status",
...labels, `${resourceType}/${name}`,
'--overwrite', "--namespace",
'--namespace', namespace,
testNamespace ],
], { silent: false }
{silent: false} );
) });
})
it('gets all pods', async () => { it("gets resource", async () => {
expect(await kubectl.getAllPods()).toBe(execReturn) const resourceType = "type";
expect(exec.getExecOutput).toBeCalledWith( const name = "name";
kubectlPath, expect(await kubectl.getResource(resourceType, name)).toBe(execReturn);
['get', 'pods', '-o', 'json', '--namespace', testNamespace], expect(exec.getExecOutput).toBeCalledWith(
{silent: true} kubectlPath,
) [
}) "get",
`${resourceType}/${name}`,
"-o",
"json",
"--namespace",
namespace,
],
{ silent: false }
);
});
it('checks rollout status', async () => { it("executes a command", async () => {
const resourceType = 'type' // no args
const name = 'name' const command = "command";
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe( expect(await kubectl.executeCommand(command)).toBe(execReturn);
execReturn expect(exec.getExecOutput).toBeCalledWith(
) kubectlPath,
expect(exec.getExecOutput).toBeCalledWith( [command, "--namespace", namespace],
kubectlPath, { silent: false }
[ );
'rollout',
'status',
`${resourceType}/${name}`,
'--namespace',
testNamespace
],
{silent: false}
)
})
it('gets resource', async () => { // with args
const resourceType = 'type' const args = "args";
const name = 'name' expect(await kubectl.executeCommand(command, args)).toBe(execReturn);
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn) expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, [command, args, "--namespace", namespace],
[ { silent: false }
'get', );
`${resourceType}/${name}`, });
'-o',
'json',
'--namespace',
testNamespace
],
{silent: false}
)
})
it('executes a command', async () => { it("deletes with single argument", async () => {
// no args const arg = "argument";
const command = 'command' expect(await kubectl.delete(arg)).toBe(execReturn);
expect(await kubectl.executeCommand(command)).toBe(execReturn) expect(exec.getExecOutput).toBeCalledWith(
expect(exec.getExecOutput).toBeCalledWith( kubectlPath,
kubectlPath, ["delete", arg, "--namespace", namespace],
[command, '--namespace', testNamespace], { silent: false }
{silent: false} );
) });
// with args it("deletes with multiple arguments", async () => {
const args = 'args' const args = ["argument1", "argument2", "argument3"];
expect(await kubectl.executeCommand(command, args)).toBe(execReturn) expect(await kubectl.delete(args)).toBe(execReturn);
expect(exec.getExecOutput).toBeCalledWith( expect(exec.getExecOutput).toBeCalledWith(
kubectlPath, kubectlPath,
[command, args, '--namespace', testNamespace], ["delete", ...args, "--namespace", namespace],
{silent: false} { silent: false }
) );
}) });
});
it('deletes with single argument', async () => { it("gets new replica sets", async () => {
const arg = 'argument' const newReplicaSetName = "newreplicaset";
expect(await kubectl.delete(arg)).toBe(execReturn) const name = "name";
expect(exec.getExecOutput).toBeCalledWith( const describeReturn = {
kubectlPath, exitCode: 0,
['delete', arg, '--namespace', testNamespace], stdout: newReplicaSetName + name + " " + "extra",
{silent: false} stderr: "",
) };
})
it('deletes with multiple arguments', async () => { jest.spyOn(exec, "getExecOutput").mockImplementationOnce(async () => {
const args = ['argument1', 'argument2', 'argument3'] return describeReturn;
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 deployment = "deployment";
const kubectl = new Kubectl(kubectlPath, testNamespace) const result = await kubectl.getNewReplicaSet(deployment);
expect(result).toBe(name);
const newReplicaSetName = 'newreplicaset' });
const name = 'name' });
const describeReturn = {
exitCode: 0,
stdout: newReplicaSetName + name + ' ' + 'extra',
stderr: ''
}
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
return describeReturn
})
const deployment = 'deployment'
const result = await kubectl.getNewReplicaSet(deployment)
expect(result).toBe(name)
})
})
+168 -194
View File
@@ -1,194 +1,168 @@
import {ExecOutput, getExecOutput} from '@actions/exec' import { ExecOutput, getExecOutput } from "@actions/exec";
import {createInlineArray} from '../utilities/arrayUtils' import { createInlineArray } from "../utilities/arrayUtils";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as toolCache from '@actions/tool-cache' import * as toolCache from "@actions/tool-cache";
import * as io from '@actions/io' import * as io from "@actions/io";
import {exec} from 'child_process'
export interface Resource {
export interface Resource { name: string;
name: string type: string;
type: string }
}
export class Kubectl {
export class Kubectl { private readonly kubectlPath: string;
protected readonly kubectlPath: string private readonly namespace: string;
protected readonly namespace: string private readonly ignoreSSLErrors: boolean;
protected readonly ignoreSSLErrors: boolean
protected readonly resourceGroup: string constructor(
protected readonly name: string kubectlPath: string,
protected isPrivateCluster: boolean namespace: string = "default",
ignoreSSLErrors: boolean = false
constructor( ) {
kubectlPath: string, this.kubectlPath = kubectlPath;
namespace: string = 'default', this.ignoreSSLErrors = !!ignoreSSLErrors;
ignoreSSLErrors: boolean = false, this.namespace = namespace;
resourceGroup: string = '', }
name: string = ''
) { public async apply(
this.kubectlPath = kubectlPath configurationPaths: string | string[],
this.ignoreSSLErrors = !!ignoreSSLErrors force: boolean = false
this.namespace = namespace ): Promise<ExecOutput> {
this.resourceGroup = resourceGroup try {
this.name = name if (!configurationPaths || configurationPaths?.length === 0)
} throw Error("Configuration paths must exist");
public async apply( const applyArgs: string[] = [
configurationPaths: string | string[], "apply",
force: boolean = false "-f",
): Promise<ExecOutput> { createInlineArray(configurationPaths),
try { ];
if (!configurationPaths || configurationPaths?.length === 0) if (force) applyArgs.push("--force");
throw Error('Configuration paths must exist')
return await this.execute(applyArgs);
const applyArgs: string[] = [ } catch (err) {
'apply', core.debug("Kubectl apply failed:" + err);
'-f', }
createInlineArray(configurationPaths) }
]
if (force) applyArgs.push('--force') public async describe(
resourceType: string,
return await this.execute(applyArgs) resourceName: string,
} catch (err) { silent: boolean = false
core.debug('Kubectl apply failed:' + err) ): Promise<ExecOutput> {
} return await this.execute(["describe", resourceType, resourceName], silent);
} }
public async describe( public async getNewReplicaSet(deployment: string) {
resourceType: string, const result = await this.describe("deployment", deployment, true);
resourceName: string,
silent: boolean = false let newReplicaSet = "";
): Promise<ExecOutput> { if (result?.stdout) {
return await this.execute( const stdout = result.stdout.split("\n");
['describe', resourceType, resourceName], stdout.forEach((line: string) => {
silent const newreplicaset = "newreplicaset";
) if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
} newReplicaSet = line
.substring(newreplicaset.length)
public async getNewReplicaSet(deployment: string) { .trim()
const result = await this.describe('deployment', deployment, true) .split(" ")[0];
});
let newReplicaSet = '' }
if (result?.stdout) {
const stdout = result.stdout.split('\n') return newReplicaSet;
stdout.forEach((line: string) => { }
const newreplicaset = 'newreplicaset'
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) public async annotate(
newReplicaSet = line resourceType: string,
.substring(newreplicaset.length) resourceName: string,
.trim() annotation: string
.split(' ')[0] ): Promise<ExecOutput> {
}) const args = [
} "annotate",
resourceType,
return newReplicaSet resourceName,
} annotation,
"--overwrite",
public async annotate( ];
resourceType: string, return await this.execute(args);
resourceName: string, }
annotation: string
): Promise<ExecOutput> { public async annotateFiles(
const args = [ files: string | string[],
'annotate', annotation: string
resourceType, ): Promise<ExecOutput> {
resourceName, const args = [
annotation, "annotate",
'--overwrite' "-f",
] createInlineArray(files),
return await this.execute(args) annotation,
} "--overwrite",
];
public async annotateFiles( return await this.execute(args);
files: string | string[], }
annotation: string
): Promise<ExecOutput> { public async labelFiles(
const args = [ files: string | string[],
'annotate', labels: string[]
'-f', ): Promise<ExecOutput> {
createInlineArray(files), const args = [
annotation, "label",
'--overwrite' "-f",
] createInlineArray(files),
return await this.execute(args) ...labels,
} "--overwrite",
];
public async labelFiles( return await this.execute(args);
files: string | string[], }
labels: string[]
): Promise<ExecOutput> { public async getAllPods(): Promise<ExecOutput> {
const args = [ return await this.execute(["get", "pods", "-o", "json"], true);
'label', }
'-f',
createInlineArray(files), public async checkRolloutStatus(
...labels, resourceType: string,
'--overwrite' name: string
] ): Promise<ExecOutput> {
return await this.execute(args) return await this.execute(["rollout", "status", `${resourceType}/${name}`]);
} }
public async getAllPods(): Promise<ExecOutput> { public async getResource(
return await this.execute(['get', 'pods', '-o', 'json'], true) resourceType: string,
} name: string
): Promise<ExecOutput> {
public async checkRolloutStatus( return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]);
resourceType: string, }
name: string
): Promise<ExecOutput> { public executeCommand(command: string, args?: string) {
return await this.execute([ if (!command) throw new Error("Command must be defined");
'rollout', return args ? this.execute([command, args]) : this.execute([command]);
'status', }
`${resourceType}/${name}`
]) public delete(args: string | string[]) {
} if (typeof args === "string") return this.execute(["delete", args]);
return this.execute(["delete", ...args]);
public async getResource( }
resourceType: string,
name: string, private async execute(args: string[], silent: boolean = false) {
silentFailure: boolean = false if (this.ignoreSSLErrors) {
): Promise<ExecOutput> { args.push("--insecure-skip-tls-verify");
core.debug( }
'fetching resource of type ' + resourceType + ' and name ' + name args = args.concat(["--namespace", this.namespace]);
)
return await this.execute( core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`);
['get', `${resourceType}/${name}`, '-o', 'json'], return await getExecOutput(this.kubectlPath, args, { silent });
silentFailure }
) }
}
export async function getKubectlPath() {
public executeCommand(command: string, args?: string) { const version = core.getInput("kubectl-version");
if (!command) throw new Error('Command must be defined') const kubectlPath = version
return args ? this.execute([command, args]) : this.execute([command]) ? toolCache.find("kubectl", version)
} : await io.which("kubectl", true);
if (!kubectlPath)
public delete(args: string | string[]) { throw Error(
if (typeof args === 'string') return this.execute(['delete', args]) "kubectl not found. You must install it before running this action"
return this.execute(['delete', ...args]) );
}
return kubectlPath;
protected async execute(args: string[], silent: boolean = false) { }
if (this.ignoreSSLErrors) {
args.push('--insecure-skip-tls-verify')
}
if (this.namespace && this.namespace != 'default') {
args = args.concat(['--namespace', this.namespace])
}
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
return await getExecOutput(this.kubectlPath, args, {
silent
})
}
}
export async function getKubectlPath() {
const version = core.getInput('kubectl-version')
const kubectlPath = version
? toolCache.find('kubectl', version)
: await io.which('kubectl', true)
if (!kubectlPath)
throw Error(
'kubectl not found. You must install it before running this action'
)
return kubectlPath
}
+100 -102
View File
@@ -1,117 +1,115 @@
import { import {
DEPLOYMENT_TYPES, DEPLOYMENT_TYPES,
DiscoveryAndLoadBalancerResource, DiscoveryAndLoadBalancerResource,
isDeploymentEntity, isDeploymentEntity,
isIngressEntity, isIngressEntity,
isServiceEntity, isServiceEntity,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
ResourceKindNotDefinedError, ResourceKindNotDefinedError,
ServiceTypes, ServiceTypes,
WORKLOAD_TYPES, WORKLOAD_TYPES,
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS WORKLOAD_TYPES_WITH_ROLLOUT_STATUS,
} from './kubernetesTypes' } from "./kubernetesTypes";
describe('Kubernetes types', () => { describe("Kubernetes types", () => {
it('contains kubernetes workloads', () => { it("contains kubernetes workloads", () => {
expect(KubernetesWorkload.POD).toBe('Pod') expect(KubernetesWorkload.POD).toBe("Pod");
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset') expect(KubernetesWorkload.REPLICASET).toBe("Replicaset");
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment') expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment");
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet') expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet");
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet') expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet");
expect(KubernetesWorkload.JOB).toBe('job') expect(KubernetesWorkload.JOB).toBe("job");
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob') expect(KubernetesWorkload.CRON_JOB).toBe("cronjob");
}) });
it('contains discovery and load balancer resources', () => { it("contains discovery and load balancer resources", () => {
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service') expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service");
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress') expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress");
}) });
it('contains service types', () => { it("contains service types", () => {
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer') expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer");
expect(ServiceTypes.NODE_PORT).toBe('NodePort') expect(ServiceTypes.NODE_PORT).toBe("NodePort");
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP') expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP");
}) });
it('contains deployment types', () => { it("contains deployment types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true) expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types', () => { it("contains workload types", () => {
const expected = [ const expected = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true) expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true);
}) });
it('contains workload types with rollout status', () => { it("contains workload types with rollout status", () => {
const expected = ['deployment', 'daemonset', 'statefulset'] const expected = ["deployment", "daemonset", "statefulset"];
expect( expect(
expected.every((val) => expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val))
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val) ).toBe(true);
) });
).toBe(true)
})
it('checks if kind is deployment entity', () => { it("checks if kind is deployment entity", () => {
// throws on no kind // throws on no kind
expect(() => isDeploymentEntity(undefined)).toThrow( expect(() => isDeploymentEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isDeploymentEntity('deployment')).toBe(true) expect(isDeploymentEntity("deployment")).toBe(true);
expect(isDeploymentEntity('Deployment')).toBe(true) expect(isDeploymentEntity("Deployment")).toBe(true);
expect(isDeploymentEntity('deploymenT')).toBe(true) expect(isDeploymentEntity("deploymenT")).toBe(true);
expect(isDeploymentEntity('DEPLOYMENT')).toBe(true) expect(isDeploymentEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is workload entity', () => { it("checks if kind is workload entity", () => {
// throws on no kind // throws on no kind
expect(() => isWorkloadEntity(undefined)).toThrow( expect(() => isWorkloadEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isWorkloadEntity('deployment')).toBe(true) expect(isWorkloadEntity("deployment")).toBe(true);
expect(isWorkloadEntity('Deployment')).toBe(true) expect(isWorkloadEntity("Deployment")).toBe(true);
expect(isWorkloadEntity('deploymenT')).toBe(true) expect(isWorkloadEntity("deploymenT")).toBe(true);
expect(isWorkloadEntity('DEPLOYMENT')).toBe(true) expect(isWorkloadEntity("DEPLOYMENT")).toBe(true);
}) });
it('checks if kind is service entity', () => { it("checks if kind is service entity", () => {
// throws on no kind // throws on no kind
expect(() => isServiceEntity(undefined)).toThrow( expect(() => isServiceEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isServiceEntity('service')).toBe(true) expect(isServiceEntity("service")).toBe(true);
expect(isServiceEntity('Service')).toBe(true) expect(isServiceEntity("Service")).toBe(true);
expect(isServiceEntity('servicE')).toBe(true) expect(isServiceEntity("servicE")).toBe(true);
expect(isServiceEntity('SERVICE')).toBe(true) expect(isServiceEntity("SERVICE")).toBe(true);
}) });
it('checks if kind is ingress entity', () => { it("checks if kind is ingress entity", () => {
// throws on no kind // throws on no kind
expect(() => isIngressEntity(undefined)).toThrow( expect(() => isIngressEntity(undefined)).toThrow(
ResourceKindNotDefinedError ResourceKindNotDefinedError
) );
expect(isIngressEntity('ingress')).toBe(true) expect(isIngressEntity("ingress")).toBe(true);
expect(isIngressEntity('Ingress')).toBe(true) expect(isIngressEntity("Ingress")).toBe(true);
expect(isIngressEntity('ingresS')).toBe(true) expect(isIngressEntity("ingresS")).toBe(true);
expect(isIngressEntity('INGRESS')).toBe(true) expect(isIngressEntity("INGRESS")).toBe(true);
}) });
}) });
+81 -81
View File
@@ -1,81 +1,81 @@
export class KubernetesWorkload { export class KubernetesWorkload {
public static POD: string = 'Pod' public static POD: string = "Pod";
public static REPLICASET: string = 'Replicaset' public static REPLICASET: string = "Replicaset";
public static DEPLOYMENT: string = 'Deployment' public static DEPLOYMENT: string = "Deployment";
public static STATEFUL_SET: string = 'StatefulSet' public static STATEFUL_SET: string = "StatefulSet";
public static DAEMON_SET: string = 'DaemonSet' public static DAEMON_SET: string = "DaemonSet";
public static JOB: string = 'job' public static JOB: string = "job";
public static CRON_JOB: string = 'cronjob' public static CRON_JOB: string = "cronjob";
} }
export class DiscoveryAndLoadBalancerResource { export class DiscoveryAndLoadBalancerResource {
public static SERVICE: string = 'service' public static SERVICE: string = "service";
public static INGRESS: string = 'ingress' public static INGRESS: string = "ingress";
} }
export class ServiceTypes { export class ServiceTypes {
public static LOAD_BALANCER: string = 'LoadBalancer' public static LOAD_BALANCER: string = "LoadBalancer";
public static NODE_PORT: string = 'NodePort' public static NODE_PORT: string = "NodePort";
public static CLUSTER_IP: string = 'ClusterIP' public static CLUSTER_IP: string = "ClusterIP";
} }
export const DEPLOYMENT_TYPES: string[] = [ export const DEPLOYMENT_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset' "statefulset",
] ];
export const WORKLOAD_TYPES: string[] = [ export const WORKLOAD_TYPES: string[] = [
'deployment', "deployment",
'replicaset', "replicaset",
'daemonset', "daemonset",
'pod', "pod",
'statefulset', "statefulset",
'job', "job",
'cronjob' "cronjob",
] ];
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [ export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
'deployment', "deployment",
'daemonset', "daemonset",
'statefulset' "statefulset",
] ];
export function isDeploymentEntity(kind: string): boolean { export function isDeploymentEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return DEPLOYMENT_TYPES.some((type: string) => { return DEPLOYMENT_TYPES.some((type: string) => {
return type.toLowerCase() === kind.toLowerCase() return type.toLowerCase() === kind.toLowerCase();
}) });
} }
export function isWorkloadEntity(kind: string): boolean { export function isWorkloadEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return WORKLOAD_TYPES.some( return WORKLOAD_TYPES.some(
(type: string) => type.toLowerCase() === kind.toLowerCase() (type: string) => type.toLowerCase() === kind.toLowerCase()
) );
} }
export function isServiceEntity(kind: string): boolean { export function isServiceEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'service' === kind.toLowerCase() return "service" === kind.toLowerCase();
} }
export function isIngressEntity(kind: string): boolean { export function isIngressEntity(kind: string): boolean {
if (!kind) throw ResourceKindNotDefinedError if (!kind) throw ResourceKindNotDefinedError;
return 'ingress' === kind.toLowerCase() return "ingress" === kind.toLowerCase();
} }
export const ResourceKindNotDefinedError = Error('Resource kind not defined') export const ResourceKindNotDefinedError = Error("Resource kind not defined");
export const NullInputObjectError = Error('Null inputObject') export const NullInputObjectError = Error("Null inputObject");
export const InputObjectKindNotDefinedError = Error( export const InputObjectKindNotDefinedError = Error(
'Input object kind not defined' "Input object kind not defined"
) );
export const InputObjectMetadataNotDefinedError = Error( export const InputObjectMetadataNotDefinedError = Error(
'Input object metatada not defined' "Input object metatada not defined"
) );
-135
View File
@@ -1,135 +0,0 @@
import {Kubectl} from './kubectl'
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
import * as core from '@actions/core'
import * as os from 'os'
import * as fs from 'fs'
import * as path from 'path'
export class PrivateKubectl extends Kubectl {
protected async execute(args: string[], silent: boolean = false) {
args.unshift('kubectl')
let kubectlCmd = args.join(' ')
let addFileFlag = false
let eo = <ExecOptions>{silent}
if (this.containsFilenames(kubectlCmd)) {
// For private clusters, files will referenced solely by their basename
kubectlCmd = this.replaceFilnamesWithBasenames(kubectlCmd)
addFileFlag = true
}
const privateClusterArgs = [
'aks',
'command',
'invoke',
'--resource-group',
this.resourceGroup,
'--name',
this.name,
'--command',
kubectlCmd
]
if (addFileFlag) {
const filenames = this.extractFilesnames(kubectlCmd).split(' ')
const tempDirectory =
process.env['runner.tempDirectory'] || os.tmpdir() + '/manifests'
eo.cwd = tempDirectory
privateClusterArgs.push(...['--file', '.'])
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
const file = filenamesArr[index]
if (!file) {
continue
}
this.moveFileToTempManifestDir(file)
}
}
core.debug(
`private cluster Kubectl run with invoke command: ${kubectlCmd}`
)
return await getExecOutput('az', privateClusterArgs, eo)
}
private replaceFilnamesWithBasenames(kubectlCmd: string) {
let exFilenames = this.extractFilesnames(kubectlCmd)
let filenames = exFilenames.split(' ')
let filenamesArr = filenames[0].split(',')
for (let index = 0; index < filenamesArr.length; index++) {
filenamesArr[index] = path.basename(filenamesArr[index])
}
let baseFilenames = filenamesArr.join()
let result = kubectlCmd.replace(exFilenames, baseFilenames)
return result
}
public extractFilesnames(strToParse: string) {
let start = strToParse.indexOf('-filename')
let offset = 7
if (start == -1) {
start = strToParse.indexOf('-f')
if (start == -1) {
return ''
}
offset = 0
}
let temp = strToParse.substring(start + offset)
let end = temp.indexOf(' -')
//End could be case where the -f flag was last, or -f is followed by some additonal flag and it's arguments
return temp.substring(3, end == -1 ? temp.length : end).trim()
}
private containsFilenames(str: string) {
return str.includes('-f ') || str.includes('filename ')
}
private createTempManifestsDirectory() {
const manifestsDir = '/tmp/manifests'
if (!fs.existsSync('/tmp/manifests')) {
fs.mkdirSync('/tmp/manifests', {recursive: true})
}
}
private moveFileToTempManifestDir(file: string) {
this.createTempManifestsDirectory()
if (!fs.existsSync('/tmp/' + file)) {
core.debug(
'/tmp/' +
file +
' does not exist, and therefore cannot be moved to the manifest directory'
)
}
fs.copyFile('/tmp/' + file, '/tmp/manifests/' + file, function (err) {
if (err) {
core.debug(
'Could not rename ' +
'/tmp/' +
file +
' to ' +
'/tmp/manifests/' +
file +
' ERROR: ' +
err
)
return
}
core.debug(
"Successfully moved file '" +
file +
"' from /tmp to /tmp/manifest directory"
)
})
}
}
+19 -19
View File
@@ -1,22 +1,22 @@
import {parseRouteStrategy, RouteStrategy} from './routeStrategy' import { parseRouteStrategy, RouteStrategy } from "./routeStrategy";
describe('Route strategy type', () => { describe("Route strategy type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(RouteStrategy) const vals = <any>Object.values(RouteStrategy);
expect(vals.includes('ingress')).toBe(true) expect(vals.includes("ingress")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
expect(vals.includes('service')).toBe(true) expect(vals.includes("service")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseRouteStrategy('ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('Ingress')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("Ingress")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('ingresS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("ingresS")).toBe(RouteStrategy.INGRESS);
expect(parseRouteStrategy('INGRESS')).toBe(RouteStrategy.INGRESS) expect(parseRouteStrategy("INGRESS")).toBe(RouteStrategy.INGRESS);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseRouteStrategy('invalid')).toBe(undefined) expect(parseRouteStrategy("invalid")).toBe(undefined);
expect(parseRouteStrategy('unsupportedType')).toBe(undefined) expect(parseRouteStrategy("unsupportedType")).toBe(undefined);
}) });
}) });
+8 -8
View File
@@ -1,12 +1,12 @@
export enum RouteStrategy { export enum RouteStrategy {
INGRESS = 'ingress', INGRESS = "ingress",
SMI = 'smi', SMI = "smi",
SERVICE = 'service' SERVICE = "service",
} }
export const parseRouteStrategy = (str: string): RouteStrategy | undefined => export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
RouteStrategy[ RouteStrategy[
Object.keys(RouteStrategy).filter( Object.keys(RouteStrategy).filter(
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase() (k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof RouteStrategy )[0] as keyof typeof RouteStrategy
] ];
+21 -18
View File
@@ -1,21 +1,24 @@
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod' import {
parseTrafficSplitMethod,
TrafficSplitMethod,
} from "./trafficSplitMethod";
describe('Traffic split method type', () => { describe("Traffic split method type", () => {
test('it has required values', () => { test("it has required values", () => {
const vals = <any>Object.values(TrafficSplitMethod) const vals = <any>Object.values(TrafficSplitMethod);
expect(vals.includes('pod')).toBe(true) expect(vals.includes("pod")).toBe(true);
expect(vals.includes('smi')).toBe(true) expect(vals.includes("smi")).toBe(true);
}) });
test('it can parse valid values from a string', () => { test("it can parse valid values from a string", () => {
expect(parseTrafficSplitMethod('pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('Pod')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("Pod")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('poD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("poD")).toBe(TrafficSplitMethod.POD);
expect(parseTrafficSplitMethod('POD')).toBe(TrafficSplitMethod.POD) expect(parseTrafficSplitMethod("POD")).toBe(TrafficSplitMethod.POD);
}) });
test("it will return undefined if it can't parse values from a string", () => { test("it will return undefined if it can't parse values from a string", () => {
expect(parseTrafficSplitMethod('invalid')).toBe(undefined) expect(parseTrafficSplitMethod("invalid")).toBe(undefined);
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined) expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined);
}) });
}) });
+9 -9
View File
@@ -1,6 +1,6 @@
export enum TrafficSplitMethod { export enum TrafficSplitMethod {
POD = 'pod', POD = "pod",
SMI = 'smi' SMI = "smi",
} }
/** /**
@@ -9,11 +9,11 @@ export enum TrafficSplitMethod {
* @returns The TrafficSplitMethod enum or undefined if it can't be parsed * @returns The TrafficSplitMethod enum or undefined if it can't be parsed
*/ */
export const parseTrafficSplitMethod = ( export const parseTrafficSplitMethod = (
str: string str: string
): TrafficSplitMethod | undefined => ): TrafficSplitMethod | undefined =>
TrafficSplitMethod[ TrafficSplitMethod[
Object.keys(TrafficSplitMethod).filter( Object.keys(TrafficSplitMethod).filter(
(k) => (k) =>
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase() TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
)[0] as keyof typeof TrafficSplitMethod )[0] as keyof typeof TrafficSplitMethod
] ];
+10 -10
View File
@@ -1,12 +1,12 @@
import {createInlineArray} from './arrayUtils' import { createInlineArray } from "./arrayUtils";
describe('array utilities', () => { describe("array utilities", () => {
it('creates an inline array', () => { it("creates an inline array", () => {
const strings = ['str1', 'str2', 'str3'] const strings = ["str1", "str2", "str3"];
expect(createInlineArray(strings)).toBe(strings.join(',')) expect(createInlineArray(strings)).toBe(strings.join(","));
const string = 'str1' const string = "str1";
expect(createInlineArray([string])).toBe(string) expect(createInlineArray([string])).toBe(string);
expect(createInlineArray(string)).toBe(string) expect(createInlineArray(string)).toBe(string);
}) });
}) });
+6 -6
View File
@@ -1,6 +1,6 @@
export function createInlineArray(str: string | string[]): string { export function createInlineArray(str: string | string[]): string {
if (typeof str === 'string') { if (typeof str === "string") {
return str return str;
} }
return str.join(',') return str.join(",");
} }
+13 -13
View File
@@ -1,15 +1,15 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {checkDockerPath} from './dockerUtils' import { checkDockerPath } from "./dockerUtils";
describe('docker utilities', () => { describe("docker utilities", () => {
it('checks if docker is installed', async () => { it("checks if docker is installed", async () => {
// docker installed // docker installed
const path = 'path' const path = "path";
jest.spyOn(io, 'which').mockImplementationOnce(async () => path) jest.spyOn(io, "which").mockImplementationOnce(async () => path);
expect(() => checkDockerPath()).not.toThrow() expect(() => checkDockerPath()).not.toThrow();
// docker not installed // docker not installed
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined) jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
await expect(() => checkDockerPath()).rejects.toThrow() await expect(() => checkDockerPath()).rejects.toThrow();
}) });
}) });
+59 -59
View File
@@ -1,75 +1,75 @@
import * as io from '@actions/io' import * as io from "@actions/io";
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
import * as core from '@actions/core' import * as core from "@actions/core";
import {DockerExec} from '../types/docker' import { DockerExec } from "../types/docker";
import {getNormalizedPath} from './githubUtils' import { getNormalizedPath } from "./githubUtils";
export async function getDeploymentConfig(): Promise<DeploymentConfig> { export async function getDeploymentConfig(): Promise<DeploymentConfig> {
let helmChartPaths: string[] = let helmChartPaths: string[] =
process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') || process.env?.HELM_CHART_PATHS?.split(";").filter((path) => path != "") ||
[] [];
helmChartPaths = helmChartPaths.map((helmchart) => helmChartPaths = helmChartPaths.map((helmchart) =>
getNormalizedPath(helmchart.trim()) getNormalizedPath(helmchart.trim())
) );
let inputManifestFiles: string[] = let inputManifestFiles: string[] =
core core
.getInput('manifests') .getInput("manifests")
.split(/[\n,;]+/) .split(/[\n,;]+/)
.filter((manifest) => manifest.trim().length > 0) || [] .filter((manifest) => manifest.trim().length > 0) || [];
if (helmChartPaths?.length == 0) { if (helmChartPaths?.length == 0) {
inputManifestFiles = inputManifestFiles.map((manifestFile) => inputManifestFiles = inputManifestFiles.map((manifestFile) =>
getNormalizedPath(manifestFile) getNormalizedPath(manifestFile)
) );
} }
const imageNames = core.getInput('images').split('\n') || [] const imageNames = core.getInput("images").split("\n") || [];
const imageDockerfilePathMap: {[id: string]: string} = {} const imageDockerfilePathMap: { [id: string]: string } = {};
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false') const pullImages = !(core.getInput("pull-images").toLowerCase() === "false");
if (pullImages) { if (pullImages) {
//Fetching from image label if available //Fetching from image label if available
for (const image of imageNames) { for (const image of imageNames) {
try { try {
imageDockerfilePathMap[image] = await getDockerfilePath(image) imageDockerfilePathMap[image] = await getDockerfilePath(image);
} catch (ex) { } catch (ex) {
core.warning( core.warning(
`Failed to get dockerfile path for image ${image.toString()}: ${ex} ` `Failed to get dockerfile path for image ${image.toString()}: ${ex} `
) );
}
} }
} }
}
return Promise.resolve(<DeploymentConfig>{ return Promise.resolve(<DeploymentConfig>{
manifestFilePaths: inputManifestFiles, manifestFilePaths: inputManifestFiles,
helmChartFilePaths: helmChartPaths, helmChartFilePaths: helmChartPaths,
dockerfilePaths: imageDockerfilePathMap dockerfilePaths: imageDockerfilePathMap,
}) });
} }
async function getDockerfilePath(image: any): Promise<string> { async function getDockerfilePath(image: any): Promise<string> {
await checkDockerPath() await checkDockerPath();
const dockerExec: DockerExec = new DockerExec('docker') const dockerExec: DockerExec = new DockerExec("docker");
await dockerExec.pull(image, [], false) await dockerExec.pull(image, [], false);
const imageInspectResult: string = await dockerExec.inspect(image, [], false) const imageInspectResult: string = await dockerExec.inspect(image, [], false);
const imageConfig = JSON.parse(imageInspectResult)[0] const imageConfig = JSON.parse(imageInspectResult)[0];
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path' const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path";
let pathValue: string = '' let pathValue: string = "";
if ( if (
imageConfig?.Config?.Labels && imageConfig?.Config?.Labels &&
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY] imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
) { ) {
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY] const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY];
pathValue = getNormalizedPath(pathLabel) pathValue = getNormalizedPath(pathLabel);
} }
return Promise.resolve(pathValue) return Promise.resolve(pathValue);
} }
export async function checkDockerPath() { export async function checkDockerPath() {
const dockerPath = await io.which('docker', false) const dockerPath = await io.which("docker", false);
if (!dockerPath) { if (!dockerPath) {
throw new Error('Docker is not installed.') throw new Error("Docker is not installed.");
} }
} }
+39 -53
View File
@@ -1,63 +1,49 @@
import {getFilesFromDirectories} from './fileUtils' import {
getFilesFromDirectories
} from "./fileUtils";
import * as path from "path";
import * as path from 'path' describe("File utils", () => {
it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
describe('File utils', () => { const testPath = path.join("test", "unit", "manifests")
it('detects files in nested directories and ignores non-manifest files and empty dirs', () => {
const testPath = path.join('test', 'unit', 'manifests')
const testSearch: string[] = getFilesFromDirectories([testPath]) const testSearch: string[] = getFilesFromDirectories([testPath])
const expectedManifests = [ const expectedManifests =
'test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml', [
'test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml', "test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml",
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml', "test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml",
'test/unit/manifests/test-ingress.yml', "test/unit/manifests/manifest_test_dir/nested-test-service.yaml",
'test/unit/manifests/test-ingress-new.yml', "test/unit/manifests/test-ingress.yml",
'test/unit/manifests/test-service.yml' "test/unit/manifests/test-service.yml"
] ]
// is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(7) // is there a more efficient way to test equality w random order?
expect(testSearch).toHaveLength(5);
expectedManifests.forEach((fileName) => { expectedManifests.forEach((fileName) => {
expect(testSearch).toContain(fileName) expect(testSearch).toContain(fileName)
}) })
})
it('crashes when an invalid file is provided', () => { });
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
const goodPath = path.join(
'test',
'unit',
'manifests',
'manifest_test_dir'
)
expect(() => { it("crashes when an invalid file is provided", () => {
getFilesFromDirectories([badPath, goodPath]) const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml")
}).toThrowError() const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir")
})
it("doesn't duplicate files when nested dir included", () => { expect(() => {getFilesFromDirectories([badPath, goodPath])}).toThrowError()
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( it("doesn't duplicate files when nested dir included", () => {
getFilesFromDirectories([outerPath, fileAtOuter, innerPath]) const outerPath = path.join("test", "unit", "manifests")
).toHaveLength(7) const fileAtOuter = path.join("test", "unit", "manifests", "test-service.yml")
}) const innerPath = path.join("test", "unit", "manifests", "manifest_test_dir")
})
// files that don't exist / nested files that don't exist / something else with non-manifest expect(getFilesFromDirectories([outerPath, fileAtOuter, innerPath])).toHaveLength(5)
// lots of combinations of pointing to a directory and non yaml/yaml file })
// similarly named files in different folders });
// files that don't exist / nested files that don't exist / something else with non-manifest
// lots of combinations of pointing to a directory and non yaml/yaml file
// similarly named files in different folders
+109 -116
View File
@@ -1,116 +1,109 @@
import * as fs from 'fs' import * as fs from "fs";
import * as path from 'path' import * as path from "path";
import * as core from '@actions/core' import * as core from "@actions/core";
import * as os from 'os' import * as os from "os";
import {getCurrentTime} from './timeUtils' import { getCurrentTime } from "./timeUtils";
export function getTempDirectory(): string { export function getTempDirectory(): string {
return process.env['runner.tempDirectory'] || os.tmpdir() return process.env["runner.tempDirectory"] || os.tmpdir();
} }
export function writeObjectsToFile(inputObjects: any[]): string[] { export function writeObjectsToFile(inputObjects: any[]): string[] {
const newFilePaths = [] const newFilePaths = [];
inputObjects.forEach((inputObject: any) => { inputObjects.forEach((inputObject: any) => {
try { try {
const inputObjectString = JSON.stringify(inputObject) const inputObjectString = JSON.stringify(inputObject);
if (inputObject?.metadata?.name) { if (inputObject?.metadata?.name) {
const fileName = getManifestFileName( const fileName = getManifestFileName(
inputObject.kind, inputObject.kind,
inputObject.metadata.name inputObject.metadata.name
) );
fs.writeFileSync(path.join(fileName), inputObjectString) fs.writeFileSync(path.join(fileName), inputObjectString);
newFilePaths.push(fileName) newFilePaths.push(fileName);
} else { } else {
core.debug( core.debug(
'Input object is not proper K8s resource object. Object: ' + "Input object is not proper K8s resource object. Object: " +
inputObjectString inputObjectString
) );
} }
} catch (ex) { } catch (ex) {
core.debug( core.debug(
`Exception occurred while writing object to file ${inputObject}: ${ex}` `Exception occurred while writing object to file ${inputObject}: ${ex}`
) );
} }
}) });
return newFilePaths return newFilePaths;
} }
export function writeManifestToFile( export function writeManifestToFile(
inputObjectString: string, inputObjectString: string,
kind: string, kind: string,
name: string name: string
): string { ): string {
if (inputObjectString) { if (inputObjectString) {
try { try {
const fileName = getManifestFileName(kind, name) const fileName = getManifestFileName(kind, name);
fs.writeFileSync(path.join(fileName), inputObjectString) fs.writeFileSync(path.join(fileName), inputObjectString);
return fileName return fileName;
} catch (ex) { } catch (ex) {
throw Error( throw Error(
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}` `Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
) );
} }
} }
} }
function getManifestFileName(kind: string, name: string) { function getManifestFileName(kind: string, name: string) {
const filePath = `${kind}_${name}_${getCurrentTime().toString()}` const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`;
const tempDirectory = getTempDirectory() const tempDirectory = getTempDirectory();
return path.join(tempDirectory, path.basename(filePath)) return path.join(tempDirectory, path.basename(filePath));
} }
export function getFilesFromDirectories(filePaths: string[]): string[] { export function getFilesFromDirectories(
const fullPathSet: Set<string> = new Set<string>() filePaths: string[]
): string[]{
filePaths.forEach((fileName) => {
try { const fullPathSet: Set<string> = new Set<string>()
if (fs.lstatSync(fileName).isDirectory()) {
recurisveManifestGetter(fileName).forEach((file) => { filePaths.forEach((fileName => {
fullPathSet.add(file) try {
}) if(fs.lstatSync(fileName).isDirectory()){
} else if ( recurisveManifestGetter(fileName).forEach((file) => {fullPathSet.add(file)})
getFileExtension(fileName) === 'yml' || } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
getFileExtension(fileName) === 'yaml' fullPathSet.add(fileName)
) { } else{
fullPathSet.add(fileName) core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
} else { }
core.debug( } catch (ex) {
`Detected non-manifest file, ${fileName}, continuing... ` throw Error(
) `Exception occurred while reading the file ${fileName}: ${ex}`
} );
} catch (ex) { }
throw Error( }))
`Exception occurred while reading the file ${fileName}: ${ex}`
) return Array.from(fullPathSet)
} }
})
function recurisveManifestGetter(dirName: string): string[]{
return Array.from(fullPathSet) const toRet: string[] = []
}
fs.readdirSync(dirName).forEach((fileName) => {
function recurisveManifestGetter(dirName: string): string[] { const fnwd: string = path.join(dirName, fileName)
const toRet: string[] = [] if(fs.lstatSync(fnwd).isDirectory()){
toRet.push(...recurisveManifestGetter(fnwd))
fs.readdirSync(dirName).forEach((fileName) => { } else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
const fnwd: string = path.join(dirName, fileName) toRet.push(path.join(dirName, fileName))
if (fs.lstatSync(fnwd).isDirectory()) { } else{
toRet.push(...recurisveManifestGetter(fnwd)) core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
} else if ( }
getFileExtension(fileName) === 'yml' || })
getFileExtension(fileName) === 'yaml'
) { return toRet
toRet.push(path.join(dirName, fileName)) }
} else {
core.debug(`Detected non-manifest file, ${fileName}, continuing... `) function getFileExtension(fileName: string){
} return fileName.slice((fileName.lastIndexOf(".") - 1 >>> 0) + 2)
}) }
return toRet
}
function getFileExtension(fileName: string) {
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
}
+40 -40
View File
@@ -1,48 +1,48 @@
import { import {
getNormalizedPath, getNormalizedPath,
isHttpUrl, isHttpUrl,
normalizeWorkflowStrLabel normalizeWorkflowStrLabel,
} from './githubUtils' } from "./githubUtils";
describe('Github utils', () => { describe("Github utils", () => {
it('normalizes workflow string labels', () => { it("normalizes workflow string labels", () => {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
const path = 'test/path/test' const path = "test/path/test";
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path) expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path);
expect(normalizeWorkflowStrLabel(path)).toBe(path) expect(normalizeWorkflowStrLabel(path)).toBe(path);
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe( expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
path + workflowsPath path + workflowsPath
) );
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe( expect(normalizeWorkflowStrLabel(path + " " + path)).toBe(
path + '_' + path path + "_" + path
) );
}) });
it('normalizes path', () => { it("normalizes path", () => {
const httpUrl = 'http://www.test.com' const httpUrl = "http://www.test.com";
expect(getNormalizedPath(httpUrl)).toBe(httpUrl) expect(getNormalizedPath(httpUrl)).toBe(httpUrl);
const httpsUrl = 'https://www.test.com' const httpsUrl = "https://www.test.com";
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl) expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl);
const repo = 'gh_repo' const repo = "gh_repo";
const sha = 'gh_sha' const sha = "gh_sha";
const path = 'path' const path = "path";
process.env.GITHUB_REPOSITORY = repo process.env.GITHUB_REPOSITORY = repo;
process.env.GITHUB_SHA = sha process.env.GITHUB_SHA = sha;
expect(getNormalizedPath(path)).toBe( expect(getNormalizedPath(path)).toBe(
`https://github.com/${repo}/blob/${sha}/${path}` `https://github.com/${repo}/blob/${sha}/${path}`
) );
}) });
it('checks if url is http', () => { it("checks if url is http", () => {
expect(isHttpUrl('www.test.com')).toBe(false) expect(isHttpUrl("www.test.com")).toBe(false);
expect(isHttpUrl('http.test.com')).toBe(false) expect(isHttpUrl("http.test.com")).toBe(false);
expect(isHttpUrl('http:.test.com')).toBe(false) expect(isHttpUrl("http:.test.com")).toBe(false);
expect(isHttpUrl('http:/.test.com')).toBe(false) expect(isHttpUrl("http:/.test.com")).toBe(false);
expect(isHttpUrl('https://www.test.com')).toBe(true) expect(isHttpUrl("https://www.test.com")).toBe(true);
expect(isHttpUrl('http://wwww.test.com')).toBe(true) expect(isHttpUrl("http://wwww.test.com")).toBe(true);
}) });
}) });
+39 -39
View File
@@ -1,54 +1,54 @@
import {GitHubClient, OkStatusCode} from '../types/githubClient' import { GitHubClient, OkStatusCode } from "../types/githubClient";
import * as core from '@actions/core' import * as core from "@actions/core";
export async function getWorkflowFilePath( export async function getWorkflowFilePath(
githubToken: string githubToken: string
): Promise<string> { ): Promise<string> {
let workflowFilePath = process.env.GITHUB_WORKFLOW let workflowFilePath = process.env.GITHUB_WORKFLOW;
if (!workflowFilePath.startsWith('.github/workflows/')) { if (!workflowFilePath.startsWith(".github/workflows/")) {
const githubClient = new GitHubClient( const githubClient = new GitHubClient(
process.env.GITHUB_REPOSITORY, process.env.GITHUB_REPOSITORY,
githubToken githubToken
) );
const response = await githubClient.getWorkflows() const response = await githubClient.getWorkflows();
if (response) { if (response) {
if (response.status === OkStatusCode && response.data.total_count) { if (response.status === OkStatusCode && response.data.total_count) {
if (response.data.total_count > 0) { if (response.data.total_count > 0) {
for (const workflow of response.data.workflows) { for (const workflow of response.data.workflows) {
if (process.env.GITHUB_WORKFLOW === workflow.name) { if (process.env.GITHUB_WORKFLOW === workflow.name) {
workflowFilePath = workflow.path workflowFilePath = workflow.path;
break break;
}
}
} }
} else if (response.status != OkStatusCode) { }
core.error( }
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}` } 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`)
} }
} } else {
return Promise.resolve(workflowFilePath) core.error(`Failed to get response from workflow list API`);
}
}
return Promise.resolve(workflowFilePath);
} }
export function normalizeWorkflowStrLabel(workflowName: string): string { export function normalizeWorkflowStrLabel(workflowName: string): string {
const workflowsPath = '.github/workflows/' const workflowsPath = ".github/workflows/";
workflowName = workflowName.startsWith(workflowsPath) workflowName = workflowName.startsWith(workflowsPath)
? workflowName.replace(workflowsPath, '') ? workflowName.replace(workflowsPath, "")
: workflowName : workflowName;
return workflowName.replace(/ /g, '_') return workflowName.replace(/ /g, "_");
} }
export function getNormalizedPath(pathValue: string) { export function getNormalizedPath(pathValue: string) {
if (!isHttpUrl(pathValue)) { if (!isHttpUrl(pathValue)) {
//if it is not an http url then convert to link from current repo and commit //if it is not an http url then convert to link from current repo and commit
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}` return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`;
} }
return pathValue return pathValue;
} }
export function isHttpUrl(url: string) { export function isHttpUrl(url: string) {
return /^https?:\/\/.*$/.test(url) return /^https?:\/\/.*$/.test(url);
} }
+54 -54
View File
@@ -1,61 +1,61 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
describe('Kubectl utils', () => { describe("Kubectl utils", () => {
it('checks for errors', () => { it("checks for errors", () => {
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0} const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 };
const successWithStderr: ExecOutput = { const successWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 0 exitCode: 0,
} };
const failWithExitCode: ExecOutput = { const failWithExitCode: ExecOutput = {
stderr: '', stderr: "",
stdout: '', stdout: "",
exitCode: 1 exitCode: 1,
} };
const failWithExitWithStderr: ExecOutput = { const failWithExitWithStderr: ExecOutput = {
stderr: 'error', stderr: "error",
stdout: '', stdout: "",
exitCode: 2 exitCode: 2,
} };
// with throw behavior // with throw behavior
expect(() => checkForErrors([success])).not.toThrow() expect(() => checkForErrors([success])).not.toThrow();
expect(() => checkForErrors([successWithStderr])).not.toThrow() expect(() => checkForErrors([successWithStderr])).not.toThrow();
expect(() => checkForErrors([success, successWithStderr])).not.toThrow() expect(() => checkForErrors([success, successWithStderr])).not.toThrow();
expect(() => checkForErrors([failWithExitCode])).toThrow() expect(() => checkForErrors([failWithExitCode])).toThrow();
expect(() => checkForErrors([failWithExitWithStderr])).toThrow() expect(() => checkForErrors([failWithExitWithStderr])).toThrow();
expect(() => checkForErrors([success, failWithExitCode])).toThrow() expect(() => checkForErrors([success, failWithExitCode])).toThrow();
expect(() => expect(() =>
checkForErrors([successWithStderr, failWithExitCode]) checkForErrors([successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitCode]) checkForErrors([success, successWithStderr, failWithExitCode])
).toThrow() ).toThrow();
expect(() => expect(() =>
checkForErrors([success, successWithStderr, failWithExitWithStderr]) checkForErrors([success, successWithStderr, failWithExitWithStderr])
).toThrow() ).toThrow();
// with warn behavior // with warn behavior
jest.spyOn(core, 'warning').mockImplementation(() => {}) jest.spyOn(core, "warning").mockImplementation(() => {});
let warningCalls = 0 let warningCalls = 0;
expect(() => checkForErrors([success], true)).not.toThrow() expect(() => checkForErrors([success], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(warningCalls) expect(core.warning).toBeCalledTimes(warningCalls);
expect(() => checkForErrors([successWithStderr], true)).not.toThrow() expect(() => checkForErrors([successWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => expect(() =>
checkForErrors([success, successWithStderr], true) checkForErrors([success, successWithStderr], true)
).not.toThrow() ).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow() expect(() => checkForErrors([failWithExitCode], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow() expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow();
expect(core.warning).toBeCalledTimes(++warningCalls) expect(core.warning).toBeCalledTimes(++warningCalls);
}) });
}) });
+66 -70
View File
@@ -1,86 +1,82 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import {ExecOutput} from '@actions/exec' import { ExecOutput } from "@actions/exec";
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
export function checkForErrors( export function checkForErrors(
execResults: ExecOutput[], execResults: ExecOutput[],
warnIfError?: boolean warnIfError?: boolean
) { ) {
let stderr = '' let stderr = "";
execResults.forEach((result) => { execResults.forEach((result) => {
if (result?.exitCode !== 0) { if (result?.exitCode !== 0) {
stderr += result?.stderr + ' \n' stderr += result?.stderr + " \n";
} else if (result?.stderr) { } else if (result?.stderr) {
core.warning(result.stderr) core.warning(result.stderr);
} }
}) });
if (stderr.length > 0) { if (stderr.length > 0) {
if (warnIfError) { if (warnIfError) {
core.warning(stderr.trim()) core.warning(stderr.trim());
} else { } else {
throw new Error(stderr.trim()) throw new Error(stderr.trim());
} }
} }
} }
export async function getLastSuccessfulRunSha( export async function getLastSuccessfulRunSha(
kubectl: Kubectl, kubectl: Kubectl,
namespaceName: string, namespaceName: string,
annotationKey: string annotationKey: string
): Promise<string> { ): Promise<string> {
try { try {
const result = await kubectl.getResource('namespace', namespaceName) const result = await kubectl.getResource("namespace", namespaceName);
if (result?.stderr) { if (result?.stderr) {
core.warning(result.stderr) core.warning(result.stderr);
return process.env.GITHUB_SHA return process.env.GITHUB_SHA;
} else if (result?.stdout) { } else if (result?.stdout) {
const annotationsSet = JSON.parse(result.stdout).metadata.annotations const annotationsSet = JSON.parse(result.stdout).metadata.annotations;
if (annotationsSet && annotationsSet[annotationKey]) { if (annotationsSet && annotationsSet[annotationKey]) {
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"')) return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
.commit .commit;
} else { } else {
return 'NA' return "NA";
}
} }
} catch (ex) { }
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`) } catch (ex) {
return '' core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`);
} return "";
}
} }
export async function annotateChildPods( export async function annotateChildPods(
kubectl: Kubectl, kubectl: Kubectl,
resourceType: string, resourceType: string,
resourceName: string, resourceName: string,
annotationKeyValStr: string, annotationKeyValStr: string,
allPods allPods
): Promise<ExecOutput[]> { ): Promise<ExecOutput[]> {
let owner = resourceName let owner = resourceName;
if (resourceType.toLowerCase().indexOf('deployment') > -1) { if (resourceType.toLowerCase().indexOf("deployment") > -1) {
owner = await kubectl.getNewReplicaSet(resourceName) owner = await kubectl.getNewReplicaSet(resourceName);
} }
const commandExecutionResults = [] const commandExecutionResults = [];
if (allPods?.items && allPods.items?.length > 0) { if (allPods?.items && allPods.items?.length > 0) {
allPods.items.forEach((pod) => { allPods.items.forEach((pod) => {
const owners = pod?.metadata?.ownerReferences const owners = pod?.metadata?.ownerReferences;
if (owners) { if (owners) {
for (const ownerRef of owners) { for (const ownerRef of owners) {
if (ownerRef.name === owner) { if (ownerRef.name === owner) {
commandExecutionResults.push( commandExecutionResults.push(
kubectl.annotate( kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr)
'pod', );
pod.metadata.name, break;
annotationKeyValStr }
) }
) }
break });
} }
}
}
})
}
return await Promise.all(commandExecutionResults) return await Promise.all(commandExecutionResults);
} }
+31 -35
View File
@@ -1,48 +1,44 @@
import {KubernetesWorkload} from '../types/kubernetesTypes' import { KubernetesWorkload } from "../types/kubernetesTypes";
export function getImagePullSecrets(inputObject: any) { export function getImagePullSecrets(inputObject: any) {
if (!inputObject?.spec) return null if (!inputObject?.spec) return null;
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase() )
) return inputObject?.spec?.jobTemplate?.spec?.template?.spec
return inputObject?.spec?.jobTemplate?.spec?.template?.spec ?.imagePullSecrets;
?.imagePullSecrets
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.spec.imagePullSecrets return inputObject.spec.imagePullSecrets;
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
return inputObject.spec.template.spec.imagePullSecrets return inputObject.spec.template.spec.imagePullSecrets;
} }
} }
export function setImagePullSecrets( export function setImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: any newImagePullSecrets: any
) { ) {
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return if (!inputObject || !inputObject.spec || !newImagePullSecrets) return;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.spec.imagePullSecrets = newImagePullSecrets;
) { return;
inputObject.spec.imagePullSecrets = newImagePullSecrets }
return
}
if ( if (
inputObject.kind.toLowerCase() === inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
KubernetesWorkload.CRON_JOB.toLowerCase() ) {
) { if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec) inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets = newImagePullSecrets;
newImagePullSecrets return;
return }
}
if (inputObject?.spec?.template?.spec) { if (inputObject?.spec?.template?.spec) {
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
return return;
} }
} }
+45 -47
View File
@@ -1,73 +1,71 @@
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
isServiceEntity, isServiceEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
export function updateSpecLabels( export function updateSpecLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean override: boolean
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) throw InputObjectKindNotDefinedError if (!inputObject.kind) throw InputObjectKindNotDefinedError;
if (!newLabels) return if (!newLabels) return;
let existingLabels = getSpecLabels(inputObject) let existingLabels = getSpecLabels(inputObject);
if (override) { if (override) {
existingLabels = newLabels existingLabels = newLabels;
} else { } else {
existingLabels = existingLabels || new Map<string, string>() existingLabels = existingLabels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
} }
setSpecLabels(inputObject, existingLabels) setSpecLabels(inputObject, existingLabels);
} }
function getSpecLabels(inputObject: any) { function getSpecLabels(inputObject: any) {
if (!inputObject) return null if (!inputObject) return null;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
return inputObject.metadata.labels return inputObject.metadata.labels;
if (inputObject?.spec?.template?.metadata) if (inputObject?.spec?.template?.metadata)
return inputObject.spec.template.metadata.labels return inputObject.spec.template.metadata.labels;
return null return null;
} }
function setSpecLabels(inputObject: any, newLabels: any) { function setSpecLabels(inputObject: any, newLabels: any) {
if (!inputObject || !newLabels) return null if (!inputObject || !newLabels) return null;
if ( if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase() inputObject.metadata.labels = newLabels;
) { return;
inputObject.metadata.labels = newLabels }
return
}
if (inputObject?.spec?.template?.metatada) { if (inputObject?.spec?.template?.metatada) {
inputObject.spec.template.metatada.labels = newLabels inputObject.spec.template.metatada.labels = newLabels;
return return;
} }
} }
export function getSpecSelectorLabels(inputObject: any) { export function getSpecSelectorLabels(inputObject: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector;
else return inputObject.spec.selector.matchLabels else return inputObject.spec.selector.matchLabels;
} }
} }
export function setSpecSelectorLabels(inputObject: any, newLabels: any) { export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
if (inputObject?.spec?.selector) { if (inputObject?.spec?.selector) {
if (isServiceEntity(inputObject.kind)) if (isServiceEntity(inputObject.kind))
inputObject.spec.selector = newLabels inputObject.spec.selector = newLabels;
else inputObject.spec.selector.matchLabels = newLabels else inputObject.spec.selector.matchLabels = newLabels;
} }
} }
+184 -189
View File
@@ -1,189 +1,184 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as KubernetesConstants from '../types/kubernetesTypes' import * as KubernetesConstants from "../types/kubernetesTypes";
import {Kubectl, Resource} from '../types/kubectl' import { Kubectl, Resource } from "../types/kubectl";
import {checkForErrors} from './kubectlUtils' import { checkForErrors } from "./kubectlUtils";
import {sleep} from './timeUtils' import { sleep } from "./timeUtils";
export async function checkManifestStability( export async function checkManifestStability(
kubectl: Kubectl, kubectl: Kubectl,
resources: Resource[] resources: Resource[]
): Promise<void> { ): Promise<void> {
let rolloutStatusHasErrors = false let rolloutStatusHasErrors = false;
for (let i = 0; i < resources.length; i++) { for (let i = 0; i < resources.length; i++) {
const resource = resources[i] const resource = resources[i];
if ( if (
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf( KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
resource.type.toLowerCase() resource.type.toLowerCase()
) >= 0 ) >= 0
) { ) {
try { try {
const result = await kubectl.checkRolloutStatus( const result = await kubectl.checkRolloutStatus(
resource.type, resource.type,
resource.name resource.name
) );
checkForErrors([result]) checkForErrors([result]);
} catch (ex) { } catch (ex) {
core.error(ex) core.error(ex);
await kubectl.describe(resource.type, resource.name) await kubectl.describe(resource.type, resource.name);
rolloutStatusHasErrors = true rolloutStatusHasErrors = true;
} }
} }
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) { if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
try { try {
await checkPodStatus(kubectl, resource.name) await checkPodStatus(kubectl, resource.name);
} catch (ex) { } catch (ex) {
core.warning( core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`);
`Could not determine pod status: ${JSON.stringify(ex)}` await kubectl.describe(resource.type, resource.name);
) }
await kubectl.describe(resource.type, resource.name) }
} if (
} resource.type ==
if ( KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
resource.type == ) {
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE try {
) { const service = await getService(kubectl, resource.name);
try { const { spec, status } = service;
const service = await getService(kubectl, resource.name) if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
const {spec, status} = service if (!isLoadBalancerIPAssigned(status)) {
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) { await waitForServiceExternalIPAssignment(kubectl, resource.name);
if (!isLoadBalancerIPAssigned(status)) { } else {
await waitForServiceExternalIPAssignment( core.info(
kubectl, `ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
resource.name );
) }
} else { }
core.info( } catch (ex) {
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}` core.warning(
) `Could not determine service status of: ${resource.name} Error: ${ex}`
} );
} await kubectl.describe(resource.type, resource.name);
} catch (ex) { }
core.warning( }
`Could not determine service status of: ${resource.name} Error: ${ex}` }
)
await kubectl.describe(resource.type, resource.name) if (rolloutStatusHasErrors) {
} throw new Error("Rollout status error");
} }
} }
if (rolloutStatusHasErrors) { export async function checkPodStatus(
throw new Error('Rollout status error') kubectl: Kubectl,
} podName: string
} ): Promise<void> {
const sleepTimeout = 10 * 1000; // 10 seconds
export async function checkPodStatus( const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout
kubectl: Kubectl,
podName: string let podStatus;
): Promise<void> { let kubectlDescribeNeeded = false;
const sleepTimeout = 10 * 1000 // 10 seconds for (let i = 0; i < iterations; i++) {
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout await sleep(sleepTimeout);
let podStatus core.debug(`Polling for pod status: ${podName}`);
let kubectlDescribeNeeded = false podStatus = await getPodStatus(kubectl, podName);
for (let i = 0; i < iterations; i++) {
await sleep(sleepTimeout) if (
podStatus &&
core.debug(`Polling for pod status: ${podName}`) podStatus?.phase !== "Pending" &&
podStatus = await getPodStatus(kubectl, podName) podStatus?.phase !== "Unknown"
) {
if ( break;
podStatus && }
podStatus?.phase !== 'Pending' && }
podStatus?.phase !== 'Unknown'
) { podStatus = await getPodStatus(kubectl, podName);
break switch (podStatus.phase) {
} case "Succeeded":
} case "Running":
if (isPodReady(podStatus)) {
podStatus = await getPodStatus(kubectl, podName) console.log(`pod/${podName} is successfully rolled out`);
switch (podStatus.phase) { } else {
case 'Succeeded': kubectlDescribeNeeded = true;
case 'Running': }
if (isPodReady(podStatus)) { break;
console.log(`pod/${podName} is successfully rolled out`) case "Pending":
} else { if (!isPodReady(podStatus)) {
kubectlDescribeNeeded = true core.warning(`pod/${podName} rollout status check timed out`);
} kubectlDescribeNeeded = true;
break }
case 'Pending': break;
if (!isPodReady(podStatus)) { case "Failed":
core.warning(`pod/${podName} rollout status check timed out`) core.error(`pod/${podName} rollout failed`);
kubectlDescribeNeeded = true kubectlDescribeNeeded = true;
} break;
break default:
case 'Failed': core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
core.error(`pod/${podName} rollout failed`) }
kubectlDescribeNeeded = true
break if (kubectlDescribeNeeded) {
default: await kubectl.describe("pod", podName);
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`) }
} }
if (kubectlDescribeNeeded) { async function getPodStatus(kubectl: Kubectl, podName: string) {
await kubectl.describe('pod', podName) const podResult = await kubectl.getResource("pod", podName);
} checkForErrors([podResult]);
}
return JSON.parse(podResult.stdout).status;
async function getPodStatus(kubectl: Kubectl, podName: string) { }
const podResult = await kubectl.getResource('pod', podName)
checkForErrors([podResult]) function isPodReady(podStatus: any): boolean {
let allContainersAreReady = true;
return JSON.parse(podResult.stdout).status podStatus.containerStatuses.forEach((container) => {
} if (container.ready === false) {
core.info(
function isPodReady(podStatus: any): boolean { `'${container.name}' status: ${JSON.stringify(container.state)}`
let allContainersAreReady = true );
podStatus.containerStatuses.forEach((container) => { allContainersAreReady = false;
if (container.ready === false) { }
core.info( });
`'${container.name}' status: ${JSON.stringify(container.state)}`
) if (!allContainersAreReady) {
allContainersAreReady = false core.warning("All containers not in ready state");
} }
})
return allContainersAreReady;
if (!allContainersAreReady) { }
core.warning('All containers not in ready state')
} async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource(
return allContainersAreReady KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
} serviceName
);
async function getService(kubectl: Kubectl, serviceName) {
const serviceResult = await kubectl.getResource( checkForErrors([serviceResult]);
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE, return JSON.parse(serviceResult.stdout);
serviceName }
)
async function waitForServiceExternalIPAssignment(
checkForErrors([serviceResult]) kubectl: Kubectl,
return JSON.parse(serviceResult.stdout) serviceName: string
} ): Promise<void> {
const sleepTimeout = 10 * 1000; // 10 seconds
async function waitForServiceExternalIPAssignment( const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout
kubectl: Kubectl,
serviceName: string for (let i = 0; i < iterations; i++) {
): Promise<void> { core.info(`Wait for service ip assignment : ${serviceName}`);
const sleepTimeout = 10 * 1000 // 10 seconds await sleep(sleepTimeout);
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
const status = (await getService(kubectl, serviceName)).status;
for (let i = 0; i < iterations; i++) { if (isLoadBalancerIPAssigned(status)) {
core.info(`Wait for service ip assignment : ${serviceName}`) core.info(
await sleep(sleepTimeout) `ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
);
const status = (await getService(kubectl, serviceName)).status return;
if (isLoadBalancerIPAssigned(status)) { }
core.info( }
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
) core.warning(`Wait for service ip assignment timed out${serviceName}`);
return }
}
} function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0;
core.warning(`Wait for service ip assignment timed out${serviceName}`) }
}
function isLoadBalancerIPAssigned(status: any) {
return status?.loadBalancer?.ingress?.length > 0
}
+310 -313
View File
@@ -1,313 +1,310 @@
import * as core from '@actions/core' import * as core from "@actions/core";
import * as fs from 'fs' import * as fs from "fs";
import * as yaml from 'js-yaml' import * as yaml from "js-yaml";
import * as path from 'path' import * as path from "path";
import * as fileHelper from './fileUtils' import * as fileHelper from "./fileUtils";
import {getTempDirectory} from './fileUtils' import { getTempDirectory } from "./fileUtils";
import { import {
InputObjectKindNotDefinedError, InputObjectKindNotDefinedError,
InputObjectMetadataNotDefinedError, InputObjectMetadataNotDefinedError,
isWorkloadEntity, isWorkloadEntity,
KubernetesWorkload, KubernetesWorkload,
NullInputObjectError NullInputObjectError,
} from '../types/kubernetesTypes' } from "../types/kubernetesTypes";
import { import {
getSpecSelectorLabels, getSpecSelectorLabels,
setSpecSelectorLabels setSpecSelectorLabels,
} from './manifestSpecLabelUtils' } from "./manifestSpecLabelUtils";
import { import {
getImagePullSecrets, getImagePullSecrets,
setImagePullSecrets setImagePullSecrets,
} from './manifestPullSecretUtils' } from "./manifestPullSecretUtils";
import {Resource} from '../types/kubectl' import { Resource } from "../types/kubectl";
export function updateManifestFiles(manifestFilePaths: string[]) { export function updateManifestFiles(manifestFilePaths: string[]) {
if (manifestFilePaths?.length === 0) { if (manifestFilePaths?.length === 0) {
throw new Error('Manifest files not provided') throw new Error("Manifest files not provided");
} }
// update container images // update container images
const containers: string[] = core.getInput('images').split('\n') const containers: string[] = core.getInput("images").split("\n");
const manifestFiles = updateContainerImagesInManifestFiles( const manifestFiles = updateContainerImagesInManifestFiles(
manifestFilePaths, manifestFilePaths,
containers containers
) );
// update pull secrets // update pull secrets
const imagePullSecrets: string[] = core const imagePullSecrets: string[] = core
.getInput('imagepullsecrets') .getInput("imagepullsecrets")
.split('\n') .split("\n")
.filter((secret) => secret.trim().length > 0) .filter((secret) => secret.trim().length > 0);
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets) return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets);
} }
export function UnsetClusterSpecificDetails(resource: any) { export function UnsetClusterSpecificDetails(resource: any) {
if (!resource) { if (!resource) {
return return;
} }
// Unset cluster specific details in the object // Unset cluster specific details in the object
if (!!resource) { if (!!resource) {
const {metadata, status} = resource const { metadata, status } = resource;
if (!!metadata) { if (!!metadata) {
resource.metadata = { resource.metadata = {
annotations: metadata.annotations, annotations: metadata.annotations,
labels: metadata.labels, labels: metadata.labels,
name: metadata.name name: metadata.name,
} };
} }
if (!!status) { if (!!status) {
resource.status = {} resource.status = {};
} }
} }
} }
function updateContainerImagesInManifestFiles( function updateContainerImagesInManifestFiles(
filePaths: string[], filePaths: string[],
containers: string[] containers: string[]
): string[] { ): string[] {
if (filePaths?.length <= 0) return filePaths if (filePaths?.length <= 0) return filePaths;
const newFilePaths = [] const newFilePaths = [];
// update container images // update container images
filePaths.forEach((filePath: string) => { filePaths.forEach((filePath: string) => {
let contents = fs.readFileSync(filePath).toString() let contents = fs.readFileSync(filePath).toString();
containers.forEach((container: string) => { containers.forEach((container: string) => {
let [imageName] = container.split(':') let [imageName] = container.split(":");
if (imageName.indexOf('@') > 0) { if (imageName.indexOf("@") > 0) {
imageName = imageName.split('@')[0] imageName = imageName.split("@")[0];
} }
if (contents.indexOf(imageName) > 0) if (contents.indexOf(imageName) > 0)
contents = substituteImageNameInSpecFile( contents = substituteImageNameInSpecFile(
contents, contents,
imageName, imageName,
container container
) );
}) });
// write updated files // write updated files
const tempDirectory = getTempDirectory() const tempDirectory = getTempDirectory();
const fileName = path.join(tempDirectory, path.basename(filePath)) const fileName = path.join(tempDirectory, path.basename(filePath));
fs.writeFileSync(path.join(fileName), contents) fs.writeFileSync(path.join(fileName), contents);
newFilePaths.push(fileName) newFilePaths.push(fileName);
}) });
return newFilePaths return newFilePaths;
} }
/* /*
Example: Example:
Input of Input of
currentString: `image: "example/example-image"` currentString: `image: "example/example-image"`
imageName: `example/example-image` imageName: `example/example-image`
imageNameWithNewTag: `example/example-image:identifiertag` imageNameWithNewTag: `example/example-image:identifiertag`
would return would return
`image: "example/example-image:identifiertag"` `image: "example/example-image:identifiertag"`
*/ */
export function substituteImageNameInSpecFile( export function substituteImageNameInSpecFile(
spec: string, spec: string,
imageName: string, imageName: string,
imageNameWithNewTag: string imageNameWithNewTag: string
) { ) {
if (spec.indexOf(imageName) < 0) return spec if (spec.indexOf(imageName) < 0) return spec;
return spec.split('\n').reduce((acc, line) => { return spec.split("\n").reduce((acc, line) => {
const imageKeyword = line.match(/^ *-? *image:/) const imageKeyword = line.match(/^ *-? *image:/);
if (imageKeyword) { if (imageKeyword) {
let [currentImageName] = line let [currentImageName] = line
.substring(imageKeyword[0].length) // consume the line from keyword onwards .substring(imageKeyword[0].length) // consume the line from keyword onwards
.trim() .trim()
.replace(/[',"]/g, '') // replace allowed quotes with nothing .replace(/[',"]/g, "") // replace allowed quotes with nothing
.split(':') .split(":");
if (currentImageName?.indexOf(' ') > 0) { if (currentImageName?.indexOf(" ") > 0) {
currentImageName = currentImageName.split(' ')[0] // remove comments currentImageName = currentImageName.split(" ")[0]; // remove comments
} }
if (currentImageName === imageName) { if (currentImageName === imageName) {
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n` return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
} }
} }
return acc + line + '\n' return acc + line + "\n";
}, '') }, "");
} }
export function getReplicaCount(inputObject: any): any { export function getReplicaCount(inputObject: any): any {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.kind) { if (!inputObject.kind) {
throw InputObjectKindNotDefinedError throw InputObjectKindNotDefinedError;
} }
const {kind} = inputObject const { kind } = inputObject;
if ( if (
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() && kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
) )
return inputObject.spec.replicas return inputObject.spec.replicas;
return 0 return 0;
} }
export function updateObjectLabels( export function updateObjectLabels(
inputObject: any, inputObject: any,
newLabels: Map<string, string>, newLabels: Map<string, string>,
override: boolean = false override: boolean = false
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
if (!newLabels) return if (!newLabels) return;
if (override) { if (override) {
inputObject.metadata.labels = newLabels inputObject.metadata.labels = newLabels;
} else { } else {
let existingLabels = let existingLabels =
inputObject.metadata.labels || new Map<string, string>() inputObject.metadata.labels || new Map<string, string>();
Object.keys(newLabels).forEach( Object.keys(newLabels).forEach(
(key) => (existingLabels[key] = newLabels[key]) (key) => (existingLabels[key] = newLabels[key])
) );
inputObject.metadata.labels = existingLabels inputObject.metadata.labels = existingLabels;
} }
} }
export function updateObjectAnnotations( export function updateObjectAnnotations(
inputObject: any, inputObject: any,
newAnnotations: Map<string, string>, newAnnotations: Map<string, string>,
override: boolean = false override: boolean = false
) { ) {
if (!inputObject) throw NullInputObjectError if (!inputObject) throw NullInputObjectError;
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
if (!newAnnotations) return if (!newAnnotations) return;
if (override) { if (override) {
inputObject.metadata.annotations = newAnnotations inputObject.metadata.annotations = newAnnotations;
} else { } else {
const existingAnnotations = const existingAnnotations =
inputObject.metadata.annotations || new Map<string, string>() inputObject.metadata.annotations || new Map<string, string>();
Object.keys(newAnnotations).forEach( Object.keys(newAnnotations).forEach(
(key) => (existingAnnotations[key] = newAnnotations[key]) (key) => (existingAnnotations[key] = newAnnotations[key])
) );
inputObject.metadata.annotations = existingAnnotations inputObject.metadata.annotations = existingAnnotations;
} }
} }
export function updateImagePullSecrets( export function updateImagePullSecrets(
inputObject: any, inputObject: any,
newImagePullSecrets: string[], newImagePullSecrets: string[],
override: boolean = false override: boolean = false
) { ) {
if (!inputObject?.spec || !newImagePullSecrets) return if (!inputObject?.spec || !newImagePullSecrets) return;
const newImagePullSecretsObjects = Array.from( const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => {
newImagePullSecrets, return { name };
(name) => { });
return {name} let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
}
) if (override) {
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject) existingImagePullSecretObjects = newImagePullSecretsObjects;
} else {
if (override) { existingImagePullSecretObjects = existingImagePullSecretObjects || [];
existingImagePullSecretObjects = newImagePullSecretsObjects
} else { existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
existingImagePullSecretObjects = existingImagePullSecretObjects || [] newImagePullSecretsObjects
);
existingImagePullSecretObjects = existingImagePullSecretObjects.concat( }
newImagePullSecretsObjects
) setImagePullSecrets(inputObject, existingImagePullSecretObjects);
} }
setImagePullSecrets(inputObject, existingImagePullSecretObjects) export function updateSelectorLabels(
} inputObject: any,
newLabels: Map<string, string>,
export function updateSelectorLabels( override: boolean
inputObject: any, ) {
newLabels: Map<string, string>, if (!inputObject) throw NullInputObjectError;
override: boolean
) { if (!inputObject.kind) throw InputObjectKindNotDefinedError;
if (!inputObject) throw NullInputObjectError
if (!newLabels) return;
if (!inputObject.kind) throw InputObjectKindNotDefinedError
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
if (!newLabels) return return;
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) let existingLabels = getSpecSelectorLabels(inputObject);
return if (override) {
existingLabels = newLabels;
let existingLabels = getSpecSelectorLabels(inputObject) } else {
if (override) { existingLabels = existingLabels || new Map<string, string>();
existingLabels = newLabels Object.keys(newLabels).forEach(
} else { (key) => (existingLabels[key] = newLabels[key])
existingLabels = existingLabels || new Map<string, string>() );
Object.keys(newLabels).forEach( }
(key) => (existingLabels[key] = newLabels[key])
) setSpecSelectorLabels(inputObject, existingLabels);
} }
setSpecSelectorLabels(inputObject, existingLabels) export function getResources(
} filePaths: string[],
filterResourceTypes: string[]
export function getResources( ): Resource[] {
filePaths: string[], if (!filePaths) return [];
filterResourceTypes: string[]
): Resource[] { const resources: Resource[] = [];
if (!filePaths) return [] filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString();
const resources: Resource[] = [] yaml.safeLoadAll(fileContents, (inputObject) => {
filePaths.forEach((filePath: string) => { const inputObjectKind = inputObject?.kind || "";
const fileContents = fs.readFileSync(filePath).toString() if (
yaml.safeLoadAll(fileContents, (inputObject) => { filterResourceTypes.filter(
const inputObjectKind = inputObject?.kind || '' (type) => inputObjectKind.toLowerCase() === type.toLowerCase()
if ( ).length > 0
filterResourceTypes.filter( ) {
(type) => inputObjectKind.toLowerCase() === type.toLowerCase() resources.push({
).length > 0 type: inputObject.kind,
) { name: inputObject.metadata.name,
resources.push({ });
type: inputObject.kind, }
name: inputObject.metadata.name });
}) });
}
}) return resources;
}) }
return resources function updateImagePullSecretsInManifestFiles(
} filePaths: string[],
imagePullSecrets: string[]
function updateImagePullSecretsInManifestFiles( ): string[] {
filePaths: string[], if (imagePullSecrets?.length <= 0) return filePaths;
imagePullSecrets: string[]
): string[] { const newObjectsList = [];
if (imagePullSecrets?.length <= 0) return filePaths filePaths.forEach((filePath: string) => {
const fileContents = fs.readFileSync(filePath).toString();
const newObjectsList = [] yaml.safeLoadAll(fileContents, (inputObject: any) => {
filePaths.forEach((filePath: string) => { if (inputObject?.kind) {
const fileContents = fs.readFileSync(filePath).toString() const { kind } = inputObject;
yaml.safeLoadAll(fileContents, (inputObject: any) => { if (isWorkloadEntity(kind)) {
if (inputObject?.kind) { updateImagePullSecrets(inputObject, imagePullSecrets);
const {kind} = inputObject }
if (isWorkloadEntity(kind)) { newObjectsList.push(inputObject);
updateImagePullSecrets(inputObject, imagePullSecrets) }
} });
newObjectsList.push(inputObject) });
}
}) return fileHelper.writeObjectsToFile(newObjectsList);
}) }
return fileHelper.writeObjectsToFile(newObjectsList)
}
+2 -2
View File
@@ -1,7 +1,7 @@
export function sleep(timeout: number) { export function sleep(timeout: number) {
return new Promise((resolve) => setTimeout(resolve, timeout)) return new Promise((resolve) => setTimeout(resolve, timeout));
} }
export function getCurrentTime(): number { export function getCurrentTime(): number {
return new Date().getTime() return new Date().getTime();
} }
+11 -11
View File
@@ -1,18 +1,18 @@
import {Kubectl} from '../types/kubectl' import { Kubectl } from "../types/kubectl";
const trafficSplitAPIVersionPrefix = 'split.smi-spec.io' const trafficSplitAPIVersionPrefix = "split.smi-spec.io";
export async function getTrafficSplitAPIVersion( export async function getTrafficSplitAPIVersion(
kubectl: Kubectl kubectl: Kubectl
): Promise<string> { ): Promise<string> {
const result = await kubectl.executeCommand('api-versions') const result = await kubectl.executeCommand("api-versions");
const trafficSplitAPIVersion = result.stdout const trafficSplitAPIVersion = result.stdout
.split('\n') .split("\n")
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix)) .find((version) => version.startsWith(trafficSplitAPIVersionPrefix));
if (!trafficSplitAPIVersion) { if (!trafficSplitAPIVersion) {
throw new Error('Unable to find traffic split api version') throw new Error("Unable to find traffic split api version");
} }
return trafficSplitAPIVersion return trafficSplitAPIVersion;
} }
+17 -19
View File
@@ -1,20 +1,18 @@
import {cleanLabel} from '../utilities/workflowAnnotationUtils' import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils";
describe('WorkflowAnnotationUtils', () => { describe("WorkflowAnnotationUtils", () => {
describe('cleanLabel', () => { describe("prefixObjectKeys", () => {
it('should clean label', () => { it("should prefix an object with a given prefix", () => {
const alreadyClean = 'alreadyClean' const obj = {
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean) foo: "bar",
expect(cleanLabel('.startInvalid')).toEqual('startInvalid') baz: "qux",
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual( };
'withS0MEinvalidchars' const prefix = "prefix.";
) const expected = {
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji') "prefix.foo": "bar",
}) "prefix.baz": "qux",
it('should remove slashes from label', () => { };
expect( expect(prefixObjectKeys(obj, prefix)).toEqual(expected);
cleanLabel('Workflow Name / With Slashes / And Spaces') });
).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces') });
}) });
})
})
+39 -40
View File
@@ -1,47 +1,46 @@
import {DeploymentConfig} from '../types/deploymentConfig' import { DeploymentConfig } from "../types/deploymentConfig";
const ANNOTATION_PREFIX = 'actions.github.com' const ANNOTATION_PREFIX = "actions.github.com/";
export function prefixObjectKeys(obj: any, prefix: string): any {
return Object.keys(obj).reduce((newObj, key) => {
newObj[prefix + key] = obj[key];
return newObj;
}, {});
}
export function getWorkflowAnnotations( export function getWorkflowAnnotations(
lastSuccessRunSha: string, lastSuccessRunSha: string,
workflowFilePath: string, workflowFilePath: string,
deploymentConfig: DeploymentConfig deploymentConfig: DeploymentConfig
): string { ): string {
const annotationObject = { const annotationObject = {
run: process.env.GITHUB_RUN_ID, run: process.env.GITHUB_RUN_ID,
repository: process.env.GITHUB_REPOSITORY, repository: process.env.GITHUB_REPOSITORY,
workflow: process.env.GITHUB_WORKFLOW, workflow: process.env.GITHUB_WORKFLOW,
workflowFileName: workflowFilePath.replace('.github/workflows/', ''), workflowFileName: workflowFilePath.replace(".github/workflows/", ""),
jobName: process.env.GITHUB_JOB, jobName: process.env.GITHUB_JOB,
createdBy: process.env.GITHUB_ACTOR, createdBy: process.env.GITHUB_ACTOR,
runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`, runUri: `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`,
commit: process.env.GITHUB_SHA, commit: process.env.GITHUB_SHA,
lastSuccessRunCommit: lastSuccessRunSha, lastSuccessRunCommit: lastSuccessRunSha,
branch: process.env.GITHUB_REF, branch: process.env.GITHUB_REF,
deployTimestamp: Date.now(), deployTimestamp: Date.now(),
dockerfilePaths: deploymentConfig.dockerfilePaths, dockerfilePaths: deploymentConfig.dockerfilePaths,
manifestsPaths: deploymentConfig.manifestFilePaths, manifestsPaths: deploymentConfig.manifestFilePaths,
helmChartPaths: deploymentConfig.helmChartFilePaths, helmChartPaths: deploymentConfig.helmChartFilePaths,
provider: 'GitHub' provider: "GitHub",
} };
return JSON.stringify(annotationObject) const prefixedAnnotationObject = prefixObjectKeys(annotationObject, ANNOTATION_PREFIX);
return JSON.stringify(prefixedAnnotationObject);
} }
export function getWorkflowAnnotationKeyLabel(): string { export function getWorkflowAnnotationKeyLabel(
return `${ANNOTATION_PREFIX}/k8s-deploy` workflowFilePath: string
} ): string {
const hashKey = require("crypto")
/** .createHash("MD5")
* Cleans label to match valid kubernetes label specification by removing invalid characters .update(`${process.env.GITHUB_REPOSITORY}/${workflowFilePath}`)
* @param label .digest("hex");
* @returns cleaned label return `githubWorkflow_${hashKey}`;
*/
export function cleanLabel(label: string): string {
let removedInvalidChars = label
.replace(/\s/gi, '_')
.replace(/[\/\\\|]/gi, '-')
.replace(/[^-A-Za-z0-9_.]/gi, '')
const regex = /([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]/
return regex.exec(removedInvalidChars)[0] || ''
} }
+42 -42
View File
@@ -1,52 +1,52 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx app: nginx
spec: spec:
replicas: 1 replicas: 1
selector: selector:
matchLabels: matchLabels:
app: nginx app: nginx
template: template:
metadata: metadata:
labels: labels:
app: nginx app: nginx
spec: spec:
containers: containers:
- name: nginx - name: nginx
image: nginx:1.14.2 image: nginx:1.14.2
ports: ports:
- containerPort: 80 - containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
--- ---
apiVersion: networking.k8s.io/v1beta1 apiVersion: networking.k8s.io/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: nginx-ingress name: nginx-ingress
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /
spec: spec:
rules: rules:
- http: - http:
paths: paths:
- path: /testpath - path: /testpath
backend: backend:
serviceName: nginx-service serviceName: nginx-service
servicePort: 80 servicePort: 80
- path: /testpath2 - path: /testpath2
backend: backend:
serviceName: unrouted-service serviceName: unrouted-service
servicePort: 80 servicePort: 80
+28 -28
View File
@@ -1,33 +1,33 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx app: nginx
spec: spec:
replicas: 1 replicas: 1
selector: selector:
matchLabels: matchLabels:
app: nginx app: nginx
template: template:
metadata: metadata:
labels: labels:
app: nginx app: nginx
spec: spec:
containers: containers:
- name: nginx - name: nginx
image: nginx:1.14.2 image: nginx:1.14.2
ports: ports:
- containerPort: 80 - containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
@@ -1,21 +1,21 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx app: nginx
spec: spec:
replicas: 1 replicas: 1
selector: selector:
matchLabels: matchLabels:
app: nginx app: nginx
template: template:
metadata: metadata:
labels: labels:
app: nginx app: nginx
spec: spec:
containers: containers:
- name: nginx - name: nginx
image: nginx:1.14.2 image: nginx:1.14.2
ports: ports:
- containerPort: 80 - containerPort: 80
@@ -1,18 +1,18 @@
apiVersion: networking.k8s.io/v1beta1 apiVersion: networking.k8s.io/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: nginx-ingress name: nginx-ingress
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /
spec: spec:
rules: rules:
- http: - http:
paths: paths:
- path: /testpath - path: /testpath
backend: backend:
serviceName: nginx-service serviceName: nginx-service
servicePort: 80 servicePort: 80
- path: /testpath2 - path: /testpath2
backend: backend:
serviceName: unrouted-service serviceName: unrouted-service
servicePort: 80 servicePort: 80
@@ -1,11 +1,11 @@
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
+42 -46
View File
@@ -5,63 +5,59 @@
replicaCount: 1 replicaCount: 1
image: image:
repository: nginx repository: nginx
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
imagePullSecrets: [] imagePullSecrets: []
nameOverride: '' nameOverride: ""
fullnameOverride: '' fullnameOverride: ""
serviceAccount: serviceAccount:
# Specifies whether a service account should be created # Specifies whether a service account should be created
create: true create: true
# The name of the service account to use. # The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template # If not set and create is true, a name is generated using the fullname template
name: name:
podSecurityContext: podSecurityContext: {}
{} # fsGroup: 2000
# fsGroup: 2000
securityContext: securityContext: {}
{} # capabilities:
# capabilities: # drop:
# drop: # - ALL
# - ALL # readOnlyRootFilesystem: true
# readOnlyRootFilesystem: true # runAsNonRoot: true
# runAsNonRoot: true # runAsUser: 1000
# runAsUser: 1000
service: service:
type: ClusterIP type: ClusterIP
port: 80 port: 80
ingress: ingress:
enabled: false enabled: false
annotations: annotations: {}
{} # kubernetes.io/ingress.class: nginx
# kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true"
# kubernetes.io/tls-acme: "true" hosts:
hosts: - host: chart-example.local
- host: chart-example.local paths: []
paths: [] tls: []
tls: [] # - secretName: chart-example-tls
# - secretName: chart-example-tls # hosts:
# hosts: # - chart-example.local
# - chart-example.local
resources: resources: {}
{} # We usually recommend not to specify default resources and to leave this as a conscious
# We usually recommend not to specify default resources and to leave this as a conscious # choice for the user. This also increases chances charts run on environments with little
# choice for the user. This also increases chances charts run on environments with little # resources, such as Minikube. If you do want to specify resources, uncomment the following
# resources, such as Minikube. If you do want to specify resources, uncomment the following # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
# lines, adjust them as necessary, and remove the curly braces after 'resources:'. # limits:
# limits: # cpu: 100m
# cpu: 100m # memory: 128Mi
# memory: 128Mi # requests:
# requests: # cpu: 100m
# cpu: 100m # memory: 128Mi
# memory: 128Mi
nodeSelector: {} nodeSelector: {}
@@ -1,23 +0,0 @@
---
apiVersion: v1
kind: Service
metadata:
name: unrouted-service
spec:
selector:
app: fake-application
ports:
- protocol: TCP
port: 80
targetPort: 80
---
kind: TrafficSplit
metadata:
name: foobar-rollout
spec:
service: foobar
backends:
- service: foobar-v1
weight: 1000
- service: foobar-v2
weight: 500
-50
View File
@@ -1,50 +0,0 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 1
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14.2
ports:
- containerPort: 80
---
apiVersion: v1
kind: Service
metadata:
name: nginx-service
spec:
selector:
app: nginx
ports:
- protocol: TCP
port: 80
targetPort: 80
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: nginx-ingress
annotations:
nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
- http:
paths:
- path: /testpath
backend:
service:
name: nginx-service
port:
number: 80
+42 -42
View File
@@ -1,52 +1,52 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx app: nginx
spec: spec:
replicas: 1 replicas: 1
selector: selector:
matchLabels: matchLabels:
app: nginx app: nginx
template: template:
metadata: metadata:
labels: labels:
app: nginx app: nginx
spec: spec:
containers: containers:
- name: nginx - name: nginx
image: nginx:1.14.2 image: nginx:1.14.2
ports: ports:
- containerPort: 80 - containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
--- ---
apiVersion: networking.k8s.io/v1beta1 apiVersion: networking.k8s.io/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: nginx-ingress name: nginx-ingress
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /
spec: spec:
rules: rules:
- http: - http:
paths: paths:
- path: /testpath - path: /testpath
backend: backend:
serviceName: nginx-service serviceName: nginx-service
servicePort: 80 servicePort: 80
- path: /testpath2 - path: /testpath2
backend: backend:
serviceName: unrouted-service serviceName: unrouted-service
servicePort: 80 servicePort: 80
+28 -28
View File
@@ -1,33 +1,33 @@
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: nginx-deployment name: nginx-deployment
labels: labels:
app: nginx app: nginx
spec: spec:
replicas: 1 replicas: 1
selector: selector:
matchLabels: matchLabels:
app: nginx app: nginx
template: template:
metadata: metadata:
labels: labels:
app: nginx app: nginx
spec: spec:
containers: containers:
- name: nginx - name: nginx
image: nginx:1.14.2 image: nginx:1.14.2
ports: ports:
- containerPort: 80 - containerPort: 80
--- ---
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: nginx-service name: nginx-service
spec: spec:
selector: selector:
app: nginx app: nginx
ports: ports:
- protocol: TCP - protocol: TCP
port: 80 port: 80
targetPort: 80 targetPort: 80
+7 -7
View File
@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES6", "target": "ES6",
"module": "commonjs" "module": "commonjs"
}, },
"exclude": ["node_modules", "test", "src/**/*.test.ts"] "exclude": ["node_modules", "test", "src/**/*.test.ts"]
} }