mirror of
https://github.com/Azure/k8s-deploy.git
synced 2026-06-21 10:39:26 +08:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Oliver King
|
0b0b5178d5 | ||
|
Oliver King
|
d43ff40a3e |
@@ -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
|
||||
@@ -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
|
||||
@@ -1,18 +0,0 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
groups:
|
||||
actions:
|
||||
patterns:
|
||||
- '*'
|
||||
- package-ecosystem: github-actions
|
||||
directory: .github/workflows
|
||||
schedule:
|
||||
interval: weekly
|
||||
groups:
|
||||
actions:
|
||||
patterns:
|
||||
- '*'
|
||||
@@ -1,49 +1,52 @@
|
||||
name: 'Code scanning - action'
|
||||
name: "Code scanning - action"
|
||||
|
||||
on:
|
||||
push:
|
||||
pull_request:
|
||||
schedule:
|
||||
- cron: '0 19 * * 0'
|
||||
push:
|
||||
pull_request:
|
||||
schedule:
|
||||
- cron: '0 19 * * 0'
|
||||
|
||||
jobs:
|
||||
CodeQL-Build:
|
||||
# CodeQL runs on ubuntu-latest and windows-latest
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
security-events: write
|
||||
CodeQL-Build:
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
|
||||
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
|
||||
# CodeQL runs on ubuntu-latest and windows-latest
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
|
||||
# Override language selection by uncommenting this and choosing your languages
|
||||
# with:
|
||||
# languages: go, javascript, csharp, python, cpp, java
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
# We must fetch at least the immediate parents so that if this is
|
||||
# a pull request then we can checkout the head.
|
||||
fetch-depth: 2
|
||||
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
|
||||
# If this run was triggered by a pull request event, then checkout
|
||||
# the head of the pull request instead of the merge commit.
|
||||
- run: git checkout HEAD^2
|
||||
if: ${{ github.event_name == 'pull_request' }}
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v1
|
||||
# Override language selection by uncommenting this and choosing your languages
|
||||
# with:
|
||||
# languages: go, javascript, csharp, python, cpp, java
|
||||
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 https://git.io/JvXDl
|
||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
||||
# If this step fails, then you should remove it and run the build manually (see below)
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v1
|
||||
|
||||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
||||
# and modify them (or add more) to build your code if your project
|
||||
# uses a compiled language
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 https://git.io/JvXDl
|
||||
|
||||
#- run: |
|
||||
# make bootstrap
|
||||
# make release
|
||||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
||||
# and modify them (or add more) to build your code if your project
|
||||
# uses a compiled language
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@45775bd8235c68ba998cffa5171334d58593da47 #v3.28.15
|
||||
#- run: |
|
||||
# make bootstrap
|
||||
# make release
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v1
|
||||
|
||||
@@ -1,35 +1,36 @@
|
||||
name: setting-default-labels
|
||||
|
||||
# Controls when the action will run.
|
||||
# Controls when the action will run.
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0/3 * * *'
|
||||
schedule:
|
||||
- cron: "0 0/3 * * *"
|
||||
|
||||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
|
||||
jobs:
|
||||
build:
|
||||
# The type of runner that the job will run on
|
||||
runs-on: ubuntu-latest
|
||||
build:
|
||||
# The type of runner that the job will run on
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
# Steps represent a sequence of tasks that will be executed as part of the job
|
||||
steps:
|
||||
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
|
||||
name: Setting issue as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
|
||||
stale-issue-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
exempt-issue-labels: 'backlog'
|
||||
|
||||
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
|
||||
name: Setting PR as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
|
||||
stale-pr-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
# Steps represent a sequence of tasks that will be executed as part of the job
|
||||
steps:
|
||||
|
||||
- uses: actions/stale@v3
|
||||
name: Setting issue as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-issue-message: 'This issue is idle because it has been open for 14 days with no activity.'
|
||||
stale-issue-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
exempt-issue-labels: 'backlog'
|
||||
|
||||
- uses: actions/stale@v3
|
||||
name: Setting PR as idle
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
stale-pr-message: 'This PR is idle because it has been open for 14 days with no activity.'
|
||||
stale-pr-label: 'idle'
|
||||
days-before-stale: 14
|
||||
days-before-close: -1
|
||||
operations-per-run: 100
|
||||
|
||||
@@ -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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
- name: install deps
|
||||
run: npm install
|
||||
|
||||
- name: Enforce Prettier
|
||||
run: npm run format-check
|
||||
@@ -1,18 +1,14 @@
|
||||
name: Release Project
|
||||
name: Create release PR
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- CHANGELOG.md
|
||||
workflow_dispatch:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release:
|
||||
description: "Define release version (ex: v1, v2, v3)"
|
||||
required: true
|
||||
|
||||
jobs:
|
||||
release:
|
||||
permissions:
|
||||
actions: read
|
||||
contents: write
|
||||
uses: Azure/action-release-workflows/.github/workflows/release_js_project.yaml@v1
|
||||
with:
|
||||
changelogPath: ./CHANGELOG.md
|
||||
release-pr:
|
||||
uses: OliverMKing/javascript-release-workflow/.github/workflows/release-pr.yml@main
|
||||
with:
|
||||
release: ${{ github.event.inputs.release }}
|
||||
@@ -1,76 +0,0 @@
|
||||
name: Minikube Integration Tests - basic
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for pod
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
test/integration/manifests/manifest_test_dir/test.yml
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments and services were created
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment3 containerName=nginx:1.14.2 labels=app:nginx3,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx3
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service3 labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_basic selectorLabels=app:nginx3
|
||||
@@ -1,180 +0,0 @@
|
||||
name: Minikube Integration Tests - blue-green ingress
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments, services and ingresses were created with green labels and original tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
|
||||
|
||||
- name: Executing promote action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments, services and ingresses were created with none labels after first promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
|
||||
|
||||
- name: Executing second deploy action for ingress with new tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments (with new tag), services and ingresses were created with green labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
|
||||
|
||||
- name: Executing second promote action for ingress now using new image tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments, services and ingresses were created with none labels after promote for new tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
|
||||
|
||||
- name: Executing deploy action for ingress to be rejected using old tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: deploy
|
||||
|
||||
- name: Checking if new deployments (with old tag), services and ingresses were created with green labels after deploy, and old deployment (with latest tag) persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service-green,unrouted-service
|
||||
|
||||
- name: Executing reject action for ingress to reject new deployment with 1.14.2 tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: reject
|
||||
|
||||
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
|
||||
- name: Checking if deployments, services and ingresses were created with none labels and latest tag after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_ingress selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Ingress name=nginx-ingress ingressServices=nginx-service,unrouted-service
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns ${{ env.NAMESPACE }}
|
||||
@@ -1,167 +0,0 @@
|
||||
name: Minikube Integration Tests - blue-green service
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for service
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments and services were created with green labels and original tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
- name: Executing promote action for service
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments and services were created with none labels after first promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
- name: Executing second deploy action for service with new tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments (with new tag) and services were created with green labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
- name: Executing second promote action for service now using new image tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments and services were created with none labels after promote for new tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
- name: Executing deploy action for service to be rejected using old tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: deploy
|
||||
|
||||
- name: Checking if new deployments (with old tag) and services were created with green labels after deploy, and old deployment (with latest tag) persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:green,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
- name: Executing reject action for service to reject new deployment with 1.14.2 tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: reject
|
||||
|
||||
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
|
||||
- name: Checking if deployments and services were created with none labels and latest tag after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=k8s.deploy.color:None,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_service selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns ${{ env.NAMESPACE }}
|
||||
@@ -1,206 +0,0 @@
|
||||
name: Minikube Integration Tests - blue-green SMI
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Install linkerd and add controlplane to cluster
|
||||
run: |
|
||||
curl --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install-edge | sh
|
||||
export PATH=$PATH:/home/runner/.linkerd2/bin
|
||||
curl -sL https://linkerd.github.io/linkerd-smi/install | sh
|
||||
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.0/standard-install.yaml
|
||||
|
||||
linkerd install --crds | kubectl apply -f -
|
||||
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
|
||||
linkerd smi install | kubectl apply -f -
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for smi
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments, services, and ts objects were created with green labels and original tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
|
||||
|
||||
- name: Executing promote action for smi
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: promote
|
||||
|
||||
# another good place for anti-test - ensure old deps are deleted after promote
|
||||
- name: Checking if deployments, services, and ts objects were created with none labels after first promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
|
||||
|
||||
- name: Executing second deploy action for smi with new tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments (with new tag) and services were created with green labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:latest labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
|
||||
|
||||
- name: Executing second promote action for smi now using new image tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments and services were created with none labels after promote for new tag, ts is stable
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
|
||||
|
||||
- name: Executing deploy action for smi to be rejected using old tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if new deployments (with old tag) and services were created with green labels after deploy, and old deployment (with latest tag) persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-green containerName=nginx:1.14.2 labels=k8s.deploy.color:green,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-green labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:green selectorLabels=app:nginx,k8s.deploy.color:green
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:0,nginx-service-green:100
|
||||
|
||||
- name: Executing reject action for smi to reject new deployment with 1.14.2 tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/blue-green/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: smi
|
||||
action: reject
|
||||
|
||||
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
|
||||
- name: Checking if deployments and services were created with none labels and latest tag after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=k8s.deploy.color:None,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_blue-green_SMI,k8s.deploy.color:None selectorLabels=app:nginx,k8s.deploy.color:None
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-trafficsplit tsServices=nginx-service-stable:100,nginx-service-green:0
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns ${{ env.NAMESPACE }}
|
||||
@@ -1,176 +0,0 @@
|
||||
name: Minikube Integration Tests - canary pod
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for pod
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments and services were created with canary labels and original tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Executing promote action for pod
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: promote
|
||||
|
||||
# another good place for anti-test - ensure old deps are deleted after promote
|
||||
- name: Checking if deployments and services were created with stable labels after first promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Executing second deploy action for pod with new tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments (with new tag) and services were created with canary labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:latest labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Executing second promote action for pod now using new image tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments and services were created with stable labels after promote for new tag, ts is stable
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Executing deploy action for pod to be rejected using old tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: deploy
|
||||
|
||||
- name: Checking if new deployments (with old tag) and services were created with canary and baseline labels after deploy, and stable deployment (with latest tag) persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx,workflow/version:canary
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Executing reject action for pod to reject new deployment with 1.14.2 tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: pod
|
||||
action: reject
|
||||
|
||||
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
|
||||
- name: Checking if deployments and services were created with stable labels and latest tag after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:latest labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_pod selectorLabels=app:nginx
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ env.NAMESPACE }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns ${{ env.NAMESPACE }}
|
||||
@@ -1,215 +0,0 @@
|
||||
name: Minikube Integration Tests - canary SMI
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
curl --proto '=https' --tlsv1.2 -sSfL https://run.linkerd.io/install-edge | sh
|
||||
export PATH=$PATH:/home/runner/.linkerd2/bin
|
||||
curl -sL https://linkerd.github.io/linkerd-smi/install | sh
|
||||
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.0/standard-install.yaml
|
||||
|
||||
linkerd install --crds | kubectl apply -f -
|
||||
linkerd install --set proxyInit.runAsRoot=true | kubectl apply -f -
|
||||
linkerd smi install | kubectl apply -f -
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for smi
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments, services, and ts objects were created with canary labels and original tag
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:0,nginx-service-canary:1000,nginx-service-baseline:0
|
||||
|
||||
- name: Executing promote action for smi
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: promote
|
||||
|
||||
# another good place for anti-test - ensure old deps are deleted after promote
|
||||
- name: Checking if deployments, services, and ts objects were created with stable labels after first promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:1.14.2 labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
|
||||
|
||||
- name: Executing second deploy action for smi with new tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments (with new tag) and services were created with canary labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:1.14.2 labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:latest labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-baseline containerName=nginx:1.14.2 labels=workflow/version:baseline,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:baseline
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-baseline labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:baseline selectorLabels=app:nginx,workflow/version:baseline
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:500,nginx-service-canary:250,nginx-service-baseline:250
|
||||
|
||||
- name: Executing second promote action for smi now using new image tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:latest
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: promote
|
||||
|
||||
- name: Checking if deployments and services were created with stable labels after promote for new tag, ts is stable
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
|
||||
|
||||
- name: Executing deploy action for smi to be rejected using old tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: deploy
|
||||
|
||||
- name: Checking if new deployments (with old tag) and services were created with canary and baseline labels after deploy, and stable deployment (with latest tag) persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-canary containerName=nginx:1.14.2 labels=workflow/version:canary,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:canary
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-baseline containerName=nginx:latest labels=workflow/version:baseline,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:baseline
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-baseline labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:baseline selectorLabels=app:nginx,workflow/version:baseline
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-canary labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:canary selectorLabels=app:nginx,workflow/version:canary
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:500,nginx-service-canary:250,nginx-service-baseline:250
|
||||
|
||||
- name: Executing reject action for smi to reject new deployment with 1.14.2 tag
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
strategy: canary
|
||||
percentage: 50
|
||||
traffic-split-method: smi
|
||||
action: reject
|
||||
|
||||
# MAY BE USEFUL TO ADD AN ANTI-CHECK - CHECK TO MAKE SURE CERTAIN OBJECTS DON'T EXIST
|
||||
- name: Checking if deployments and services were created with stable labels and latest tag after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment-stable containerName=nginx:latest labels=workflow/version:stable,app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service-stable labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_canary_SMI,workflow/version:stable selectorLabels=app:nginx,workflow/version:stable
|
||||
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=TrafficSplit name=nginx-service-workflow-rollout tsServices=nginx-service-stable:1000,nginx-service-canary:0,nginx-service-baseline:0
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'TrafficSplit' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns ${{ env.NAMESPACE }}
|
||||
@@ -1,85 +0,0 @@
|
||||
name: Cluster Integration Tests - private cluster
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
permissions:
|
||||
contents: read
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
- name: Azure login
|
||||
uses: azure/login@v2.3.0
|
||||
with:
|
||||
client-id: ${{ secrets.AZURE_CLIENT_ID }}
|
||||
tenant-id: ${{ secrets.AZURE_TENANT_ID }}
|
||||
subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- name: Create private AKS cluster and set context
|
||||
run: |
|
||||
set +x
|
||||
# create cluster
|
||||
az group create --location eastus2 --name ${{ env.NAMESPACE }}
|
||||
az aks create --name ${{ env.NAMESPACE }} --resource-group ${{ env.NAMESPACE }} --enable-private-cluster --generate-ssh-keys
|
||||
az aks get-credentials --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: |
|
||||
az aks command invoke --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }} --command "kubectl create ns ${{ env.NAMESPACE }}"
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Executing deploy action for pod
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
test/integration/manifests/test2.yml
|
||||
action: deploy
|
||||
private-cluster: true
|
||||
resource-group: ${{ env.NAMESPACE }}
|
||||
name: ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Checking if deployments and services were created
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx
|
||||
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx
|
||||
|
||||
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment2 containerName=nginx:1.14.2 labels=app:nginx2,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx2
|
||||
python test/integration/k8s-deploy-test.py private=${{ env.NAMESPACE }} namespace=${{ env.NAMESPACE }} kind=Service name=nginx-service2 labels=workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Cluster_Integration_Tests_-_private_cluster selectorLabels=app:nginx2
|
||||
|
||||
- name: Clean up AKS cluster
|
||||
if: ${{ always() }}
|
||||
run: |
|
||||
echo "deleting AKS cluster and resource group"
|
||||
az aks delete --yes --resource-group ${{ env.NAMESPACE }} --name ${{ env.NAMESPACE }}
|
||||
az group delete --resource-group ${{ env.NAMESPACE }} --yes
|
||||
@@ -1,89 +0,0 @@
|
||||
name: Minikube Integration Tests - resource annotation
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-22.04
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
NAMESPACE: test-${{ github.run_id }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Install conntrack
|
||||
run: sudo apt-get install -y conntrack
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- uses: Azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: medyagh/setup-minikube@cea33675329b799adccc9526aa5daccc26cd5052 # v0.0.19
|
||||
with:
|
||||
minikube-version: 1.34.0
|
||||
kubernetes-version: 1.31.0
|
||||
driver: 'none'
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns ${{ env.NAMESPACE }}
|
||||
|
||||
- uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # 5.5.0
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: '3.x'
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for pod with resource annotation enabled by default
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deployments is created with additional resource annotation
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 labels=app:nginx,workflow:actions.github.com-k8s-deploy,workflowFriendlyName:Minikube_Integration_Tests_-_resource_annotation selectorLabels=app:nginx annotations=actions.github.com/k8s-deploy,deployment.kubernetes.io/revision,kubectl.kubernetes.io/last-applied-configuration
|
||||
|
||||
- name: Cleaning previously created deployment
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'all' ${{ env.NAMESPACE }}
|
||||
|
||||
- name: Executing deploy action for pod with resource annotation disabled
|
||||
uses: ./
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test.yml
|
||||
action: deploy
|
||||
annotate-resources: false
|
||||
|
||||
- name: Checking if deployment is created without additional resource annotation
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py namespace=${{ env.NAMESPACE }} kind=Deployment name=nginx-deployment containerName=nginx:1.14.2 selectorLabels=app:nginx annotations=deployment.kubernetes.io/revision,kubectl.kubernetes.io/last-applied-configuration
|
||||
@@ -0,0 +1,215 @@
|
||||
name: Minikube Integration Tests
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
- "releases/*"
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
- "releases/*"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
run-integration-test:
|
||||
name: Run Minikube Integration Tests
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
KUBECONFIG: /home/runner/.kube/config
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
rm -rf node_modules/
|
||||
npm install
|
||||
|
||||
- name: Install ncc
|
||||
run: npm i -g @vercel/ncc
|
||||
- name: Build
|
||||
run: ncc build src/run.ts -o lib
|
||||
|
||||
- name: Set name of ns
|
||||
run: echo "::set-output name=name::$(echo `date +%Y%m%d%H%M%S`)"
|
||||
shell: bash
|
||||
id: ns
|
||||
|
||||
- uses: Azure/setup-kubectl@v1
|
||||
name: Install Kubectl
|
||||
|
||||
- id: setup-minikube
|
||||
name: Setup Minikube
|
||||
uses: manusa/actions-setup-minikube@v2.4.2
|
||||
with:
|
||||
minikube version: "v1.24.0"
|
||||
kubernetes version: "v1.17.8"
|
||||
driver: "none"
|
||||
timeout-minutes: 3
|
||||
|
||||
- name: Create namespace to run tests
|
||||
run: kubectl create ns test-${{ steps.ns.outputs.name }}
|
||||
|
||||
- uses: actions/setup-python@v2
|
||||
name: Install Python
|
||||
with:
|
||||
python-version: "3.x"
|
||||
|
||||
- name: Cleaning any previously created items
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service-green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment-green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-delete.py 'Ingress' 'nginx-ingress' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing deploy action
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deploments and services were created with green labels
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing promote action
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: promote
|
||||
|
||||
- name: Checking if deploments and services were created with none labels after promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing deploy action on
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.19.1
|
||||
manifests: |
|
||||
test/integration/manifests/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deploments and services were created with green labels, and old workloads persist on deploy
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing reject action
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.19.1
|
||||
manifests: |
|
||||
test/integration/manifests/test-service.yml
|
||||
strategy: blue-green
|
||||
route-method: service
|
||||
action: reject
|
||||
|
||||
- name: Checking if deploments and services were routed back to none labels after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Cleaning up current set up
|
||||
run: |
|
||||
python test/integration/k8s-deploy-delete.py 'Service' 'nginx-service' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-delete.py 'Deployment' 'nginx-deployment' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing deploy action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deploments, services and ingresses were created with green labels
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing promote action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.14.2
|
||||
manifests: |
|
||||
test/integration/manifests/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: promote
|
||||
|
||||
- name: Checking if deploments, services and ingresses were created with none labels after promote
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing deploy action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.19.1
|
||||
manifests: |
|
||||
test/integration/manifests/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: deploy
|
||||
|
||||
- name: Checking if deploments, services and ingresses were created with green labels after deploy, and old deployment persists
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service-green' 'green' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'green' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- name: Executing reject action for ingress
|
||||
uses: ./
|
||||
with:
|
||||
namespace: test-${{ steps.ns.outputs.name }}
|
||||
images: nginx:1.19.1
|
||||
manifests: |
|
||||
test/integration/manifests/test-ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress
|
||||
action: reject
|
||||
|
||||
- name: Checking if deploments, services and ingresses were created with none labels after reject
|
||||
run: |
|
||||
python test/integration/k8s-deploy-test.py 'Deployment' 'nginx-deployment' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Service' 'nginx-service' 'None' ${{ steps.ns.outputs.name }}
|
||||
python test/integration/k8s-deploy-test.py 'Ingress' 'nginx-ingress' 'None' ${{ steps.ns.outputs.name }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Delete created namespace
|
||||
run: kubectl delete ns test-${{ steps.ns.outputs.name }}
|
||||
|
||||
- if: ${{ always() }}
|
||||
name: Posting result back to PR
|
||||
run: |
|
||||
if [ '${{ steps.job-type.outputs.type }}' == 'pr' ]; then ruby postStatus.rb ${{github.event.client_payload.repository}} ${{github.event.client_payload.commit}} ${{secrets.L2_REPO_TOKEN}} ${{job.status}} ${{github.run_id}} ${{matrix.os}} false ${{ secrets.L2_REPO_USER }}; fi
|
||||
shell: bash
|
||||
@@ -0,0 +1,10 @@
|
||||
name: Tag and create release draft
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- releases/*
|
||||
|
||||
jobs:
|
||||
tag-and-release:
|
||||
uses: OliverMKing/javascript-release-workflow/.github/workflows/tag-and-release.yml@main
|
||||
@@ -1,20 +1,19 @@
|
||||
name: 'Run unit tests.'
|
||||
name: "Run unit tests."
|
||||
on: # rebuild any PRs and main branch changes
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- 'releases/*'
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- "releases/*"
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- "releases/*"
|
||||
|
||||
jobs:
|
||||
build: # make sure build/ci works properly
|
||||
name: Run Unit Tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
- run: |
|
||||
npm install
|
||||
npm test
|
||||
build: # make sure build/ci works properly
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- run: |
|
||||
npm install
|
||||
npm test
|
||||
|
||||
+1
-2
@@ -2,5 +2,4 @@ node_modules
|
||||
|
||||
.DS_Store
|
||||
.idea
|
||||
|
||||
coverage/
|
||||
lib/
|
||||
@@ -1,4 +0,0 @@
|
||||
# dependencies
|
||||
/node_modules
|
||||
coverage
|
||||
/lib
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"trailingComma": "none",
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"tabWidth": 3,
|
||||
"singleQuote": true,
|
||||
"printWidth": 80
|
||||
}
|
||||
@@ -1,46 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## [5.0.3] - 2025-04-16
|
||||
|
||||
### Added
|
||||
|
||||
- #398 case-insensitive resource type
|
||||
|
||||
## [5.0.2] - 2025-04-15
|
||||
|
||||
### Added
|
||||
|
||||
- #396 Update new resource-type input for action
|
||||
|
||||
## [5.0.1] - 2024-03-12
|
||||
|
||||
### Added
|
||||
|
||||
- #356 Add fleet support
|
||||
|
||||
## [5.0.0] - 2024-03-12
|
||||
|
||||
### Changed
|
||||
|
||||
- #309 Updated to Node20 and upgraded release workflows to @v1 tag
|
||||
- #306 update release workflow to use new prefix, remove deprecated release
|
||||
- #303 fix: ensure imageNames are not empty strings
|
||||
- #299 bump release workflow sha
|
||||
- #298 bump minikube to fix runner deps
|
||||
- #297 update release workflow
|
||||
|
||||
### Added
|
||||
|
||||
- #304 add v prefix for version tagging
|
||||
- #302 adding ncc to build
|
||||
- #301 adding release workflow artifact fix
|
||||
|
||||
## [4.10.0] - 2023-10-30
|
||||
|
||||
### Added
|
||||
|
||||
- #287 Make annotating resources optional
|
||||
- #283 Fix “Service” route-method of the Blue-Green strategy with some manifest files
|
||||
- #281 bump codeql to node 16
|
||||
- #279 upgrade codeql
|
||||
- #276 Fixes multiple namespaces bug
|
||||
+9
-9
@@ -1,9 +1,9 @@
|
||||
# Microsoft Open Source Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
Resources:
|
||||
|
||||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
|
||||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
|
||||
# Microsoft Open Source Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
Resources:
|
||||
|
||||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
|
||||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
|
||||
|
||||
@@ -1,489 +1,434 @@
|
||||
# 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).
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: read
|
||||
actions: read
|
||||
```
|
||||
|
||||
## Action capabilities
|
||||
|
||||
Following are the key capabilities of this action:
|
||||
|
||||
- **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes.
|
||||
|
||||
- **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.
|
||||
|
||||
- **Deployment strategy** Supports both canary and blue-green deployment strategies
|
||||
|
||||
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
|
||||
- **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.
|
||||
- **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
|
||||
|
||||
- **Service route-method**: Identified services are configured to target the green deployments.
|
||||
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services.
|
||||
- **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster.
|
||||
|
||||
Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads.
|
||||
|
||||
## Action inputs
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Action inputs</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td>action </br></br>(Required)</td>
|
||||
<td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>manifests </br></br>(Required)</td>
|
||||
<td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed, or URLs to manifest files (like https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/controllers/nginx-deployment.yaml). Files and URLs not ending in .yml or .yaml will be ignored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>strategy </br></br>(Required)</td>
|
||||
<td>Acceptable values: basic/canary/blue-green. <br>
|
||||
Default value: basic
|
||||
<br>Deployment strategy to be used while applying manifest files on the cluster.
|
||||
<br>basic - Template is force applied to all pods when deploying to cluster. NOTE: Can only be used with action == deploy
|
||||
<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>namespace </br></br>(Optional)
|
||||
<td>Namespace within the cluster to deploy to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>images </br></br>(Optional)</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>
|
||||
<code><br>images: |<br>  contosodemo.azurecr.io/foo:test1<br>  contosodemo.azurecr.io/bar:test2<br></code><br>
|
||||
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>imagepullsecrets </br></br>(Optional)</td>
|
||||
<td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull-images</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>traffic-split-method </br></br>(Optional)</td>
|
||||
<td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>traffic-split-annotations </br></br>(Optional)</td>
|
||||
<td>Annotations in the form of key/value pair to be added to TrafficSplit.</td>
|
||||
<tr>
|
||||
<td>percentage </br></br>(Optional but required if strategy is canary)</td>
|
||||
<td>Used to compute the number of replicas of '-baseline' and '-canary' 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 '-baseline' and '-canary'.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with 'replicas: 4' and if 'strategy: canary' and 'percentage: 25' are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The '-baseline' variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the '-canary' variant is created with the image and tag corresponding to the new changes being deployed</td>
|
||||
</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>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> strategy: canary<br> trafficSplitMethod: smi<br> percentage: 20<br> baselineAndCanaryReplicas: 1</code></br></br> In this case, stable variant will receive 80% traffic while baseline and canary variants will receive 10% each (20% split equally between baseline and canary). However, instead of creating baseline and canary with 3 replicas each, the explicit count of baseline and canary replicas is honored. That is, only 1 replica each is created for baseline and canary variants.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
|
||||
<td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
|
||||
<br>Service: Service selector labels are updated to target '-green' workloads.
|
||||
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
|
||||
<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>
|
||||
<tr>
|
||||
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
|
||||
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>private-cluster </br></br>(Optional and relevant only using K8's deploy for a cluster with private cluster enabled)</td>
|
||||
<td>Acceptable values: true, false</br>Default value: false.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>force </br></br>(Optional)</td>
|
||||
<td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>annotate-resources</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the resources or not. If set to false all annotations are skipped completely.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>annotate-namespace</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not. Ignored when annotate-resources is set to false.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>skip-tls-verify</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: false</br>True if the insecure-skip-tls-verify option should be used</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>resource-type (Optional)</td>
|
||||
<td>Acceptable values: `Microsoft.ContainerService/managedClusters` (default), 'Microsoft.ContainerService/fleets'</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic deployment (without any deployment strategy)
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
manifests: |
|
||||
dir/manifestsDirectory
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
```
|
||||
|
||||
### Private cluster deployment
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
resource-group: yourResourceGroup
|
||||
name: yourClusterName
|
||||
action: deploy
|
||||
strategy: basic
|
||||
|
||||
private-cluster: true
|
||||
manifests: |
|
||||
manifests/azure-vote-backend-deployment.yaml
|
||||
manifests/azure-vote-backend-service.yaml
|
||||
manifests/azure-vote-frontend-deployment.yaml
|
||||
manifests/azure-vote-frontend-service.yaml
|
||||
images: |
|
||||
registry.azurecr.io/containername
|
||||
```
|
||||
|
||||
### Canary deployment without service mesh
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: deploy
|
||||
percentage: 20
|
||||
```
|
||||
|
||||
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: promote # substitute reject if you want to reject
|
||||
```
|
||||
|
||||
### Canary deployment based on Service Mesh Interface
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: deploy
|
||||
traffic-split-method: smi
|
||||
percentage: 20
|
||||
baseline-and-canary-replicas: 1
|
||||
```
|
||||
|
||||
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }} '
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
traffic-split-method: smi
|
||||
action: reject # substitute promote if you want to promote
|
||||
```
|
||||
|
||||
### Blue-Green deployment with different route methods
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
ingress.yml
|
||||
strategy: blue-green
|
||||
action: deploy
|
||||
route-method: ingress # substitute with service/smi as per need
|
||||
version-switch-buffer: 15
|
||||
```
|
||||
|
||||
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
namespace: 'myapp'
|
||||
images: 'contoso.azurecr.io/myapp:${{ event.run_id }}'
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress # should be the same as the value when action was deploy
|
||||
action: promote # substitute reject if you want to reject
|
||||
```
|
||||
|
||||
## End to end workflows
|
||||
|
||||
Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters:
|
||||
|
||||
### Build container image and deploy to Azure Kubernetes Service cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
|
||||
- uses: azure/setup-kubectl@v4
|
||||
|
||||
# Set the target AKS cluster.
|
||||
- uses: Azure/aks-set-context@v4
|
||||
with:
|
||||
creds: '${{ secrets.AZURE_CREDENTIALS }}'
|
||||
cluster-name: contoso
|
||||
resource-group: contoso-rg
|
||||
|
||||
- uses: Azure/k8s-create-secret@v4
|
||||
with:
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
with:
|
||||
action: deploy
|
||||
manifests: |
|
||||
manifests/deployment.yml
|
||||
manifests/service.yml
|
||||
images: |
|
||||
demo.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
imagepullsecrets: |
|
||||
demo-k8s-secret
|
||||
```
|
||||
|
||||
### Build container image and deploy to any Azure Kubernetes Service cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
|
||||
- uses: azure/setup-kubectl@v4
|
||||
|
||||
- uses: Azure/k8s-set-context@v4
|
||||
with:
|
||||
kubeconfig: ${{ secrets.KUBE_CONFIG }}
|
||||
|
||||
- uses: Azure/k8s-create-secret@v4
|
||||
with:
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: Azure/k8s-deploy@v4
|
||||
with:
|
||||
action: deploy
|
||||
manifests: |
|
||||
manifests/deployment.yml
|
||||
manifests/service.yml
|
||||
images: |
|
||||
demo.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
imagepullsecrets: |
|
||||
demo-k8s-secret
|
||||
```
|
||||
|
||||
### Build image and add `dockerfile-path` label to it
|
||||
|
||||
We can use this image in other workflows once built.
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
env:
|
||||
NAMESPACE: demo-ns2
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
```
|
||||
|
||||
### Use bake action to get manifests deploying to a Kubernetes cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
env:
|
||||
NAMESPACE: demo-ns2
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- uses: azure/setup-kubectl@v4
|
||||
|
||||
# Set the target AKS cluster.
|
||||
- uses: Azure/aks-set-context@v4
|
||||
with:
|
||||
creds: '${{ secrets.AZURE_CREDENTIALS }}'
|
||||
cluster-name: contoso
|
||||
resource-group: contoso-rg
|
||||
|
||||
- uses: Azure/k8s-create-secret@v4
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: azure/k8s-bake@v3
|
||||
with:
|
||||
renderEngine: 'helm'
|
||||
helmChart: './aks-helloworld/'
|
||||
overrideFiles: './aks-helloworld/values-override.yaml'
|
||||
overrides: |
|
||||
replicas:2
|
||||
helm-version: 'latest'
|
||||
id: bake
|
||||
|
||||
- uses: Azure/k8s-deploy@v5
|
||||
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.
|
||||
# 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).
|
||||
|
||||
If you are looking to automate your workflows to deploy to [Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/) and [Azure Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/), consider using [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
|
||||
|
||||
## Action capabilities
|
||||
|
||||
Following are the key capabilities of this action:
|
||||
|
||||
- **Artifact substitution**: Takes a list of container images which can be specified along with their tags or digests. They are substituted into the non-templatized version of manifest files before applying to the cluster to ensure that the right version of the image is pulled by the cluster nodes.
|
||||
|
||||
- **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.
|
||||
|
||||
- **Deployment strategy** Supports both canary and blue-green deployment strategies
|
||||
|
||||
- **Canary strategy**: Workloads suffixed with '-baseline' and '-canary' are created. There are two methods of traffic splitting supported:
|
||||
- **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.
|
||||
- **Blue-Green strategy**: Choosing blue-green strategy with this action leads to creation of workloads suffixed with '-green'. An identified service is one that is supplied as part of the input manifest(s) and targets a workload in the supplied manifest(s). There are three route-methods supported in the action:
|
||||
|
||||
- **Service route-method**: Identified services are configured to target the green deployments.
|
||||
- **Ingress route-method**: Along with deployments, new services are created with '-green' suffix (for identified services), and the ingresses are in turn updated to target the new services.
|
||||
- **SMI route-method**: A new [TrafficSplit](https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md) object is created for each identified service. The TrafficSplit object is updated to target the new deployments. This works only if SMI is set up in the cluster.
|
||||
|
||||
Traffic is routed to the new workloads only after the time provided as `version-switch-buffer` input has passed. The `promote` action creates workloads and services with new configurations but without any suffix. `reject` routes traffic back to the old workloads and deletes the '-green' workloads.
|
||||
|
||||
## Action inputs
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Action inputs</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td>action </br></br>(Required)</td>
|
||||
<td>Acceptable values: deploy/promote/reject.</br>Promote or reject actions are used to promote or reject canary/blue-green deployments. Sample YAML snippets are provided below for guidance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>manifests </br></br>(Required)</td>
|
||||
<td>Path to the manifest files to be used for deployment. These can also be directories containing manifest files, in which case, all manifest files in the referenced directory at every depth will be deployed. Files not ending in .yml or .yaml will be ignored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>namespace </br></br>(Optional)
|
||||
<td>Namespace within the cluster to deploy to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>images </br></br>(Optional)</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>
|
||||
<code><br>images: |<br>  contosodemo.azurecr.io/foo:test1<br>  contosodemo.azurecr.io/bar:test2<br></code><br>
|
||||
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>imagepullsecrets </br></br>(Optional)</td>
|
||||
<td>Multiline input where each line contains the name of a docker-registry secret that has already been setup within the cluster. Each of these secret names are added under imagePullSecrets field for the workloads found in the input manifest files</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pull-images</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to pull the images from the registry before deployment to find out Dockerfile's path in order to add it to the annotations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>strategy </br></br>(Optional)</td>
|
||||
<td>Acceptable values: none/canary/blue-green. <br>
|
||||
Deployment strategy to be used while applying manifest files on the cluster.<br>none - No deployment strategy is used when deploying.<br>canary - Canary deployment strategy is used when deploying to the cluster.<br>blue-green - Blue-Green deployment strategy is used when deploying to cluster.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>traffic-split-method </br></br>(Optional)</td>
|
||||
<td>Acceptable values: pod/smi.<br> Default value: pod <br>SMI: Percentage traffic split is done at request level using service mesh. Service mesh has to be setup by cluster admin. Orchestration of <a href="https://github.com/servicemeshinterface/smi-spec/blob/master/apis/traffic-split/v1alpha3/traffic-split.md" data-raw-source="TrafficSplit](https://github.com/deislabs/smi-spec/blob/master/traffic-split.md)">TrafficSplit</a> objects of SMI is handled by this action. <br>Pod: Percentage split not possible at request level in the absence of service mesh. Percentage input is used to calculate the replicas for baseline and canary as a percentage of replicas specified in the input manifests for the stable variant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>percentage </br></br>(Optional but required if strategy is canary)</td>
|
||||
<td>Used to compute the number of replicas of '-baseline' and '-canary' 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 '-baseline' and '-canary'.<br/><br/>For example, if Deployment hello-world was found in the input manifest file with 'replicas: 4' and if 'strategy: canary' and 'percentage: 25' are given as inputs to the action, then the Deployments hello-world-baseline and hello-world-canary are created with 1 replica each. The '-baseline' variant is created with the same image and tag as the stable version (4 replica variant prior to deployment) while the '-canary' variant is created with the image and tag corresponding to the new changes being deployed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>baseline-and-canary-replicas </br></br> (Optional and relevant only if traffic-split-method is canary)</td>
|
||||
<td>The number of baseline and canary replicas. Percentage traffic split is controlled in the service mesh plane, the actual number of replicas for canary and baseline variants could be controlled independently of the traffic split. For example, assume that the input Deployment manifest desired 30 replicas to be used for stable and that the following inputs were specified for the action </br></br><code> strategy: canary<br> trafficSplitMethod: smi<br> percentage: 20<br> 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>
|
||||
<td>route-method </br></br>(Optional and relevant only if strategy is blue-green)</td>
|
||||
<td>Acceptable values: service/ingress/smi.</br>Default value: service.</br>Traffic is routed based on this input.
|
||||
<br>Service: Service selector labels are updated to target '-green' workloads.
|
||||
<br>Ingress: Ingress backends are updated to target the new '-green' services which in turn target '-green' deployments.
|
||||
<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>
|
||||
<tr>
|
||||
<td>version-switch-buffer </br></br>(Optional and relevant only if strategy is blue-green)</td>
|
||||
<td>Acceptable values: 1-300.</br>Default value: 0.</br>Waits for the given input in minutes before routing traffic to '-green' workloads.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>force </br></br>(Optional)</td>
|
||||
<td>Deploy when a previous deployment already exists. If true then '--force' argument is added to the apply command. Using '--force' argument is not recommended in production.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>annotate-namespace</br></br>(Optional)</td>
|
||||
<td>Acceptable values: true/false</br>Default value: true</br>Switch whether to annotate the namespace resources object or not</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic deployment (without any deployment strategy)
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
manifests: |
|
||||
dir/manifestsDirectory
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
```
|
||||
|
||||
### Canary deployment without service mesh
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: deploy
|
||||
percentage: 20
|
||||
```
|
||||
|
||||
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: promote # substitute reject if you want to reject
|
||||
```
|
||||
|
||||
### Canary deployment based on Service Mesh Interface
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
action: deploy
|
||||
traffic-split-method: smi
|
||||
percentage: 20
|
||||
baseline-and-canary-replicas: 1
|
||||
```
|
||||
|
||||
To promote/reject the canary created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }} "
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
dir/manifestsDirectory
|
||||
strategy: canary
|
||||
traffic-split-method: smi
|
||||
action: reject # substitute promote if you want to promote
|
||||
```
|
||||
|
||||
### Blue-Green deployment with different route methods
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
ingress.yml
|
||||
strategy: blue-green
|
||||
action: deploy
|
||||
route-method: ingress # substitute with service/smi as per need
|
||||
version-switch-buffer: 15
|
||||
```
|
||||
|
||||
To promote/reject the green workload created by the above snippet, the following YAML snippet could be used:
|
||||
|
||||
```yaml
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
namespace: "myapp"
|
||||
images: "contoso.azurecr.io/myapp:${{ event.run_id }}"
|
||||
imagepullsecrets: |
|
||||
image-pull-secret1
|
||||
image-pull-secret2
|
||||
manifests: |
|
||||
deployment.yaml
|
||||
service.yaml
|
||||
ingress.yml
|
||||
strategy: blue-green
|
||||
route-method: ingress # should be the same as the value when action was deploy
|
||||
action: promote # substitute reject if you want to reject
|
||||
```
|
||||
|
||||
## End to end workflows
|
||||
|
||||
Following are a few examples of not just this action, but how this action could be used along with other container and k8s related actions for building images and deploying objects onto k8s clusters:
|
||||
|
||||
### Build container image and deploy to Azure Kubernetes Service cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
|
||||
- uses: azure/setup-kubectl@v2.0
|
||||
|
||||
# Set the target AKS cluster.
|
||||
- uses: Azure/aks-set-context@v1
|
||||
with:
|
||||
creds: "${{ secrets.AZURE_CREDENTIALS }}"
|
||||
cluster-name: contoso
|
||||
resource-group: contoso-rg
|
||||
|
||||
- uses: Azure/k8s-create-secret@v1.1
|
||||
with:
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
action: deploy
|
||||
manifests: |
|
||||
manifests/deployment.yml
|
||||
manifests/service.yml
|
||||
images: |
|
||||
demo.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
imagepullsecrets: |
|
||||
demo-k8s-secret
|
||||
```
|
||||
|
||||
### Build container image and deploy to any Azure Kubernetes Service cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
|
||||
- uses: azure/setup-kubectl@v2.0
|
||||
|
||||
- uses: Azure/k8s-set-context@v2
|
||||
with:
|
||||
kubeconfig: ${{ secrets.KUBE_CONFIG }}
|
||||
|
||||
- uses: Azure/k8s-create-secret@v1.1
|
||||
with:
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: Azure/k8s-deploy@v3.1
|
||||
with:
|
||||
action: deploy
|
||||
manifests: |
|
||||
manifests/deployment.yml
|
||||
manifests/service.yml
|
||||
images: |
|
||||
demo.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
imagepullsecrets: |
|
||||
demo-k8s-secret
|
||||
```
|
||||
|
||||
### Build image and add `dockerfile-path` label to it
|
||||
|
||||
We can use this image in other workflows once built.
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
env:
|
||||
NAMESPACE: demo-ns2
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- run: |
|
||||
docker build . -t contoso.azurecr.io/k8sdemo:${{ github.sha }} --label dockerfile-path=https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile
|
||||
docker push contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
```
|
||||
|
||||
### Use bake action to get manifests deploying to a Kubernetes cluster
|
||||
|
||||
```yaml
|
||||
on: [push]
|
||||
env:
|
||||
NAMESPACE: demo-ns2
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- uses: Azure/docker-login@v1
|
||||
with:
|
||||
login-server: contoso.azurecr.io
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- uses: azure/setup-kubectl@v2.0
|
||||
|
||||
# Set the target AKS cluster.
|
||||
- uses: Azure/aks-set-context@v1
|
||||
with:
|
||||
creds: "${{ secrets.AZURE_CREDENTIALS }}"
|
||||
cluster-name: contoso
|
||||
resource-group: contoso-rg
|
||||
|
||||
- uses: Azure/k8s-create-secret@v1.1
|
||||
with:
|
||||
namespace: ${{ env.NAMESPACE }}
|
||||
container-registry-url: contoso.azurecr.io
|
||||
container-registry-username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
container-registry-password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
secret-name: demo-k8s-secret
|
||||
|
||||
- uses: azure/k8s-bake@v2
|
||||
with:
|
||||
renderEngine: "helm"
|
||||
helmChart: "./aks-helloworld/"
|
||||
overrideFiles: "./aks-helloworld/values-override.yaml"
|
||||
overrides: |
|
||||
replicas:2
|
||||
helm-version: "latest"
|
||||
id: bake
|
||||
|
||||
- uses: Azure/k8s-deploy@v1.2
|
||||
with:
|
||||
action: deploy
|
||||
manifests: ${{ steps.bake.outputs.manifestsBundle }}
|
||||
images: |
|
||||
contoso.azurecr.io/k8sdemo:${{ github.sha }}
|
||||
imagepullsecrets: |
|
||||
demo-k8s-secret
|
||||
```
|
||||
|
||||
## Traceability Fields Support
|
||||
|
||||
- Environment variable `HELM_CHART_PATHS` is a list of helmchart files expected by k8s-deploy - it will be populated automatically if you are using k8s-bake to generate the manifests.
|
||||
- Use script to build image and add dockerfile-path label to it. The value expected is the link to the dockerfile: https://github.com/${{github.repo}}/blob/${{github.sha}}/Dockerfile. If your dockerfile is in the same repo and branch where the workflow is run, it can be a relative path and it will be converted to a link for traceability.
|
||||
- Run docker login action for each image registry - in case image build and image deploy are two distinct jobs in the same or separate workflows.
|
||||
|
||||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
||||
|
||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
||||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
+35
-35
@@ -1,35 +1,35 @@
|
||||
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
|
||||
|
||||
## 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/).
|
||||
|
||||
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
|
||||
|
||||
**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).
|
||||
|
||||
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.)
|
||||
- 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)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
## Preferred Languages
|
||||
|
||||
We prefer all communications to be in English.
|
||||
|
||||
## Policy
|
||||
|
||||
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
|
||||
|
||||
<!-- END MICROSOFT SECURITY.MD BLOCK -->
|
||||
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.1 BLOCK -->
|
||||
|
||||
## 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/).
|
||||
|
||||
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
|
||||
|
||||
**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).
|
||||
|
||||
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.)
|
||||
* 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)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
## Preferred Languages
|
||||
|
||||
We prefer all communications to be in English.
|
||||
|
||||
## Policy
|
||||
|
||||
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
|
||||
|
||||
<!-- END MICROSOFT SECURITY.MD BLOCK -->
|
||||
+67
-92
@@ -1,92 +1,67 @@
|
||||
name: 'Deploy to Kubernetes cluster'
|
||||
description: 'Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters'
|
||||
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
|
||||
# You also need to have kubectl installed (azure/setup-kubectl)
|
||||
namespace:
|
||||
description: 'Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace.'
|
||||
required: false
|
||||
default: default
|
||||
manifests:
|
||||
description: 'Path to the manifest files which will be used for deployment.'
|
||||
required: true
|
||||
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'
|
||||
required: false
|
||||
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'
|
||||
required: false
|
||||
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"
|
||||
required: false
|
||||
default: true
|
||||
strategy:
|
||||
description: 'Deployment strategy to be used. Allowed values are basic, canary and blue-green'
|
||||
required: true
|
||||
default: 'basic'
|
||||
route-method:
|
||||
description: 'Route based on service, ingress or SMI for blue-green strategy'
|
||||
required: false
|
||||
default: 'service'
|
||||
version-switch-buffer:
|
||||
description: 'Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)'
|
||||
required: false
|
||||
default: 0
|
||||
traffic-split-method:
|
||||
description: 'Traffic split method to be used. Allowed values are pod and smi'
|
||||
required: false
|
||||
default: 'pod'
|
||||
traffic-split-annotations:
|
||||
description: 'Annotations in the form of key/value pair to be added to TrafficSplit. Relevant only if deployement strategy is blue-green or canary'
|
||||
required: false
|
||||
baseline-and-canary-replicas:
|
||||
description: 'Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)'
|
||||
required: false
|
||||
default: ''
|
||||
percentage:
|
||||
description: 'Percentage of traffic redirect to canary deployment'
|
||||
required: false
|
||||
default: 0
|
||||
action:
|
||||
description: 'deploy, promote, or reject'
|
||||
required: true
|
||||
default: 'deploy'
|
||||
force:
|
||||
description: 'Deploy when a previous deployment already exists. If true then --force argument is added to the apply command'
|
||||
required: false
|
||||
default: false
|
||||
token:
|
||||
description: 'Github token'
|
||||
default: ${{ github.token }}
|
||||
required: true
|
||||
annotate-resources:
|
||||
description: 'Annotate the resources. If set to false all annotations are skipped completely.'
|
||||
required: false
|
||||
default: true
|
||||
annotate-namespace:
|
||||
description: 'Annotate the target namespace. Ignored when annotate-resources is set to false.'
|
||||
required: false
|
||||
default: true
|
||||
private-cluster:
|
||||
description: 'True if cluster is AKS private cluster'
|
||||
required: false
|
||||
default: false
|
||||
resource-group:
|
||||
description: 'Name of resource group - Only required if using private cluster'
|
||||
required: false
|
||||
name:
|
||||
description: 'Resource group name - Only required if using private cluster'
|
||||
required: false
|
||||
skip-tls-verify:
|
||||
description: True if the insecure-skip-tls-verify option should be used. Input should be 'true' or 'false'.
|
||||
default: false
|
||||
resource-type:
|
||||
description: Either Microsoft.ContainerService/managedClusters or Microsoft.ContainerService/fleets'.
|
||||
required: false
|
||||
default: 'Microsoft.ContainerService/managedClusters'
|
||||
|
||||
branding:
|
||||
color: 'green'
|
||||
runs:
|
||||
using: 'node20'
|
||||
main: 'lib/index.js'
|
||||
name: "Deploy to Kubernetes cluster"
|
||||
description: "Deploy to a Kubernetes cluster including, but not limited to Azure Kubernetes Service (AKS) clusters"
|
||||
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
|
||||
# You also need to have kubectl installed (azure/setup-kubectl)
|
||||
namespace:
|
||||
description: "Choose the target Kubernetes namespace. If the namespace is not provided, the commands will run in the default namespace."
|
||||
required: false
|
||||
manifests:
|
||||
description: "Path to the manifest files which will be used for deployment."
|
||||
required: true
|
||||
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"
|
||||
required: false
|
||||
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"
|
||||
required: false
|
||||
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"
|
||||
required: false
|
||||
default: true
|
||||
strategy:
|
||||
description: "Deployment strategy to be used. Allowed values are none, canary and blue-green"
|
||||
required: false
|
||||
default: "none"
|
||||
route-method:
|
||||
description: "Route based on service, ingress or SMI for blue-green strategy"
|
||||
required: false
|
||||
default: "service"
|
||||
version-switch-buffer:
|
||||
description: "Indicates the buffer time in minutes before the switch is made to the green version (max is 300 min ie. 5hrs)"
|
||||
required: false
|
||||
default: 0
|
||||
traffic-split-method:
|
||||
description: "Traffic split method to be used. Allowed values are pod and smi"
|
||||
required: false
|
||||
default: "pod"
|
||||
baseline-and-canary-replicas:
|
||||
description: "Baseline and canary replicas count. Valid value between 0 to 100 (inclusive)"
|
||||
required: false
|
||||
default: 0
|
||||
percentage:
|
||||
description: "Percentage of traffic redirect to canary deployment"
|
||||
required: false
|
||||
default: 0
|
||||
action:
|
||||
description: "deploy, promote, or reject"
|
||||
required: true
|
||||
default: "deploy"
|
||||
force:
|
||||
description: "Deploy when a previous deployment already exists. If true then --force argument is added to the apply command"
|
||||
required: false
|
||||
default: false
|
||||
token:
|
||||
description: "Github token"
|
||||
default: ${{ github.token }}
|
||||
required: true
|
||||
annotate-namespace:
|
||||
description: "Annotate the target namespace"
|
||||
required: false
|
||||
default: true
|
||||
|
||||
branding:
|
||||
color: "green"
|
||||
runs:
|
||||
using: "node12"
|
||||
main: "lib/index.js"
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
module.exports = {
|
||||
presets: [
|
||||
['@babel/preset-env', {targets: {node: 'current'}}],
|
||||
'@babel/preset-typescript'
|
||||
]
|
||||
}
|
||||
+9
-19
@@ -1,20 +1,10 @@
|
||||
module.exports = {
|
||||
moduleFileExtensions: ['js', 'ts'],
|
||||
testEnvironment: 'node',
|
||||
testMatch: ['**/*.test.ts'],
|
||||
transform: {
|
||||
'\\.[jt]sx?$': 'babel-jest'
|
||||
},
|
||||
transformIgnorePatterns: [
|
||||
'node_modules/(?!' +
|
||||
[
|
||||
'@octokit',
|
||||
'universal-user-agent',
|
||||
'before-after-hook',
|
||||
'minimist'
|
||||
].join('|') +
|
||||
')'
|
||||
],
|
||||
verbose: true,
|
||||
testTimeout: 9000
|
||||
}
|
||||
clearMocks: true,
|
||||
moduleFileExtensions: ['js', 'ts'],
|
||||
testEnvironment: 'node',
|
||||
testMatch: ['**/*.test.ts'],
|
||||
transform: {
|
||||
'^.+\\.ts$': 'ts-jest'
|
||||
},
|
||||
verbose: true
|
||||
}
|
||||
-17991
File diff suppressed because it is too large
Load Diff
Generated
+10922
-8955
File diff suppressed because it is too large
Load Diff
+28
-38
@@ -1,38 +1,28 @@
|
||||
{
|
||||
"name": "k8s-deploy-action",
|
||||
"version": "5.0.0",
|
||||
"author": "Deepak Sattiraju",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"prebuild": "npm i @vercel/ncc",
|
||||
"build": "ncc build src/run.ts -o lib",
|
||||
"test": "jest",
|
||||
"coverage": "jest --coverage=true",
|
||||
"format": "prettier --write .",
|
||||
"format-check": "prettier --check ."
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.11.1",
|
||||
"@actions/exec": "^1.0.0",
|
||||
"@actions/io": "^1.1.3",
|
||||
"@actions/tool-cache": "2.0.2",
|
||||
"@babel/preset-env": "^7.26.9",
|
||||
"@babel/preset-typescript": "^7.27.0",
|
||||
"@octokit/core": "^6.1.4",
|
||||
"@octokit/plugin-retry": "^7.2.0",
|
||||
"@types/minipass": "^3.3.5",
|
||||
"js-yaml": "4.1.0",
|
||||
"minimist": "^1.2.8"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.14",
|
||||
"@types/js-yaml": "^4.0.9",
|
||||
"@types/minimist": "^1.2.5",
|
||||
"@types/node": "^22.14.0",
|
||||
"@vercel/ncc": "^0.38.3",
|
||||
"jest": "^29.7.0",
|
||||
"prettier": "^3.5.3",
|
||||
"ts-jest": "^29.3.1",
|
||||
"typescript": "5.8.3"
|
||||
}
|
||||
}
|
||||
{
|
||||
"name": "k8s-deploy-action",
|
||||
"version": "0.0.0",
|
||||
"author": "Deepak Sattiraju",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "tsc --outDir ./lib --rootDir ./src",
|
||||
"test": "jest"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/core": "^1.2.6",
|
||||
"@actions/exec": "^1.0.0",
|
||||
"@actions/io": "^1.0.0",
|
||||
"@actions/tool-cache": "1.1.2",
|
||||
"@octokit/core": "^3.5.1",
|
||||
"@octokit/plugin-retry": "^3.0.9",
|
||||
"@types/minipass": "^3.1.2",
|
||||
"js-yaml": "3.13.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^26.0.0",
|
||||
"@types/js-yaml": "^3.12.7",
|
||||
"@types/node": "^12.20.41",
|
||||
"jest": "^26.0.0",
|
||||
"ts-jest": "^25.5.1",
|
||||
"typescript": "3.9.5"
|
||||
}
|
||||
}
|
||||
|
||||
+75
-69
@@ -1,79 +1,85 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as models from '../types/kubernetesTypes'
|
||||
import * as KubernetesConstants from '../types/kubernetesTypes'
|
||||
import {Kubectl, Resource} from '../types/kubectl'
|
||||
import * as core from "@actions/core";
|
||||
import * as models from "../types/kubernetesTypes";
|
||||
import * as KubernetesConstants from "../types/kubernetesTypes";
|
||||
import { Kubectl, Resource } from "../types/kubectl";
|
||||
import {
|
||||
getResources,
|
||||
updateManifestFiles
|
||||
} from '../utilities/manifestUpdateUtils'
|
||||
getResources,
|
||||
updateManifestFiles,
|
||||
} from "../utilities/manifestUpdateUtils";
|
||||
import { routeBlueGreen } from "../strategyHelpers/blueGreen/blueGreenHelper";
|
||||
import {
|
||||
annotateAndLabelResources,
|
||||
checkManifestStability,
|
||||
deployManifests
|
||||
} from '../strategyHelpers/deploymentHelper'
|
||||
import {DeploymentStrategy} from '../types/deploymentStrategy'
|
||||
import {parseTrafficSplitMethod} from '../types/trafficSplitMethod'
|
||||
import {ClusterType} from '../inputUtils'
|
||||
export const ResourceTypeManagedCluster =
|
||||
'Microsoft.ContainerService/managedClusters'
|
||||
export const ResourceTypeFleet = 'Microsoft.ContainerService/fleets'
|
||||
annotateAndLabelResources,
|
||||
checkManifestStability,
|
||||
deployManifests,
|
||||
} from "../strategyHelpers/deploymentHelper";
|
||||
import { DeploymentStrategy } from "../types/deploymentStrategy";
|
||||
import { parseTrafficSplitMethod } from "../types/trafficSplitMethod";
|
||||
import { parseRouteStrategy } from "../types/routeStrategy";
|
||||
|
||||
export async function deploy(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
deploymentStrategy: DeploymentStrategy,
|
||||
resourceType: ClusterType
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
deploymentStrategy: DeploymentStrategy
|
||||
) {
|
||||
// update manifests
|
||||
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths)
|
||||
core.debug(`Input manifest files: ${inputManifestFiles}`)
|
||||
// update manifests
|
||||
const inputManifestFiles: string[] = updateManifestFiles(manifestFilePaths);
|
||||
core.debug("Input manifest files: " + inputManifestFiles);
|
||||
|
||||
// deploy manifests
|
||||
core.startGroup('Deploying manifests')
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput('traffic-split-method', {required: true})
|
||||
)
|
||||
const deployedManifestFiles = await deployManifests(
|
||||
inputManifestFiles,
|
||||
deploymentStrategy,
|
||||
kubectl,
|
||||
trafficSplitMethod
|
||||
)
|
||||
core.debug(`Deployed manifest files: ${deployedManifestFiles}`)
|
||||
core.endGroup()
|
||||
// deploy manifests
|
||||
core.info("Deploying manifests");
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput("traffic-split-method", { required: true })
|
||||
);
|
||||
const deployedManifestFiles = await deployManifests(
|
||||
inputManifestFiles,
|
||||
deploymentStrategy,
|
||||
kubectl,
|
||||
trafficSplitMethod
|
||||
);
|
||||
core.debug("Deployed manifest files: " + deployedManifestFiles);
|
||||
|
||||
// check manifest stability
|
||||
core.startGroup('Checking manifest stability')
|
||||
const resourceTypes: Resource[] = getResources(
|
||||
deployedManifestFiles,
|
||||
models.DEPLOYMENT_TYPES.concat([
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
|
||||
])
|
||||
)
|
||||
// check manifest stability
|
||||
core.info("Checking manifest stability");
|
||||
const resourceTypes: Resource[] = getResources(
|
||||
deployedManifestFiles,
|
||||
models.DEPLOYMENT_TYPES.concat([
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
|
||||
])
|
||||
);
|
||||
await checkManifestStability(kubectl, resourceTypes);
|
||||
|
||||
await checkManifestStability(kubectl, resourceTypes, resourceType)
|
||||
core.endGroup()
|
||||
if (deploymentStrategy == DeploymentStrategy.BLUE_GREEN) {
|
||||
core.info("Routing blue green");
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput("route-method", { required: true })
|
||||
);
|
||||
await routeBlueGreen(kubectl, inputManifestFiles, routeStrategy);
|
||||
}
|
||||
|
||||
// print ingresses
|
||||
core.startGroup('Printing ingresses')
|
||||
const ingressResources: Resource[] = getResources(deployedManifestFiles, [
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS
|
||||
])
|
||||
for (const ingressResource of ingressResources) {
|
||||
await kubectl.getResource(
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
|
||||
ingressResource.name,
|
||||
false,
|
||||
ingressResource.namespace
|
||||
)
|
||||
}
|
||||
core.endGroup()
|
||||
// print ingresses
|
||||
core.info("Printing ingresses");
|
||||
const ingressResources: Resource[] = getResources(deployedManifestFiles, [
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
|
||||
]);
|
||||
for (const ingressResource of ingressResources) {
|
||||
await kubectl.getResource(
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.INGRESS,
|
||||
ingressResource.name
|
||||
);
|
||||
}
|
||||
|
||||
// annotate resources
|
||||
core.startGroup('Annotating resources')
|
||||
await annotateAndLabelResources(
|
||||
deployedManifestFiles,
|
||||
kubectl,
|
||||
resourceTypes
|
||||
)
|
||||
core.endGroup()
|
||||
// annotate resources
|
||||
core.info("Annotating resources");
|
||||
let allPods;
|
||||
try {
|
||||
allPods = JSON.parse((await kubectl.getAllPods()).stdout);
|
||||
} catch (e) {
|
||||
core.debug("Unable to parse pods: " + e);
|
||||
}
|
||||
await annotateAndLabelResources(
|
||||
deployedManifestFiles,
|
||||
kubectl,
|
||||
resourceTypes,
|
||||
allPods
|
||||
);
|
||||
}
|
||||
|
||||
+172
-228
@@ -1,228 +1,172 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
|
||||
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
|
||||
import * as PodCanaryHelper from '../strategyHelpers/canary/podCanaryHelper'
|
||||
import {
|
||||
getResources,
|
||||
updateManifestFiles
|
||||
} from '../utilities/manifestUpdateUtils'
|
||||
import {annotateAndLabelResources} from '../strategyHelpers/deploymentHelper'
|
||||
import * as models from '../types/kubernetesTypes'
|
||||
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
|
||||
import {
|
||||
deleteGreenObjects,
|
||||
getManifestObjects,
|
||||
NONE_LABEL_VALUE
|
||||
} from '../strategyHelpers/blueGreen/blueGreenHelper'
|
||||
|
||||
import {BlueGreenManifests} from '../types/blueGreenTypes'
|
||||
import {DeployResult} from '../types/deployResult'
|
||||
|
||||
import {
|
||||
promoteBlueGreenIngress,
|
||||
promoteBlueGreenService,
|
||||
promoteBlueGreenSMI
|
||||
} from '../strategyHelpers/blueGreen/promote'
|
||||
|
||||
import {
|
||||
routeBlueGreenService,
|
||||
routeBlueGreenIngressUnchanged,
|
||||
routeBlueGreenSMI
|
||||
} from '../strategyHelpers/blueGreen/route'
|
||||
|
||||
import {cleanupSMI} from '../strategyHelpers/blueGreen/smiBlueGreenHelper'
|
||||
import {Kubectl, Resource} from '../types/kubectl'
|
||||
import {DeploymentStrategy} from '../types/deploymentStrategy'
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod
|
||||
} from '../types/trafficSplitMethod'
|
||||
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
|
||||
import {ClusterType} from '../inputUtils'
|
||||
|
||||
export async function promote(
|
||||
kubectl: Kubectl,
|
||||
manifests: string[],
|
||||
deploymentStrategy: DeploymentStrategy,
|
||||
resourceType: ClusterType
|
||||
) {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY:
|
||||
await promoteCanary(kubectl, manifests)
|
||||
break
|
||||
case DeploymentStrategy.BLUE_GREEN:
|
||||
await promoteBlueGreen(kubectl, manifests, resourceType)
|
||||
break
|
||||
default:
|
||||
throw Error('Invalid promote deployment strategy')
|
||||
}
|
||||
}
|
||||
|
||||
async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
|
||||
let includeServices = false
|
||||
|
||||
const manifestFilesForDeployment: string[] = updateManifestFiles(manifests)
|
||||
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput('traffic-split-method', {required: true})
|
||||
)
|
||||
let promoteResult: DeployResult
|
||||
let filesToAnnotate: string[]
|
||||
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
|
||||
includeServices = true
|
||||
|
||||
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
|
||||
// canary deployment, then update stable deployment and then redirect traffic to stable deployment
|
||||
core.startGroup('Redirecting traffic to canary deployment')
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
)
|
||||
core.endGroup()
|
||||
|
||||
core.startGroup(
|
||||
'Deploying input manifests with SMI canary strategy from promote'
|
||||
)
|
||||
|
||||
promoteResult = await SMICanaryDeploymentHelper.deploySMICanary(
|
||||
manifestFilesForDeployment,
|
||||
kubectl,
|
||||
true
|
||||
)
|
||||
|
||||
core.endGroup()
|
||||
|
||||
core.startGroup('Redirecting traffic to stable deployment')
|
||||
const stableRedirectManifests =
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
)
|
||||
|
||||
filesToAnnotate = promoteResult.manifestFiles.concat(
|
||||
stableRedirectManifests
|
||||
)
|
||||
|
||||
core.endGroup()
|
||||
} else {
|
||||
core.startGroup('Deploying input manifests from promote')
|
||||
promoteResult = await PodCanaryHelper.deployPodCanary(
|
||||
manifestFilesForDeployment,
|
||||
kubectl,
|
||||
true
|
||||
)
|
||||
filesToAnnotate = promoteResult.manifestFiles
|
||||
core.endGroup()
|
||||
}
|
||||
|
||||
core.startGroup('Deleting canary and baseline workloads')
|
||||
try {
|
||||
await canaryDeploymentHelper.deleteCanaryDeployment(
|
||||
kubectl,
|
||||
manifests,
|
||||
includeServices
|
||||
)
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Exception occurred while deleting canary and baseline workloads: ${ex}`
|
||||
)
|
||||
}
|
||||
core.endGroup()
|
||||
|
||||
// annotate resources
|
||||
core.startGroup('Annotating resources')
|
||||
const resources: Resource[] = getResources(
|
||||
filesToAnnotate,
|
||||
models.DEPLOYMENT_TYPES.concat([
|
||||
models.DiscoveryAndLoadBalancerResource.SERVICE
|
||||
])
|
||||
)
|
||||
await annotateAndLabelResources(filesToAnnotate, kubectl, resources)
|
||||
core.endGroup()
|
||||
}
|
||||
|
||||
async function promoteBlueGreen(
|
||||
kubectl: Kubectl,
|
||||
manifests: string[],
|
||||
resourceType: ClusterType
|
||||
) {
|
||||
// update container images and pull secrets
|
||||
const inputManifestFiles: string[] = updateManifestFiles(manifests)
|
||||
const manifestObjects: BlueGreenManifests =
|
||||
getManifestObjects(inputManifestFiles)
|
||||
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput('route-method', {required: true})
|
||||
)
|
||||
|
||||
core.startGroup('Deleting old deployment and making new stable deployment')
|
||||
|
||||
const {deployResult} = await (async () => {
|
||||
switch (routeStrategy) {
|
||||
case RouteStrategy.INGRESS:
|
||||
return await promoteBlueGreenIngress(kubectl, manifestObjects)
|
||||
case RouteStrategy.SMI:
|
||||
return await promoteBlueGreenSMI(kubectl, manifestObjects)
|
||||
default:
|
||||
return await promoteBlueGreenService(kubectl, manifestObjects)
|
||||
}
|
||||
})()
|
||||
|
||||
core.endGroup()
|
||||
|
||||
// checking stability of newly created deployments
|
||||
core.startGroup('Checking manifest stability')
|
||||
const deployedManifestFiles = deployResult.manifestFiles
|
||||
const resources: Resource[] = getResources(
|
||||
deployedManifestFiles,
|
||||
models.DEPLOYMENT_TYPES.concat([
|
||||
models.DiscoveryAndLoadBalancerResource.SERVICE
|
||||
])
|
||||
)
|
||||
await KubernetesManifestUtility.checkManifestStability(
|
||||
kubectl,
|
||||
resources,
|
||||
resourceType
|
||||
)
|
||||
core.endGroup()
|
||||
|
||||
core.startGroup(
|
||||
'Routing to new deployments and deleting old workloads and services'
|
||||
)
|
||||
if (routeStrategy == RouteStrategy.INGRESS) {
|
||||
await routeBlueGreenIngressUnchanged(
|
||||
kubectl,
|
||||
manifestObjects.serviceNameMap,
|
||||
manifestObjects.ingressEntityList
|
||||
)
|
||||
|
||||
await deleteGreenObjects(
|
||||
kubectl,
|
||||
[].concat(
|
||||
manifestObjects.deploymentEntityList,
|
||||
manifestObjects.serviceEntityList
|
||||
)
|
||||
)
|
||||
} else if (routeStrategy == RouteStrategy.SMI) {
|
||||
await routeBlueGreenSMI(
|
||||
kubectl,
|
||||
NONE_LABEL_VALUE,
|
||||
manifestObjects.serviceEntityList
|
||||
)
|
||||
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
|
||||
await cleanupSMI(kubectl, manifestObjects.serviceEntityList)
|
||||
} else {
|
||||
await routeBlueGreenService(
|
||||
kubectl,
|
||||
NONE_LABEL_VALUE,
|
||||
manifestObjects.serviceEntityList
|
||||
)
|
||||
await deleteGreenObjects(kubectl, manifestObjects.deploymentEntityList)
|
||||
}
|
||||
core.endGroup()
|
||||
|
||||
// annotate resources
|
||||
core.startGroup('Annotating resources')
|
||||
await annotateAndLabelResources(deployedManifestFiles, kubectl, resources)
|
||||
core.endGroup()
|
||||
}
|
||||
import * as core from "@actions/core";
|
||||
import * as deploy from "./deploy";
|
||||
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
|
||||
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
|
||||
import {
|
||||
getResources,
|
||||
updateManifestFiles,
|
||||
} from "../utilities/manifestUpdateUtils";
|
||||
import * as models from "../types/kubernetesTypes";
|
||||
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
|
||||
import {
|
||||
BlueGreenManifests,
|
||||
deleteWorkloadsAndServicesWithLabel,
|
||||
deleteWorkloadsWithLabel,
|
||||
getManifestObjects,
|
||||
GREEN_LABEL_VALUE,
|
||||
NONE_LABEL_VALUE,
|
||||
} from "../strategyHelpers/blueGreen/blueGreenHelper";
|
||||
import {
|
||||
promoteBlueGreenService,
|
||||
routeBlueGreenService,
|
||||
} from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
|
||||
import {
|
||||
promoteBlueGreenIngress,
|
||||
routeBlueGreenIngress,
|
||||
} from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
|
||||
import {
|
||||
cleanupSMI,
|
||||
promoteBlueGreenSMI,
|
||||
routeBlueGreenSMI,
|
||||
} from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
|
||||
import { Kubectl, Resource } from "../types/kubectl";
|
||||
import { DeploymentStrategy } from "../types/deploymentStrategy";
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod,
|
||||
} from "../types/trafficSplitMethod";
|
||||
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
|
||||
|
||||
export async function promote(
|
||||
kubectl: Kubectl,
|
||||
manifests: string[],
|
||||
deploymentStrategy: DeploymentStrategy
|
||||
) {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY:
|
||||
await promoteCanary(kubectl, manifests);
|
||||
break;
|
||||
case DeploymentStrategy.BLUE_GREEN:
|
||||
await promoteBlueGreen(kubectl, manifests);
|
||||
break;
|
||||
default:
|
||||
throw Error("Invalid promote deployment strategy");
|
||||
}
|
||||
}
|
||||
|
||||
async function promoteCanary(kubectl: Kubectl, manifests: string[]) {
|
||||
let includeServices = false;
|
||||
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput("traffic-split-method", { required: true })
|
||||
);
|
||||
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
|
||||
includeServices = true;
|
||||
|
||||
// In case of SMI traffic split strategy when deployment is promoted, first we will redirect traffic to
|
||||
// canary deployment, then update stable deployment and then redirect traffic to stable deployment
|
||||
core.info("Redirecting traffic to canary deployment");
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToCanaryDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
);
|
||||
|
||||
core.info("Deploying input manifests with SMI canary strategy");
|
||||
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
|
||||
|
||||
core.info("Redirecting traffic to stable deployment");
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
);
|
||||
} else {
|
||||
core.info("Deploying input manifests");
|
||||
await deploy.deploy(kubectl, manifests, DeploymentStrategy.CANARY);
|
||||
}
|
||||
|
||||
core.info("Deleting canary and baseline workloads");
|
||||
try {
|
||||
await canaryDeploymentHelper.deleteCanaryDeployment(
|
||||
kubectl,
|
||||
manifests,
|
||||
includeServices
|
||||
);
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
"Exception occurred while deleting canary and baseline workloads: " + ex
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
async function promoteBlueGreen(kubectl: Kubectl, manifests: string[]) {
|
||||
// update container images and pull secrets
|
||||
const inputManifestFiles: string[] = updateManifestFiles(manifests);
|
||||
const manifestObjects: BlueGreenManifests =
|
||||
getManifestObjects(inputManifestFiles);
|
||||
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput("route-method", { required: true })
|
||||
);
|
||||
|
||||
core.info("Deleting old deployment and making new one");
|
||||
let result;
|
||||
if (routeStrategy == RouteStrategy.INGRESS) {
|
||||
result = await promoteBlueGreenIngress(kubectl, manifestObjects);
|
||||
} else if (routeStrategy == RouteStrategy.SMI) {
|
||||
result = await promoteBlueGreenSMI(kubectl, manifestObjects);
|
||||
} else {
|
||||
result = await promoteBlueGreenService(kubectl, manifestObjects);
|
||||
}
|
||||
|
||||
// checking stability of newly created deployments
|
||||
core.info("Checking manifest stability");
|
||||
const deployedManifestFiles = result.newFilePaths;
|
||||
const resources: Resource[] = getResources(
|
||||
deployedManifestFiles,
|
||||
models.DEPLOYMENT_TYPES.concat([
|
||||
models.DiscoveryAndLoadBalancerResource.SERVICE,
|
||||
])
|
||||
);
|
||||
await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
|
||||
|
||||
core.info(
|
||||
"Routing to new deployments and deleting old workloads and services"
|
||||
);
|
||||
if (routeStrategy == RouteStrategy.INGRESS) {
|
||||
await routeBlueGreenIngress(
|
||||
kubectl,
|
||||
null,
|
||||
manifestObjects.serviceNameMap,
|
||||
manifestObjects.ingressEntityList
|
||||
);
|
||||
await deleteWorkloadsAndServicesWithLabel(
|
||||
kubectl,
|
||||
GREEN_LABEL_VALUE,
|
||||
manifestObjects.deploymentEntityList,
|
||||
manifestObjects.serviceEntityList
|
||||
);
|
||||
} else if (routeStrategy == RouteStrategy.SMI) {
|
||||
await routeBlueGreenSMI(
|
||||
kubectl,
|
||||
NONE_LABEL_VALUE,
|
||||
manifestObjects.serviceEntityList
|
||||
);
|
||||
await deleteWorkloadsWithLabel(
|
||||
kubectl,
|
||||
GREEN_LABEL_VALUE,
|
||||
manifestObjects.deploymentEntityList
|
||||
);
|
||||
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
|
||||
} else {
|
||||
await routeBlueGreenService(
|
||||
kubectl,
|
||||
NONE_LABEL_VALUE,
|
||||
manifestObjects.serviceEntityList
|
||||
);
|
||||
await deleteWorkloadsWithLabel(
|
||||
kubectl,
|
||||
GREEN_LABEL_VALUE,
|
||||
manifestObjects.deploymentEntityList
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
+68
-77
@@ -1,77 +1,68 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as canaryDeploymentHelper from '../strategyHelpers/canary/canaryHelper'
|
||||
import * as SMICanaryDeploymentHelper from '../strategyHelpers/canary/smiCanaryHelper'
|
||||
import {Kubectl} from '../types/kubectl'
|
||||
import {BlueGreenManifests} from '../types/blueGreenTypes'
|
||||
import {
|
||||
rejectBlueGreenIngress,
|
||||
rejectBlueGreenService,
|
||||
rejectBlueGreenSMI
|
||||
} from '../strategyHelpers/blueGreen/reject'
|
||||
import {getManifestObjects} from '../strategyHelpers/blueGreen/blueGreenHelper'
|
||||
import {DeploymentStrategy} from '../types/deploymentStrategy'
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod
|
||||
} from '../types/trafficSplitMethod'
|
||||
import {parseRouteStrategy, RouteStrategy} from '../types/routeStrategy'
|
||||
|
||||
export async function reject(
|
||||
kubectl: Kubectl,
|
||||
manifests: string[],
|
||||
deploymentStrategy: DeploymentStrategy
|
||||
) {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY:
|
||||
await rejectCanary(kubectl, manifests)
|
||||
break
|
||||
case DeploymentStrategy.BLUE_GREEN:
|
||||
await rejectBlueGreen(kubectl, manifests)
|
||||
break
|
||||
default:
|
||||
throw 'Invalid delete deployment strategy'
|
||||
}
|
||||
}
|
||||
|
||||
async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
|
||||
let includeServices = false
|
||||
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput('traffic-split-method', {required: true})
|
||||
)
|
||||
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
|
||||
core.startGroup('Rejecting deployment with SMI canary strategy')
|
||||
includeServices = true
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
)
|
||||
core.endGroup()
|
||||
}
|
||||
|
||||
core.startGroup('Deleting baseline and canary workloads')
|
||||
await canaryDeploymentHelper.deleteCanaryDeployment(
|
||||
kubectl,
|
||||
manifests,
|
||||
includeServices
|
||||
)
|
||||
core.endGroup()
|
||||
}
|
||||
|
||||
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput('route-method', {required: true})
|
||||
)
|
||||
core.startGroup('Rejecting deployment with blue green strategy')
|
||||
core.info(`using routeMethod ${routeStrategy}`)
|
||||
const manifestObjects: BlueGreenManifests = getManifestObjects(manifests)
|
||||
|
||||
if (routeStrategy == RouteStrategy.INGRESS) {
|
||||
await rejectBlueGreenIngress(kubectl, manifestObjects)
|
||||
} else if (routeStrategy == RouteStrategy.SMI) {
|
||||
await rejectBlueGreenSMI(kubectl, manifestObjects)
|
||||
} else {
|
||||
await rejectBlueGreenService(kubectl, manifestObjects)
|
||||
}
|
||||
core.endGroup()
|
||||
}
|
||||
import * as core from "@actions/core";
|
||||
import * as canaryDeploymentHelper from "../strategyHelpers/canary/canaryHelper";
|
||||
import * as SMICanaryDeploymentHelper from "../strategyHelpers/canary/smiCanaryHelper";
|
||||
import { Kubectl } from "../types/kubectl";
|
||||
import { rejectBlueGreenService } from "../strategyHelpers/blueGreen/serviceBlueGreenHelper";
|
||||
import { rejectBlueGreenIngress } from "../strategyHelpers/blueGreen/ingressBlueGreenHelper";
|
||||
import { rejectBlueGreenSMI } from "../strategyHelpers/blueGreen/smiBlueGreenHelper";
|
||||
import { DeploymentStrategy } from "../types/deploymentStrategy";
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod,
|
||||
} from "../types/trafficSplitMethod";
|
||||
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
|
||||
|
||||
export async function reject(
|
||||
kubectl: Kubectl,
|
||||
manifests: string[],
|
||||
deploymentStrategy: DeploymentStrategy
|
||||
) {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY:
|
||||
await rejectCanary(kubectl, manifests);
|
||||
break;
|
||||
case DeploymentStrategy.BLUE_GREEN:
|
||||
await rejectBlueGreen(kubectl, manifests);
|
||||
break;
|
||||
default:
|
||||
throw "Invalid delete deployment strategy";
|
||||
}
|
||||
}
|
||||
|
||||
async function rejectCanary(kubectl: Kubectl, manifests: string[]) {
|
||||
let includeServices = false;
|
||||
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput("traffic-split-method", { required: true })
|
||||
);
|
||||
if (trafficSplitMethod == TrafficSplitMethod.SMI) {
|
||||
core.info("Rejecting deployment with SMI canary strategy");
|
||||
includeServices = true;
|
||||
await SMICanaryDeploymentHelper.redirectTrafficToStableDeployment(
|
||||
kubectl,
|
||||
manifests
|
||||
);
|
||||
}
|
||||
|
||||
core.info("Deleting baseline and canary workloads");
|
||||
await canaryDeploymentHelper.deleteCanaryDeployment(
|
||||
kubectl,
|
||||
manifests,
|
||||
includeServices
|
||||
);
|
||||
}
|
||||
|
||||
async function rejectBlueGreen(kubectl: Kubectl, manifests: string[]) {
|
||||
core.info("Rejecting deployment with blue green strategy");
|
||||
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput("route-method", { required: true })
|
||||
);
|
||||
if (routeStrategy == RouteStrategy.INGRESS) {
|
||||
await rejectBlueGreenIngress(kubectl, manifests);
|
||||
} else if (routeStrategy == RouteStrategy.SMI) {
|
||||
await rejectBlueGreenSMI(kubectl, manifests);
|
||||
} else {
|
||||
await rejectBlueGreenService(kubectl, manifests);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
import {parseResourceTypeInput} from './inputUtils'
|
||||
import {
|
||||
ClusterType,
|
||||
ResourceTypeFleet,
|
||||
ResourceTypeManagedCluster
|
||||
} from './actions/deploy'
|
||||
|
||||
describe('InputUtils', () => {
|
||||
describe('parseResourceTypeInput', () => {
|
||||
it('should extract fleet exact match resource type', () => {
|
||||
expect(
|
||||
parseResourceTypeInput('Microsoft.ContainerService/fleets')
|
||||
).toEqual(ResourceTypeFleet)
|
||||
})
|
||||
it('should match fleet case-insensitively', () => {
|
||||
expect(
|
||||
parseResourceTypeInput('Microsoft.containerservice/fleets')
|
||||
).toEqual(ResourceTypeFleet)
|
||||
})
|
||||
it('should match managed cluster case-insensitively', () => {
|
||||
expect(
|
||||
parseResourceTypeInput('Microsoft.containerservice/MAnaGedClusterS')
|
||||
).toEqual(ResourceTypeManagedCluster)
|
||||
})
|
||||
it('should error on unexpected values', () => {
|
||||
expect(() => {
|
||||
parseResourceTypeInput('icrosoft.ContainerService/ManagedCluster')
|
||||
}).toThrow()
|
||||
expect(() => {
|
||||
parseResourceTypeInput('wrong-value')
|
||||
}).toThrow()
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,32 +0,0 @@
|
||||
import * as core from '@actions/core'
|
||||
import {parseAnnotations} from './types/annotations'
|
||||
import {ResourceTypeFleet, ResourceTypeManagedCluster} from './actions/deploy'
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
export function parseResourceTypeInput(rawInput: string): ClusterType {
|
||||
switch (rawInput.toLowerCase()) {
|
||||
case ResourceTypeFleet.toLowerCase():
|
||||
return ResourceTypeFleet
|
||||
case ResourceTypeManagedCluster.toLowerCase():
|
||||
return ResourceTypeManagedCluster
|
||||
}
|
||||
throw new Error(
|
||||
`Invalid resource type: ${rawInput}. Supported resource types are: ${ResourceTypeManagedCluster} (default), ${ResourceTypeFleet}`
|
||||
)
|
||||
}
|
||||
export type ClusterType =
|
||||
| typeof ResourceTypeManagedCluster
|
||||
| typeof ResourceTypeFleet
|
||||
+56
-87
@@ -1,87 +1,56 @@
|
||||
import * as core from '@actions/core'
|
||||
import {getKubectlPath, Kubectl} from './types/kubectl'
|
||||
import {
|
||||
deploy,
|
||||
ResourceTypeFleet,
|
||||
ResourceTypeManagedCluster
|
||||
} from './actions/deploy'
|
||||
import {ClusterType} from './inputUtils'
|
||||
import {promote} from './actions/promote'
|
||||
import {reject} from './actions/reject'
|
||||
import {Action, parseAction} from './types/action'
|
||||
import {parseDeploymentStrategy} from './types/deploymentStrategy'
|
||||
import {getFilesFromDirectoriesAndURLs} from './utilities/fileUtils'
|
||||
import {PrivateKubectl} from './types/privatekubectl'
|
||||
import {parseResourceTypeInput} from './inputUtils'
|
||||
|
||||
export async function run() {
|
||||
// verify kubeconfig is set
|
||||
if (!process.env['KUBECONFIG'])
|
||||
core.warning(
|
||||
'KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action.'
|
||||
)
|
||||
|
||||
// get inputs
|
||||
const action: Action | undefined = parseAction(
|
||||
core.getInput('action', {required: true})
|
||||
)
|
||||
const strategy = parseDeploymentStrategy(core.getInput('strategy'))
|
||||
const manifestsInput = core.getInput('manifests', {required: true})
|
||||
const manifestFilePaths = manifestsInput
|
||||
.split(/[\n,;]+/) // split into each individual manifest
|
||||
.map((manifest) => manifest.trim()) // remove surrounding whitespace
|
||||
.filter((manifest) => manifest.length > 0) // remove any blanks
|
||||
|
||||
const fullManifestFilePaths =
|
||||
await getFilesFromDirectoriesAndURLs(manifestFilePaths)
|
||||
const kubectlPath = await getKubectlPath()
|
||||
const namespace = core.getInput('namespace') || 'default'
|
||||
const isPrivateCluster =
|
||||
core.getInput('private-cluster').toLowerCase() === 'true'
|
||||
const resourceGroup = core.getInput('resource-group') || ''
|
||||
const resourceName = core.getInput('name') || ''
|
||||
const skipTlsVerify = core.getBooleanInput('skip-tls-verify')
|
||||
|
||||
let resourceType: ClusterType
|
||||
try {
|
||||
// included in the trycatch to allow raw input to go out of scope after parsing
|
||||
const resourceTypeInput = core.getInput('resource-type')
|
||||
resourceType = parseResourceTypeInput(resourceTypeInput)
|
||||
} catch (e) {
|
||||
core.setFailed(e)
|
||||
return
|
||||
}
|
||||
|
||||
const kubectl = isPrivateCluster
|
||||
? new PrivateKubectl(
|
||||
kubectlPath,
|
||||
namespace,
|
||||
skipTlsVerify,
|
||||
resourceGroup,
|
||||
resourceName
|
||||
)
|
||||
: new Kubectl(kubectlPath, namespace, skipTlsVerify)
|
||||
|
||||
// run action
|
||||
switch (action) {
|
||||
case Action.DEPLOY: {
|
||||
await deploy(kubectl, fullManifestFilePaths, strategy, resourceType)
|
||||
break
|
||||
}
|
||||
case Action.PROMOTE: {
|
||||
await promote(kubectl, fullManifestFilePaths, strategy, resourceType)
|
||||
break
|
||||
}
|
||||
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)
|
||||
import * as core from "@actions/core";
|
||||
import { getKubectlPath, Kubectl } from "./types/kubectl";
|
||||
import { deploy } from "./actions/deploy";
|
||||
import { promote } from "./actions/promote";
|
||||
import { reject } from "./actions/reject";
|
||||
import { Action, parseAction } from "./types/action";
|
||||
import { parseDeploymentStrategy } from "./types/deploymentStrategy";
|
||||
import { getFilesFromDirectories } from "./utilities/fileUtils";
|
||||
|
||||
export async function run() {
|
||||
// verify kubeconfig is set
|
||||
if (!process.env["KUBECONFIG"])
|
||||
core.warning(
|
||||
"KUBECONFIG env is not explicitly set. Ensure cluster context is set by using k8s-set-context action."
|
||||
);
|
||||
|
||||
// get inputs
|
||||
const action: Action | undefined = parseAction(
|
||||
core.getInput("action", { required: true })
|
||||
);
|
||||
const strategy = parseDeploymentStrategy(core.getInput("strategy"));
|
||||
const manifestsInput = core.getInput("manifests", { required: true });
|
||||
const manifestFilePaths = manifestsInput
|
||||
.split(/[\n,;]+/) // split into each individual manifest
|
||||
.map((manifest) => manifest.trim()) // remove surrounding whitespace
|
||||
.filter((manifest) => manifest.length > 0); // remove any blanks
|
||||
|
||||
const fullManifestFilePaths = getFilesFromDirectories(manifestFilePaths)
|
||||
// create kubectl
|
||||
const kubectlPath = await getKubectlPath();
|
||||
const namespace = core.getInput("namespace") || "default";
|
||||
const kubectl = new Kubectl(kubectlPath, namespace, true);
|
||||
|
||||
// run action
|
||||
switch (action) {
|
||||
case Action.DEPLOY: {
|
||||
await deploy(kubectl, fullManifestFilePaths, strategy);
|
||||
break;
|
||||
}
|
||||
case Action.PROMOTE: {
|
||||
await promote(kubectl, fullManifestFilePaths, strategy);
|
||||
break;
|
||||
}
|
||||
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')
|
||||
})
|
||||
})
|
||||
@@ -1,276 +1,355 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
|
||||
import {DeployResult} from '../../types/deployResult'
|
||||
import {K8sObject, K8sDeleteObject} from '../../types/k8sObject'
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import * as core from "@actions/core";
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import {
|
||||
isDeploymentEntity,
|
||||
isIngressEntity,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload
|
||||
} from '../../types/kubernetesTypes'
|
||||
isDeploymentEntity,
|
||||
isIngressEntity,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload,
|
||||
} from "../../types/kubernetesTypes";
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import { routeBlueGreenService } from "./serviceBlueGreenHelper";
|
||||
import { routeBlueGreenIngress } from "./ingressBlueGreenHelper";
|
||||
import { routeBlueGreenSMI } from "./smiBlueGreenHelper";
|
||||
import {
|
||||
BlueGreenDeployment,
|
||||
BlueGreenManifests
|
||||
} from '../../types/blueGreenTypes'
|
||||
import * as fileHelper from '../../utilities/fileUtils'
|
||||
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
|
||||
import {checkForErrors} from '../../utilities/kubectlUtils'
|
||||
import {
|
||||
UnsetClusterSpecificDetails,
|
||||
updateObjectLabels,
|
||||
updateSelectorLabels
|
||||
} from '../../utilities/manifestUpdateUtils'
|
||||
UnsetClusterSpecificDetails,
|
||||
updateObjectLabels,
|
||||
updateSelectorLabels,
|
||||
} from "../../utilities/manifestUpdateUtils";
|
||||
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
|
||||
import { checkForErrors } from "../../utilities/kubectlUtils";
|
||||
import { sleep } from "../../utilities/timeUtils";
|
||||
import { RouteStrategy } from "../../types/routeStrategy";
|
||||
|
||||
export const GREEN_LABEL_VALUE = 'green'
|
||||
export const NONE_LABEL_VALUE = 'None'
|
||||
export const BLUE_GREEN_VERSION_LABEL = 'k8s.deploy.color'
|
||||
export const GREEN_SUFFIX = '-green'
|
||||
export const STABLE_SUFFIX = '-stable'
|
||||
export const GREEN_LABEL_VALUE = "green";
|
||||
export const NONE_LABEL_VALUE = "None";
|
||||
export const BLUE_GREEN_VERSION_LABEL = "k8s.deploy.color";
|
||||
export const GREEN_SUFFIX = "-green";
|
||||
export const STABLE_SUFFIX = "-stable";
|
||||
|
||||
export async function deleteGreenObjects(
|
||||
kubectl: Kubectl,
|
||||
toDelete: K8sObject[]
|
||||
): Promise<K8sDeleteObject[]> {
|
||||
// const resourcesToDelete: K8sDeleteObject[] = []
|
||||
const resourcesToDelete: K8sDeleteObject[] = toDelete.map((obj) => {
|
||||
return {
|
||||
name: getBlueGreenResourceName(obj.metadata.name, GREEN_SUFFIX),
|
||||
kind: obj.kind,
|
||||
namespace: obj.metadata.namespace
|
||||
}
|
||||
})
|
||||
|
||||
core.debug(`deleting green objects: ${JSON.stringify(resourcesToDelete)}`)
|
||||
|
||||
await deleteObjects(kubectl, resourcesToDelete)
|
||||
return resourcesToDelete
|
||||
export interface BlueGreenManifests {
|
||||
serviceEntityList: any[];
|
||||
serviceNameMap: Map<string, string>;
|
||||
unroutedServiceEntityList: any[];
|
||||
deploymentEntityList: any[];
|
||||
ingressEntityList: any[];
|
||||
otherObjects: any[];
|
||||
}
|
||||
|
||||
export async function deleteObjects(
|
||||
kubectl: Kubectl,
|
||||
deleteList: K8sDeleteObject[]
|
||||
export async function routeBlueGreen(
|
||||
kubectl: Kubectl,
|
||||
inputManifestFiles: string[],
|
||||
routeStrategy: RouteStrategy
|
||||
) {
|
||||
// delete services and deployments
|
||||
for (const delObject of deleteList) {
|
||||
try {
|
||||
const result = await kubectl.delete([delObject.kind, delObject.name])
|
||||
checkForErrors([result])
|
||||
} catch (ex) {
|
||||
core.debug(`failed to delete object ${delObject.name}: ${ex}`)
|
||||
}
|
||||
}
|
||||
// sleep for buffer time
|
||||
const bufferTime: number = parseInt(
|
||||
core.getInput("version-switch-buffer") || "0"
|
||||
);
|
||||
if (bufferTime < 0 || bufferTime > 300)
|
||||
throw Error("Version switch buffer must be between 0 and 300 (inclusive)");
|
||||
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
|
||||
export function getManifestObjects(filePaths: string[]): BlueGreenManifests {
|
||||
const deploymentEntityList: K8sObject[] = []
|
||||
const serviceEntityList: K8sObject[] = []
|
||||
const routedServiceEntityList: K8sObject[] = []
|
||||
const unroutedServiceEntityList: K8sObject[] = []
|
||||
const ingressEntityList: K8sObject[] = []
|
||||
const otherEntitiesList: K8sObject[] = []
|
||||
const serviceNameMap = new Map<string, string>()
|
||||
const deploymentEntityList = [];
|
||||
const routedServiceEntityList = [];
|
||||
const unroutedServiceEntityList = [];
|
||||
const ingressEntityList = [];
|
||||
const otherEntitiesList = [];
|
||||
const serviceNameMap = new Map<string, string>();
|
||||
|
||||
// Manifest objects per type. All resources should be parsed and
|
||||
// organized before we can check if services are “routed” or not.
|
||||
filePaths.forEach((filePath: string) => {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
yaml.loadAll(fileContents, (inputObject: any) => {
|
||||
if (!!inputObject) {
|
||||
const kind = inputObject.kind
|
||||
if (isDeploymentEntity(kind)) {
|
||||
deploymentEntityList.push(inputObject)
|
||||
} else if (isServiceEntity(kind)) {
|
||||
serviceEntityList.push(inputObject)
|
||||
} else if (isIngressEntity(kind)) {
|
||||
ingressEntityList.push(inputObject)
|
||||
} else {
|
||||
otherEntitiesList.push(inputObject)
|
||||
}
|
||||
}
|
||||
})
|
||||
} catch (error) {
|
||||
core.error(`Error processing file ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
filePaths.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
yaml.safeLoadAll(fileContents, (inputObject) => {
|
||||
if (!!inputObject) {
|
||||
const kind = inputObject.kind;
|
||||
const name = inputObject.metadata.name;
|
||||
|
||||
if (isDeploymentEntity(kind)) {
|
||||
deploymentEntityList.push(inputObject);
|
||||
} else if (isServiceEntity(kind)) {
|
||||
if (isServiceRouted(inputObject, deploymentEntityList)) {
|
||||
routedServiceEntityList.push(inputObject);
|
||||
serviceNameMap.set(
|
||||
name,
|
||||
getBlueGreenResourceName(name, GREEN_SUFFIX)
|
||||
);
|
||||
} else {
|
||||
unroutedServiceEntityList.push(inputObject);
|
||||
}
|
||||
} else if (isIngressEntity(kind)) {
|
||||
ingressEntityList.push(inputObject);
|
||||
} else {
|
||||
otherEntitiesList.push(inputObject);
|
||||
}
|
||||
}
|
||||
})
|
||||
});
|
||||
});
|
||||
|
||||
serviceEntityList.forEach((inputObject: any) => {
|
||||
if (isServiceRouted(inputObject, deploymentEntityList)) {
|
||||
const name = inputObject.metadata.name
|
||||
routedServiceEntityList.push(inputObject)
|
||||
serviceNameMap.set(name, getBlueGreenResourceName(name, GREEN_SUFFIX))
|
||||
} else {
|
||||
unroutedServiceEntityList.push(inputObject)
|
||||
}
|
||||
})
|
||||
|
||||
return {
|
||||
serviceEntityList: routedServiceEntityList,
|
||||
serviceNameMap: serviceNameMap,
|
||||
unroutedServiceEntityList: unroutedServiceEntityList,
|
||||
deploymentEntityList: deploymentEntityList,
|
||||
ingressEntityList: ingressEntityList,
|
||||
otherObjects: otherEntitiesList
|
||||
}
|
||||
return {
|
||||
serviceEntityList: routedServiceEntityList,
|
||||
serviceNameMap: serviceNameMap,
|
||||
unroutedServiceEntityList: unroutedServiceEntityList,
|
||||
deploymentEntityList: deploymentEntityList,
|
||||
ingressEntityList: ingressEntityList,
|
||||
otherObjects: otherEntitiesList,
|
||||
};
|
||||
}
|
||||
|
||||
export function isServiceRouted(
|
||||
serviceObject: any[],
|
||||
deploymentEntityList: any[]
|
||||
serviceObject: any[],
|
||||
deploymentEntityList: any[]
|
||||
): boolean {
|
||||
const serviceSelector: any = getServiceSelector(serviceObject)
|
||||
|
||||
return (
|
||||
serviceSelector &&
|
||||
let shouldBeRouted: boolean = false;
|
||||
const serviceSelector: any = getServiceSelector(serviceObject);
|
||||
if (serviceSelector) {
|
||||
if (
|
||||
deploymentEntityList.some((depObject) => {
|
||||
// finding if there is a deployment in the given manifests the service targets
|
||||
const matchLabels: any = getDeploymentMatchLabels(depObject)
|
||||
return (
|
||||
matchLabels &&
|
||||
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
|
||||
)
|
||||
// finding if there is a deployment in the given manifests the service targets
|
||||
const matchLabels: any = getDeploymentMatchLabels(depObject);
|
||||
return (
|
||||
matchLabels &&
|
||||
isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)
|
||||
);
|
||||
})
|
||||
)
|
||||
) {
|
||||
shouldBeRouted = true;
|
||||
}
|
||||
}
|
||||
|
||||
return shouldBeRouted;
|
||||
}
|
||||
|
||||
export async function deployWithLabel(
|
||||
kubectl: Kubectl,
|
||||
deploymentObjectList: any[],
|
||||
nextLabel: string
|
||||
): Promise<BlueGreenDeployment> {
|
||||
const newObjectsList = deploymentObjectList.map((inputObject) =>
|
||||
getNewBlueGreenObject(inputObject, nextLabel)
|
||||
)
|
||||
export async function createWorkloadsWithLabel(
|
||||
kubectl: Kubectl,
|
||||
deploymentObjectList: any[],
|
||||
nextLabel: string
|
||||
) {
|
||||
const newObjectsList = [];
|
||||
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(
|
||||
`objects deployed with label are ${JSON.stringify(newObjectsList)}`
|
||||
)
|
||||
const deployResult = await deployObjects(kubectl, newObjectsList)
|
||||
return {deployResult, objects: newObjectsList}
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
const result = await kubectl.apply(manifestFiles);
|
||||
|
||||
return { result: result, newFilePaths: manifestFiles };
|
||||
}
|
||||
|
||||
export function getNewBlueGreenObject(
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
): K8sObject {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
): object {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject));
|
||||
|
||||
// Updating name only if label is green label is given
|
||||
if (labelValue === GREEN_LABEL_VALUE) {
|
||||
newObject.metadata.name = getBlueGreenResourceName(
|
||||
inputObject.metadata.name,
|
||||
GREEN_SUFFIX
|
||||
)
|
||||
}
|
||||
// Updating name only if label is green label is given
|
||||
if (labelValue === GREEN_LABEL_VALUE) {
|
||||
newObject.metadata.name = getBlueGreenResourceName(
|
||||
inputObject.metadata.name,
|
||||
GREEN_SUFFIX
|
||||
);
|
||||
}
|
||||
|
||||
// Adding labels and annotations
|
||||
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
|
||||
return newObject
|
||||
// Adding labels and annotations
|
||||
addBlueGreenLabelsAndAnnotations(newObject, labelValue);
|
||||
return newObject;
|
||||
}
|
||||
|
||||
export function addBlueGreenLabelsAndAnnotations(
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
) {
|
||||
//creating the k8s.deploy.color label
|
||||
const newLabels = new Map<string, string>()
|
||||
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue
|
||||
//creating the k8s.deploy.color label
|
||||
const newLabels = new Map<string, string>();
|
||||
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
|
||||
|
||||
// updating object labels and selector labels
|
||||
updateObjectLabels(inputObject, newLabels, false)
|
||||
updateSelectorLabels(inputObject, newLabels, false)
|
||||
// updating object labels and selector labels
|
||||
updateObjectLabels(inputObject, newLabels, false);
|
||||
updateSelectorLabels(inputObject, newLabels, false);
|
||||
|
||||
// updating spec labels if it is not a service
|
||||
if (!isServiceEntity(inputObject.kind)) {
|
||||
updateSpecLabels(inputObject, newLabels, false)
|
||||
}
|
||||
// updating spec labels if it is a service
|
||||
if (!isServiceEntity(inputObject.kind)) {
|
||||
updateSpecLabels(inputObject, newLabels, false);
|
||||
}
|
||||
}
|
||||
|
||||
export function getBlueGreenResourceName(name: string, suffix: string) {
|
||||
return `${name}${suffix}`
|
||||
return `${name}${suffix}`;
|
||||
}
|
||||
|
||||
export function getDeploymentMatchLabels(deploymentObject: any): any {
|
||||
if (
|
||||
deploymentObject?.kind?.toUpperCase() ==
|
||||
KubernetesWorkload.POD.toUpperCase() &&
|
||||
deploymentObject?.metadata?.labels
|
||||
) {
|
||||
return deploymentObject.metadata.labels
|
||||
} else if (deploymentObject?.spec?.selector?.matchLabels) {
|
||||
return deploymentObject.spec.selector.matchLabels
|
||||
}
|
||||
if (
|
||||
deploymentObject?.kind?.toUpperCase() ==
|
||||
KubernetesWorkload.POD.toUpperCase() &&
|
||||
deploymentObject?.metadata?.labels
|
||||
) {
|
||||
return deploymentObject.metadata.labels;
|
||||
} else if (deploymentObject?.spec?.selector?.matchLabels) {
|
||||
return deploymentObject.spec.selector.matchLabels;
|
||||
}
|
||||
}
|
||||
|
||||
export function getServiceSelector(serviceObject: any): any {
|
||||
if (serviceObject?.spec?.selector) {
|
||||
return serviceObject.spec.selector
|
||||
}
|
||||
if (serviceObject?.spec?.selector) {
|
||||
return serviceObject.spec.selector;
|
||||
}
|
||||
}
|
||||
|
||||
export function isServiceSelectorSubsetOfMatchLabel(
|
||||
serviceSelector: any,
|
||||
matchLabels: any
|
||||
serviceSelector: any,
|
||||
matchLabels: any
|
||||
): boolean {
|
||||
const serviceSelectorMap = new Map()
|
||||
const matchLabelsMap = new Map()
|
||||
const serviceSelectorMap = new Map();
|
||||
const matchLabelsMap = new Map();
|
||||
|
||||
JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
|
||||
serviceSelectorMap.set(key, value)
|
||||
})
|
||||
JSON.parse(JSON.stringify(serviceSelector), (key, value) => {
|
||||
serviceSelectorMap.set(key, value);
|
||||
});
|
||||
|
||||
JSON.parse(JSON.stringify(matchLabels), (key, value) => {
|
||||
matchLabelsMap.set(key, value)
|
||||
})
|
||||
JSON.parse(JSON.stringify(matchLabels), (key, value) => {
|
||||
matchLabelsMap.set(key, value);
|
||||
});
|
||||
|
||||
let isMatch = true
|
||||
serviceSelectorMap.forEach((value, key) => {
|
||||
if (
|
||||
!!key &&
|
||||
(!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value
|
||||
)
|
||||
isMatch = false
|
||||
})
|
||||
let isMatch = true;
|
||||
serviceSelectorMap.forEach((value, key) => {
|
||||
if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value)
|
||||
isMatch = false;
|
||||
});
|
||||
|
||||
return isMatch
|
||||
return isMatch;
|
||||
}
|
||||
|
||||
export async function fetchResource(
|
||||
kubectl: Kubectl,
|
||||
kind: string,
|
||||
name: string,
|
||||
namespace?: string
|
||||
): Promise<K8sObject> {
|
||||
const result = await kubectl.getResource(kind, name, false, namespace)
|
||||
if (result == null || !!result.stderr) {
|
||||
return null
|
||||
}
|
||||
kubectl: Kubectl,
|
||||
kind: string,
|
||||
name: string
|
||||
) {
|
||||
const result = await kubectl.getResource(kind, name);
|
||||
if (result == null || !!result.stderr) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!!result.stdout) {
|
||||
const resource = JSON.parse(result.stdout) as K8sObject
|
||||
if (!!result.stdout) {
|
||||
const resource = JSON.parse(result.stdout);
|
||||
|
||||
try {
|
||||
UnsetClusterSpecificDetails(resource)
|
||||
return resource
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while Parsing ${resource} in Json object: ${ex}`
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function deployObjects(
|
||||
kubectl: Kubectl,
|
||||
objectsList: any[]
|
||||
): Promise<DeployResult> {
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(objectsList)
|
||||
const execResult = await kubectl.apply(manifestFiles)
|
||||
|
||||
return {execResult, manifestFiles}
|
||||
try {
|
||||
UnsetClusterSpecificDetails(resource);
|
||||
return resource;
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while Parsing ${resource} in Json object: ${ex}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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(6)
|
||||
})
|
||||
|
||||
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')
|
||||
}
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,159 +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'
|
||||
import {DeployResult} from '../../types/deployResult'
|
||||
|
||||
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')
|
||||
const routeDeployment = await routeBlueGreenForDeploy(
|
||||
kubectl,
|
||||
files,
|
||||
routeStrategy
|
||||
)
|
||||
core.endGroup()
|
||||
|
||||
blueGreenDeployment.objects.push(...routeDeployment.objects)
|
||||
blueGreenDeployment.deployResult.manifestFiles.push(
|
||||
...routeDeployment.deployResult.manifestFiles
|
||||
)
|
||||
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
|
||||
)
|
||||
|
||||
const otherObjDeployment: DeployResult = await deployObjects(
|
||||
kubectl,
|
||||
newObjectsList
|
||||
)
|
||||
|
||||
// make extraservices and trafficsplit
|
||||
const smiAndSvcDeployment = await setupSMI(
|
||||
kubectl,
|
||||
manifestObjects.serviceEntityList
|
||||
)
|
||||
|
||||
// create new deloyments
|
||||
const blueGreenDeployment: BlueGreenDeployment = await deployWithLabel(
|
||||
kubectl,
|
||||
manifestObjects.deploymentEntityList,
|
||||
GREEN_LABEL_VALUE
|
||||
)
|
||||
|
||||
blueGreenDeployment.objects.push(...newObjectsList)
|
||||
blueGreenDeployment.objects.push(...smiAndSvcDeployment.objects)
|
||||
|
||||
blueGreenDeployment.deployResult.manifestFiles.push(
|
||||
...otherObjDeployment.manifestFiles
|
||||
)
|
||||
blueGreenDeployment.deployResult.manifestFiles.push(
|
||||
...smiAndSvcDeployment.deployResult.manifestFiles
|
||||
)
|
||||
|
||||
return blueGreenDeployment
|
||||
}
|
||||
|
||||
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,121 +1,229 @@
|
||||
import * as core from '@actions/core'
|
||||
import {K8sIngress} from '../../types/k8sObject'
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import {
|
||||
addBlueGreenLabelsAndAnnotations,
|
||||
BLUE_GREEN_VERSION_LABEL,
|
||||
GREEN_LABEL_VALUE,
|
||||
fetchResource
|
||||
} from './blueGreenHelper'
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
addBlueGreenLabelsAndAnnotations,
|
||||
BLUE_GREEN_VERSION_LABEL,
|
||||
BlueGreenManifests,
|
||||
createWorkloadsWithLabel,
|
||||
deleteWorkloadsAndServicesWithLabel,
|
||||
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(
|
||||
inputObject: any,
|
||||
serviceNameMap: Map<string, string>,
|
||||
type: string
|
||||
): K8sIngress {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
// add green labels and values
|
||||
addBlueGreenLabelsAndAnnotations(newObject, type)
|
||||
export async function deployBlueGreenIngress(
|
||||
kubectl: Kubectl,
|
||||
filePaths: string[]
|
||||
) {
|
||||
// get all kubernetes objects defined in manifest files
|
||||
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
|
||||
|
||||
// update ingress labels
|
||||
if (inputObject.apiVersion === 'networking.k8s.io/v1beta1') {
|
||||
return updateIngressBackendBetaV1(newObject, serviceNameMap)
|
||||
}
|
||||
return updateIngressBackend(newObject, serviceNameMap)
|
||||
// create deployments with green label value
|
||||
const result = createWorkloadsWithLabel(
|
||||
kubectl,
|
||||
manifestObjects.deploymentEntityList,
|
||||
GREEN_LABEL_VALUE
|
||||
);
|
||||
|
||||
// create new services and other objects
|
||||
let newObjectsList = [];
|
||||
manifestObjects.serviceEntityList.forEach((inputObject) => {
|
||||
const newBlueGreenObject = getNewBlueGreenObject(
|
||||
inputObject,
|
||||
GREEN_LABEL_VALUE
|
||||
);
|
||||
newObjectsList.push(newBlueGreenObject);
|
||||
});
|
||||
newObjectsList = newObjectsList
|
||||
.concat(manifestObjects.otherObjects)
|
||||
.concat(manifestObjects.unroutedServiceEntityList);
|
||||
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
await kubectl.apply(manifestFiles);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
export function updateIngressBackendBetaV1(
|
||||
inputObject: any,
|
||||
serviceNameMap: Map<string, string>
|
||||
): any {
|
||||
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
|
||||
if (key.toLowerCase() === BACKEND) {
|
||||
const {serviceName} = value
|
||||
if (serviceNameMap.has(serviceName)) {
|
||||
// update service name with corresponding bluegreen name only if service is provied in given manifests
|
||||
value.serviceName = serviceNameMap.get(serviceName)
|
||||
}
|
||||
export async function promoteBlueGreenIngress(
|
||||
kubectl: Kubectl,
|
||||
manifestObjects
|
||||
) {
|
||||
//checking if anything to promote
|
||||
if (
|
||||
!validateIngressesState(
|
||||
kubectl,
|
||||
manifestObjects.ingressEntityList,
|
||||
manifestObjects.serviceNameMap
|
||||
)
|
||||
) {
|
||||
throw "Ingress not in promote state";
|
||||
}
|
||||
|
||||
// create stable deployments with new configuration
|
||||
const result = createWorkloadsWithLabel(
|
||||
kubectl,
|
||||
manifestObjects.deploymentEntityList,
|
||||
NONE_LABEL_VALUE
|
||||
);
|
||||
|
||||
// create stable services with new configuration
|
||||
const newObjectsList = [];
|
||||
manifestObjects.serviceEntityList.forEach((inputObject) => {
|
||||
const newBlueGreenObject = getNewBlueGreenObject(
|
||||
inputObject,
|
||||
NONE_LABEL_VALUE
|
||||
);
|
||||
newObjectsList.push(newBlueGreenObject);
|
||||
});
|
||||
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
await kubectl.apply(manifestFiles);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
export async function rejectBlueGreenIngress(
|
||||
kubectl: Kubectl,
|
||||
filePaths: string[]
|
||||
) {
|
||||
// get all kubernetes objects defined in manifest files
|
||||
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
|
||||
|
||||
// route ingress to stables services
|
||||
await routeBlueGreenIngress(
|
||||
kubectl,
|
||||
null,
|
||||
manifestObjects.serviceNameMap,
|
||||
manifestObjects.ingressEntityList
|
||||
);
|
||||
|
||||
// delete green services and deployments
|
||||
await deleteWorkloadsAndServicesWithLabel(
|
||||
kubectl,
|
||||
GREEN_LABEL_VALUE,
|
||||
manifestObjects.deploymentEntityList,
|
||||
manifestObjects.serviceEntityList
|
||||
);
|
||||
}
|
||||
|
||||
export async function routeBlueGreenIngress(
|
||||
kubectl: Kubectl,
|
||||
nextLabel: string,
|
||||
serviceNameMap: Map<string, string>,
|
||||
ingressEntityList: any[]
|
||||
) {
|
||||
let newObjectsList = [];
|
||||
|
||||
if (!nextLabel) {
|
||||
newObjectsList = ingressEntityList.filter((ingress) =>
|
||||
isIngressRouted(ingress, serviceNameMap)
|
||||
);
|
||||
} else {
|
||||
ingressEntityList.forEach((inputObject) => {
|
||||
if (isIngressRouted(inputObject, serviceNameMap)) {
|
||||
const newBlueGreenIngressObject = getUpdatedBlueGreenIngress(
|
||||
inputObject,
|
||||
serviceNameMap,
|
||||
GREEN_LABEL_VALUE
|
||||
);
|
||||
newObjectsList.push(newBlueGreenIngressObject);
|
||||
} else {
|
||||
newObjectsList.push(inputObject);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
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(
|
||||
inputObject: any,
|
||||
serviceNameMap: Map<string, string>
|
||||
inputObject: any,
|
||||
serviceNameMap: Map<string, string>
|
||||
): any {
|
||||
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
|
||||
if (
|
||||
key.toLowerCase() === BACKEND &&
|
||||
serviceNameMap.has(value.service.name)
|
||||
) {
|
||||
value.service.name = serviceNameMap.get(value.service.name)
|
||||
inputObject = JSON.parse(JSON.stringify(inputObject), (key, value) => {
|
||||
if (key.toUpperCase() === BACKEND) {
|
||||
const { serviceName } = value;
|
||||
if (serviceNameMap.has(serviceName)) {
|
||||
// update service name with corresponding bluegreen name only if service is provied in given manifests
|
||||
value.serviceName = serviceNameMap.get(serviceName);
|
||||
}
|
||||
return value
|
||||
})
|
||||
}
|
||||
|
||||
return inputObject
|
||||
}
|
||||
|
||||
export function isIngressRouted(
|
||||
ingressObject: any,
|
||||
serviceNameMap: Map<string, string>
|
||||
): boolean {
|
||||
let isIngressRouted: boolean = false
|
||||
// check if ingress targets a service in the given manifests
|
||||
JSON.parse(JSON.stringify(ingressObject), (key, value) => {
|
||||
isIngressRouted =
|
||||
isIngressRouted ||
|
||||
(key === 'service' &&
|
||||
value.hasOwnProperty('name') &&
|
||||
serviceNameMap.has(value.name))
|
||||
isIngressRouted =
|
||||
isIngressRouted || (key === 'serviceName' && serviceNameMap.has(value))
|
||||
|
||||
return value
|
||||
})
|
||||
|
||||
return isIngressRouted
|
||||
}
|
||||
|
||||
export async function validateIngresses(
|
||||
kubectl: Kubectl,
|
||||
ingressEntityList: any[],
|
||||
serviceNameMap: Map<string, string>
|
||||
): Promise<{areValid: boolean; invalidIngresses: string[]}> {
|
||||
let areValid: boolean = true
|
||||
const invalidIngresses = []
|
||||
|
||||
for (const inputObject of ingressEntityList) {
|
||||
if (isIngressRouted(inputObject, serviceNameMap)) {
|
||||
//querying existing ingress
|
||||
const existingIngress = await fetchResource(
|
||||
kubectl,
|
||||
inputObject.kind,
|
||||
inputObject.metadata.name,
|
||||
inputObject?.metadata?.namespace
|
||||
)
|
||||
|
||||
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}
|
||||
return value;
|
||||
});
|
||||
|
||||
return inputObject;
|
||||
}
|
||||
|
||||
@@ -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()
|
||||
})
|
||||
})
|
||||
@@ -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(2)
|
||||
})
|
||||
})
|
||||
@@ -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)}
|
||||
}
|
||||
@@ -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)
|
||||
})
|
||||
})
|
||||
@@ -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,50 +1,146 @@
|
||||
import * as core from '@actions/core'
|
||||
import {K8sServiceObject} from '../../types/k8sObject'
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import {
|
||||
addBlueGreenLabelsAndAnnotations,
|
||||
BLUE_GREEN_VERSION_LABEL,
|
||||
fetchResource,
|
||||
GREEN_LABEL_VALUE
|
||||
} from './blueGreenHelper'
|
||||
addBlueGreenLabelsAndAnnotations,
|
||||
BLUE_GREEN_VERSION_LABEL,
|
||||
BlueGreenManifests,
|
||||
createWorkloadsWithLabel,
|
||||
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
|
||||
export function getUpdatedBlueGreenService(
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
): K8sServiceObject {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
function getUpdatedBlueGreenService(
|
||||
inputObject: any,
|
||||
labelValue: string
|
||||
): object {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject));
|
||||
|
||||
// Adding labels and annotations.
|
||||
addBlueGreenLabelsAndAnnotations(newObject, labelValue)
|
||||
return newObject
|
||||
// Adding labels and annotations.
|
||||
addBlueGreenLabelsAndAnnotations(newObject, labelValue);
|
||||
return newObject;
|
||||
}
|
||||
|
||||
export async function validateServicesState(
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
): Promise<boolean> {
|
||||
let areServicesGreen: boolean = true
|
||||
let areServicesGreen: boolean = true;
|
||||
|
||||
for (const serviceObject of serviceEntityList) {
|
||||
// finding the existing routed service
|
||||
const existingService = await fetchResource(
|
||||
kubectl,
|
||||
serviceObject.kind,
|
||||
serviceObject.metadata.name,
|
||||
serviceObject?.metadata?.namespace
|
||||
)
|
||||
for (const serviceObject of serviceEntityList) {
|
||||
// finding the existing routed service
|
||||
const existingService = await fetchResource(
|
||||
kubectl,
|
||||
serviceObject.kind,
|
||||
serviceObject.metadata.name
|
||||
);
|
||||
|
||||
let isServiceGreen =
|
||||
!!existingService &&
|
||||
getServiceSpecLabel(existingService as K8sServiceObject) ==
|
||||
GREEN_LABEL_VALUE
|
||||
areServicesGreen = areServicesGreen && isServiceGreen
|
||||
}
|
||||
if (!!existingService) {
|
||||
const currentLabel: string = getServiceSpecLabel(existingService);
|
||||
if (currentLabel != GREEN_LABEL_VALUE) {
|
||||
// service should be targeting deployments with green label
|
||||
areServicesGreen = false;
|
||||
}
|
||||
} else {
|
||||
// service targeting deployment doesn't exist
|
||||
areServicesGreen = false;
|
||||
}
|
||||
}
|
||||
|
||||
return areServicesGreen
|
||||
return areServicesGreen;
|
||||
}
|
||||
|
||||
export function getServiceSpecLabel(inputObject: K8sServiceObject): string {
|
||||
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL]
|
||||
export function getServiceSpecLabel(inputObject: any): string {
|
||||
if (inputObject?.spec?.selector[BLUE_GREEN_VERSION_LABEL]) {
|
||||
return inputObject.spec.selector[BLUE_GREEN_VERSION_LABEL];
|
||||
}
|
||||
|
||||
return "";
|
||||
}
|
||||
|
||||
@@ -1,200 +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(1)
|
||||
expect(deleteObjects[0].name).toBe('nginx-service-green')
|
||||
expect(deleteObjects[0].kind).toBe('Service')
|
||||
})
|
||||
})
|
||||
@@ -1,195 +1,272 @@
|
||||
import * as core from '@actions/core'
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as kubectlUtils from "../../utilities/trafficSplitUtils";
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import {
|
||||
deleteObjects,
|
||||
deployObjects,
|
||||
fetchResource,
|
||||
getBlueGreenResourceName,
|
||||
getNewBlueGreenObject,
|
||||
GREEN_LABEL_VALUE,
|
||||
GREEN_SUFFIX,
|
||||
NONE_LABEL_VALUE,
|
||||
STABLE_SUFFIX
|
||||
} from './blueGreenHelper'
|
||||
import {BlueGreenDeployment} from '../../types/blueGreenTypes'
|
||||
import {
|
||||
K8sDeleteObject,
|
||||
K8sObject,
|
||||
TrafficSplitObject
|
||||
} from '../../types/k8sObject'
|
||||
import {DeployResult} from '../../types/deployResult'
|
||||
import {inputAnnotations} from '../../inputUtils'
|
||||
BlueGreenManifests,
|
||||
createWorkloadsWithLabel,
|
||||
deleteObjects,
|
||||
deleteWorkloadsWithLabel,
|
||||
fetchResource,
|
||||
getBlueGreenResourceName,
|
||||
getManifestObjects,
|
||||
getNewBlueGreenObject,
|
||||
GREEN_LABEL_VALUE,
|
||||
GREEN_SUFFIX,
|
||||
NONE_LABEL_VALUE,
|
||||
STABLE_SUFFIX,
|
||||
} from "./blueGreenHelper";
|
||||
|
||||
export const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-trafficsplit'
|
||||
export const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
|
||||
export const MIN_VAL = 0
|
||||
export const MAX_VAL = 100
|
||||
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-trafficsplit";
|
||||
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
|
||||
const MIN_VAL = 0;
|
||||
const MAX_VAL = 100;
|
||||
|
||||
export async function setupSMI(
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
): Promise<BlueGreenDeployment> {
|
||||
const newObjectsList = []
|
||||
const trafficObjectList = []
|
||||
export async function deployBlueGreenSMI(
|
||||
kubectl: Kubectl,
|
||||
filePaths: string[]
|
||||
) {
|
||||
// get all kubernetes objects defined in manifest files
|
||||
const manifestObjects: BlueGreenManifests = getManifestObjects(filePaths);
|
||||
|
||||
serviceEntityList.forEach((serviceObject) => {
|
||||
// create a trafficsplit for service
|
||||
trafficObjectList.push(serviceObject)
|
||||
// set up the services for trafficsplit
|
||||
const newStableService = getStableSMIServiceResource(serviceObject)
|
||||
const newGreenService = getGreenSMIServiceResource(serviceObject)
|
||||
newObjectsList.push(newStableService)
|
||||
newObjectsList.push(newGreenService)
|
||||
})
|
||||
// create services and other objects
|
||||
const newObjectsList = manifestObjects.otherObjects
|
||||
.concat(manifestObjects.serviceEntityList)
|
||||
.concat(manifestObjects.ingressEntityList)
|
||||
.concat(manifestObjects.unroutedServiceEntityList);
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
await kubectl.apply(manifestFiles);
|
||||
|
||||
const tsObjects: TrafficSplitObject[] = []
|
||||
// route to stable service
|
||||
for (const svc of trafficObjectList) {
|
||||
const tsObject = await createTrafficSplitObject(
|
||||
kubectl,
|
||||
svc.metadata.name,
|
||||
NONE_LABEL_VALUE
|
||||
)
|
||||
tsObjects.push(tsObject as TrafficSplitObject)
|
||||
}
|
||||
// make extraservices and trafficsplit
|
||||
await setupSMI(kubectl, manifestObjects.serviceEntityList);
|
||||
|
||||
const objectsToDeploy = [].concat(newObjectsList, tsObjects)
|
||||
// create new deloyments
|
||||
return await createWorkloadsWithLabel(
|
||||
kubectl,
|
||||
manifestObjects.deploymentEntityList,
|
||||
GREEN_LABEL_VALUE
|
||||
);
|
||||
}
|
||||
|
||||
// create services
|
||||
const smiDeploymentResult: DeployResult = await deployObjects(
|
||||
export async function promoteBlueGreenSMI(kubectl: Kubectl, manifestObjects) {
|
||||
// checking if there is something to promote
|
||||
if (
|
||||
!(await validateTrafficSplitsState(
|
||||
kubectl,
|
||||
objectsToDeploy
|
||||
)
|
||||
manifestObjects.serviceEntityList
|
||||
))
|
||||
) {
|
||||
throw Error("Not in promote state SMI");
|
||||
}
|
||||
|
||||
return {
|
||||
objects: objectsToDeploy,
|
||||
deployResult: smiDeploymentResult
|
||||
}
|
||||
// create stable deployments with new configuration
|
||||
return await createWorkloadsWithLabel(
|
||||
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(
|
||||
kubectl: Kubectl,
|
||||
name: string,
|
||||
nextLabel: string
|
||||
): Promise<TrafficSplitObject> {
|
||||
// cache traffic split api version
|
||||
if (!trafficSplitAPIVersion)
|
||||
trafficSplitAPIVersion =
|
||||
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
|
||||
// route trafficsplit to stable deploymetns
|
||||
await routeBlueGreenSMI(
|
||||
kubectl,
|
||||
NONE_LABEL_VALUE,
|
||||
manifestObjects.serviceEntityList
|
||||
);
|
||||
|
||||
// retrieve annotations for TS object
|
||||
const annotations = inputAnnotations
|
||||
// delete rejected new bluegreen deployments
|
||||
await deleteWorkloadsWithLabel(
|
||||
kubectl,
|
||||
GREEN_LABEL_VALUE,
|
||||
manifestObjects.deploymentEntityList
|
||||
);
|
||||
|
||||
// decide weights based on nextlabel
|
||||
const stableWeight: number =
|
||||
nextLabel === GREEN_LABEL_VALUE ? MIN_VAL : MAX_VAL
|
||||
const greenWeight: number =
|
||||
nextLabel === GREEN_LABEL_VALUE ? MAX_VAL : MIN_VAL
|
||||
|
||||
const trafficSplitObject: TrafficSplitObject = {
|
||||
apiVersion: trafficSplitAPIVersion,
|
||||
kind: TRAFFIC_SPLIT_OBJECT,
|
||||
metadata: {
|
||||
name: getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
|
||||
annotations: annotations,
|
||||
labels: new Map<string, string>()
|
||||
},
|
||||
spec: {
|
||||
service: name,
|
||||
backends: [
|
||||
{
|
||||
service: getBlueGreenResourceName(name, STABLE_SUFFIX),
|
||||
weight: stableWeight
|
||||
},
|
||||
{
|
||||
service: getBlueGreenResourceName(name, GREEN_SUFFIX),
|
||||
weight: greenWeight
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
return trafficSplitObject
|
||||
// delete trafficsplit and extra services
|
||||
await cleanupSMI(kubectl, manifestObjects.serviceEntityList);
|
||||
}
|
||||
|
||||
export function getStableSMIServiceResource(inputObject: K8sObject): K8sObject {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
// adding stable suffix to service name
|
||||
newObject.metadata.name = getBlueGreenResourceName(
|
||||
export async function setupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
|
||||
const newObjectsList = [];
|
||||
const trafficObjectList = [];
|
||||
|
||||
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,
|
||||
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 {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
return getNewBlueGreenObject(newObject, GREEN_LABEL_VALUE)
|
||||
export async function routeBlueGreenSMI(
|
||||
kubectl: Kubectl,
|
||||
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(
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
): Promise<boolean> {
|
||||
let trafficSplitsInRightState: boolean = true
|
||||
let trafficSplitsInRightState: boolean = true;
|
||||
|
||||
for (const serviceObject of serviceEntityList) {
|
||||
const name = serviceObject.metadata.name
|
||||
let trafficSplitObject = await fetchResource(
|
||||
kubectl,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX),
|
||||
serviceObject?.metadata?.namespace
|
||||
)
|
||||
core.debug(
|
||||
`ts object extracted was ${JSON.stringify(trafficSplitObject)}`
|
||||
)
|
||||
if (!trafficSplitObject) {
|
||||
core.debug(`no traffic split exits for ${name}`)
|
||||
trafficSplitsInRightState = false
|
||||
continue
|
||||
for (const serviceObject of serviceEntityList) {
|
||||
const name = serviceObject.metadata.name;
|
||||
let trafficSplitObject = await fetchResource(
|
||||
kubectl,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
getBlueGreenResourceName(name, TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX)
|
||||
);
|
||||
|
||||
if (!trafficSplitObject) {
|
||||
// no traffic split exits
|
||||
trafficSplitsInRightState = false;
|
||||
}
|
||||
|
||||
trafficSplitObject = JSON.parse(JSON.stringify(trafficSplitObject));
|
||||
trafficSplitObject.spec.backends.forEach((element) => {
|
||||
// checking if trafficsplit in right state to deploy
|
||||
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
|
||||
if (element.weight != MAX_VAL) trafficSplitsInRightState = false;
|
||||
}
|
||||
|
||||
trafficSplitObject.spec.backends.forEach((element) => {
|
||||
// checking if trafficsplit in right state to deploy
|
||||
if (element.service === getBlueGreenResourceName(name, GREEN_SUFFIX)) {
|
||||
trafficSplitsInRightState =
|
||||
trafficSplitsInRightState && element.weight == MAX_VAL
|
||||
}
|
||||
if (element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)) {
|
||||
if (element.weight != MIN_VAL) trafficSplitsInRightState = false;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (
|
||||
element.service === getBlueGreenResourceName(name, STABLE_SUFFIX)
|
||||
) {
|
||||
trafficSplitsInRightState =
|
||||
trafficSplitsInRightState && element.weight == MIN_VAL
|
||||
}
|
||||
})
|
||||
}
|
||||
return trafficSplitsInRightState
|
||||
return trafficSplitsInRightState;
|
||||
}
|
||||
|
||||
export async function cleanupSMI(
|
||||
kubectl: Kubectl,
|
||||
serviceEntityList: any[]
|
||||
): Promise<K8sDeleteObject[]> {
|
||||
const deleteList: K8sDeleteObject[] = []
|
||||
export async function cleanupSMI(kubectl: Kubectl, serviceEntityList: any[]) {
|
||||
const deleteList = [];
|
||||
|
||||
serviceEntityList.forEach((serviceObject) => {
|
||||
deleteList.push({
|
||||
name: getBlueGreenResourceName(
|
||||
serviceObject.metadata.name,
|
||||
GREEN_SUFFIX
|
||||
),
|
||||
kind: serviceObject.kind,
|
||||
namespace: serviceObject?.metadata?.namespace
|
||||
})
|
||||
})
|
||||
serviceEntityList.forEach((serviceObject) => {
|
||||
deleteList.push({
|
||||
name: getBlueGreenResourceName(
|
||||
serviceObject.metadata.name,
|
||||
TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
|
||||
),
|
||||
kind: TRAFFIC_SPLIT_OBJECT,
|
||||
});
|
||||
|
||||
// delete all objects
|
||||
await deleteObjects(kubectl, deleteList)
|
||||
deleteList.push({
|
||||
name: getBlueGreenResourceName(serviceObject.metadata.name, GREEN_SUFFIX),
|
||||
kind: serviceObject.kind,
|
||||
});
|
||||
|
||||
return deleteList
|
||||
deleteList.push({
|
||||
name: getBlueGreenResourceName(
|
||||
serviceObject.metadata.name,
|
||||
STABLE_SUFFIX
|
||||
),
|
||||
kind: serviceObject.kind,
|
||||
});
|
||||
});
|
||||
|
||||
// delete all objects
|
||||
await deleteObjects(kubectl, deleteList);
|
||||
}
|
||||
|
||||
@@ -1,243 +1,196 @@
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
import * as core from '@actions/core'
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
import {
|
||||
isDeploymentEntity,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload
|
||||
} from '../../types/kubernetesTypes'
|
||||
import * as utils from '../../utilities/manifestUpdateUtils'
|
||||
import {
|
||||
updateObjectAnnotations,
|
||||
updateObjectLabels,
|
||||
updateSelectorLabels
|
||||
} from '../../utilities/manifestUpdateUtils'
|
||||
import {updateSpecLabels} from '../../utilities/manifestSpecLabelUtils'
|
||||
import {checkForErrors} from '../../utilities/kubectlUtils'
|
||||
|
||||
export const CANARY_VERSION_LABEL = 'workflow/version'
|
||||
const BASELINE_SUFFIX = '-baseline'
|
||||
export const BASELINE_LABEL_VALUE = 'baseline'
|
||||
const CANARY_SUFFIX = '-canary'
|
||||
export const CANARY_LABEL_VALUE = 'canary'
|
||||
export const STABLE_SUFFIX = '-stable'
|
||||
export const STABLE_LABEL_VALUE = 'stable'
|
||||
|
||||
export async function deleteCanaryDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
includeServices: boolean
|
||||
): Promise<string[]> {
|
||||
if (manifestFilePaths == null || manifestFilePaths.length == 0) {
|
||||
throw new Error('Manifest files for deleting canary deployment not found')
|
||||
}
|
||||
|
||||
const deletedFiles = await cleanUpCanary(
|
||||
kubectl,
|
||||
manifestFilePaths,
|
||||
includeServices
|
||||
)
|
||||
return deletedFiles
|
||||
}
|
||||
|
||||
export function markResourceAsStable(inputObject: any): object {
|
||||
if (isResourceMarkedAsStable(inputObject)) {
|
||||
return inputObject
|
||||
}
|
||||
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE)
|
||||
return newObject
|
||||
}
|
||||
|
||||
export function isResourceMarkedAsStable(inputObject: any): boolean {
|
||||
return (
|
||||
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
|
||||
)
|
||||
}
|
||||
|
||||
export function getStableResource(inputObject: any): object {
|
||||
const replicaCount = specContainsReplicas(inputObject.kind)
|
||||
? inputObject.spec.replicas
|
||||
: 0
|
||||
|
||||
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE)
|
||||
}
|
||||
|
||||
export function getNewBaselineResource(
|
||||
stableObject: any,
|
||||
replicas?: number
|
||||
): object {
|
||||
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE)
|
||||
}
|
||||
|
||||
export function getNewCanaryResource(
|
||||
inputObject: any,
|
||||
replicas?: number
|
||||
): object {
|
||||
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE)
|
||||
}
|
||||
|
||||
export async function fetchResource(
|
||||
kubectl: Kubectl,
|
||||
kind: string,
|
||||
name: string
|
||||
) {
|
||||
let result: ExecOutput
|
||||
try {
|
||||
result = await kubectl.getResource(kind, name)
|
||||
} catch (e) {
|
||||
core.debug(`detected error while fetching resources: ${e}`)
|
||||
}
|
||||
|
||||
if (!result || result?.stderr) {
|
||||
return null
|
||||
}
|
||||
|
||||
if (result.stdout) {
|
||||
const resource = JSON.parse(result.stdout)
|
||||
|
||||
try {
|
||||
utils.UnsetClusterSpecificDetails(resource)
|
||||
return resource
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while parsing ${resource} in JSON object: ${ex}`
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getCanaryResourceName(name: string) {
|
||||
return name + CANARY_SUFFIX
|
||||
}
|
||||
|
||||
export function getBaselineResourceName(name: string) {
|
||||
return name + BASELINE_SUFFIX
|
||||
}
|
||||
|
||||
export function getStableResourceName(name: string) {
|
||||
return name + STABLE_SUFFIX
|
||||
}
|
||||
|
||||
export function getBaselineDeploymentFromStableDeployment(
|
||||
inputObject: any,
|
||||
replicaCount: number
|
||||
): object {
|
||||
// TODO: REFACTOR TO MAKE EVERYTHING TYPE SAFE
|
||||
const oldName = inputObject.metadata.name
|
||||
const newName =
|
||||
oldName.substring(0, oldName.length - STABLE_SUFFIX.length) +
|
||||
BASELINE_SUFFIX
|
||||
|
||||
const newObject = getNewCanaryObject(
|
||||
inputObject,
|
||||
replicaCount,
|
||||
BASELINE_LABEL_VALUE
|
||||
) as any
|
||||
newObject.metadata.name = newName
|
||||
|
||||
return newObject
|
||||
}
|
||||
|
||||
function getNewCanaryObject(
|
||||
inputObject: any,
|
||||
replicas: number,
|
||||
type: string
|
||||
): object {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject))
|
||||
|
||||
// Updating name
|
||||
if (type === CANARY_LABEL_VALUE) {
|
||||
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name)
|
||||
} else if (type === STABLE_LABEL_VALUE) {
|
||||
newObject.metadata.name = getStableResourceName(inputObject.metadata.name)
|
||||
} else {
|
||||
newObject.metadata.name = getBaselineResourceName(
|
||||
inputObject.metadata.name
|
||||
)
|
||||
}
|
||||
|
||||
addCanaryLabelsAndAnnotations(newObject, type)
|
||||
|
||||
if (specContainsReplicas(newObject.kind)) {
|
||||
newObject.spec.replicas = replicas
|
||||
}
|
||||
|
||||
return newObject
|
||||
}
|
||||
|
||||
function specContainsReplicas(kind: string) {
|
||||
return (
|
||||
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
|
||||
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
|
||||
!isServiceEntity(kind)
|
||||
)
|
||||
}
|
||||
|
||||
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
|
||||
const newLabels = new Map<string, string>()
|
||||
newLabels[CANARY_VERSION_LABEL] = type
|
||||
|
||||
updateObjectLabels(inputObject, newLabels, false)
|
||||
updateObjectAnnotations(inputObject, newLabels, false)
|
||||
updateSelectorLabels(inputObject, newLabels, false)
|
||||
|
||||
if (!isServiceEntity(inputObject.kind)) {
|
||||
updateSpecLabels(inputObject, newLabels, false)
|
||||
}
|
||||
}
|
||||
|
||||
async function cleanUpCanary(
|
||||
kubectl: Kubectl,
|
||||
files: string[],
|
||||
includeServices: boolean
|
||||
): Promise<string[]> {
|
||||
const deleteObject = async function (
|
||||
kind: string,
|
||||
name: string,
|
||||
namespace: string | undefined
|
||||
) {
|
||||
try {
|
||||
const result = await kubectl.delete([kind, name], namespace)
|
||||
checkForErrors([result])
|
||||
} catch (ex) {
|
||||
// Ignore failures of delete if it doesn't exist
|
||||
}
|
||||
}
|
||||
|
||||
const deletedFiles: string[] = []
|
||||
|
||||
for (const filePath of files) {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
|
||||
const parsedYaml: any[] = yaml.loadAll(fileContents)
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name
|
||||
const kind = inputObject.kind
|
||||
const namespace: string | undefined =
|
||||
inputObject?.metadata?.namespace
|
||||
|
||||
if (
|
||||
isDeploymentEntity(kind) ||
|
||||
(includeServices && isServiceEntity(kind))
|
||||
) {
|
||||
deletedFiles.push(filePath)
|
||||
const canaryObjectName = getCanaryResourceName(name)
|
||||
const baselineObjectName = getBaselineResourceName(name)
|
||||
|
||||
await deleteObject(kind, canaryObjectName, namespace)
|
||||
await deleteObject(kind, baselineObjectName, namespace)
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
return deletedFiles
|
||||
}
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
import * as core from "@actions/core";
|
||||
import {
|
||||
isDeploymentEntity,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload,
|
||||
} from "../../types/kubernetesTypes";
|
||||
import * as utils from "../../utilities/manifestUpdateUtils";
|
||||
import {
|
||||
updateObjectAnnotations,
|
||||
updateObjectLabels,
|
||||
updateSelectorLabels,
|
||||
} from "../../utilities/manifestUpdateUtils";
|
||||
import { updateSpecLabels } from "../../utilities/manifestSpecLabelUtils";
|
||||
import { checkForErrors } from "../../utilities/kubectlUtils";
|
||||
|
||||
export const CANARY_VERSION_LABEL = "workflow/version";
|
||||
const BASELINE_SUFFIX = "-baseline";
|
||||
export const BASELINE_LABEL_VALUE = "baseline";
|
||||
const CANARY_SUFFIX = "-canary";
|
||||
export const CANARY_LABEL_VALUE = "canary";
|
||||
export const STABLE_SUFFIX = "-stable";
|
||||
export const STABLE_LABEL_VALUE = "stable";
|
||||
|
||||
export async function deleteCanaryDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
includeServices: boolean
|
||||
) {
|
||||
if (manifestFilePaths == null || manifestFilePaths.length == 0) {
|
||||
throw new Error("Manifest file not found");
|
||||
}
|
||||
|
||||
await cleanUpCanary(kubectl, manifestFilePaths, includeServices);
|
||||
}
|
||||
|
||||
export function markResourceAsStable(inputObject: any): object {
|
||||
if (isResourceMarkedAsStable(inputObject)) {
|
||||
return inputObject;
|
||||
}
|
||||
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject));
|
||||
addCanaryLabelsAndAnnotations(newObject, STABLE_LABEL_VALUE);
|
||||
return newObject;
|
||||
}
|
||||
|
||||
export function isResourceMarkedAsStable(inputObject: any): boolean {
|
||||
return (
|
||||
inputObject?.metadata?.labels[CANARY_VERSION_LABEL] === STABLE_LABEL_VALUE
|
||||
);
|
||||
}
|
||||
|
||||
export function getStableResource(inputObject: any): object {
|
||||
const replicaCount = specContainsReplicas(inputObject.kind)
|
||||
? inputObject.metadata.replicas
|
||||
: 0;
|
||||
|
||||
return getNewCanaryObject(inputObject, replicaCount, STABLE_LABEL_VALUE);
|
||||
}
|
||||
|
||||
export function getNewBaselineResource(
|
||||
stableObject: any,
|
||||
replicas?: number
|
||||
): object {
|
||||
return getNewCanaryObject(stableObject, replicas, BASELINE_LABEL_VALUE);
|
||||
}
|
||||
|
||||
export function getNewCanaryResource(
|
||||
inputObject: any,
|
||||
replicas?: number
|
||||
): object {
|
||||
return getNewCanaryObject(inputObject, replicas, CANARY_LABEL_VALUE);
|
||||
}
|
||||
|
||||
export async function fetchResource(
|
||||
kubectl: Kubectl,
|
||||
kind: string,
|
||||
name: string
|
||||
) {
|
||||
const result = await kubectl.getResource(kind, name);
|
||||
|
||||
if (!result || result?.stderr) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (result.stdout) {
|
||||
const resource = JSON.parse(result.stdout);
|
||||
|
||||
try {
|
||||
utils.UnsetClusterSpecificDetails(resource);
|
||||
return resource;
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while Parsing ${resource} in JSON object: ${ex}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getCanaryResourceName(name: string) {
|
||||
return name + CANARY_SUFFIX;
|
||||
}
|
||||
|
||||
export function getBaselineResourceName(name: string) {
|
||||
return name + BASELINE_SUFFIX;
|
||||
}
|
||||
|
||||
export function getStableResourceName(name: string) {
|
||||
return name + STABLE_SUFFIX;
|
||||
}
|
||||
|
||||
function getNewCanaryObject(
|
||||
inputObject: any,
|
||||
replicas: number,
|
||||
type: string
|
||||
): object {
|
||||
const newObject = JSON.parse(JSON.stringify(inputObject));
|
||||
|
||||
// Updating name
|
||||
if (type === CANARY_LABEL_VALUE) {
|
||||
newObject.metadata.name = getCanaryResourceName(inputObject.metadata.name);
|
||||
} else if (type === STABLE_LABEL_VALUE) {
|
||||
newObject.metadata.name = getStableResourceName(inputObject.metadata.name);
|
||||
} else {
|
||||
newObject.metadata.name = getBaselineResourceName(
|
||||
inputObject.metadata.name
|
||||
);
|
||||
}
|
||||
|
||||
addCanaryLabelsAndAnnotations(newObject, type);
|
||||
|
||||
if (specContainsReplicas(newObject.kind)) {
|
||||
newObject.spec.replicas = replicas;
|
||||
}
|
||||
|
||||
return newObject;
|
||||
}
|
||||
|
||||
function specContainsReplicas(kind: string) {
|
||||
return (
|
||||
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
|
||||
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase() &&
|
||||
!isServiceEntity(kind)
|
||||
);
|
||||
}
|
||||
|
||||
function addCanaryLabelsAndAnnotations(inputObject: any, type: string) {
|
||||
const newLabels = new Map<string, string>();
|
||||
newLabels[CANARY_VERSION_LABEL] = type;
|
||||
|
||||
updateObjectLabels(inputObject, newLabels, false);
|
||||
updateObjectAnnotations(inputObject, newLabels, false);
|
||||
updateSelectorLabels(inputObject, newLabels, false);
|
||||
|
||||
if (!isServiceEntity(inputObject.kind)) {
|
||||
updateSpecLabels(inputObject, newLabels, false);
|
||||
}
|
||||
}
|
||||
|
||||
async function cleanUpCanary(
|
||||
kubectl: Kubectl,
|
||||
files: string[],
|
||||
includeServices: boolean
|
||||
) {
|
||||
const deleteObject = async function (kind, name) {
|
||||
try {
|
||||
const result = await kubectl.delete([kind, name]);
|
||||
checkForErrors([result]);
|
||||
} catch (ex) {
|
||||
// Ignore failures of delete if it doesn't exist
|
||||
}
|
||||
};
|
||||
|
||||
for (const filePath of files) {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
|
||||
const parsedYaml = yaml.safeLoadAll(fileContents);
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
|
||||
if (
|
||||
isDeploymentEntity(kind) ||
|
||||
(includeServices && isServiceEntity(kind))
|
||||
) {
|
||||
const canaryObjectName = getCanaryResourceName(name);
|
||||
const baselineObjectName = getBaselineResourceName(name);
|
||||
|
||||
await deleteObject(kind, canaryObjectName);
|
||||
await deleteObject(kind, baselineObjectName);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,109 +1,90 @@
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import * as core from '@actions/core'
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
|
||||
import * as fileHelper from '../../utilities/fileUtils'
|
||||
import * as canaryDeploymentHelper from './canaryHelper'
|
||||
import {isDeploymentEntity} from '../../types/kubernetesTypes'
|
||||
import {getReplicaCount} from '../../utilities/manifestUpdateUtils'
|
||||
import {DeployResult} from '../../types/deployResult'
|
||||
import {K8sObject} from '../../types/k8sObject'
|
||||
|
||||
export async function deployPodCanary(
|
||||
filePaths: string[],
|
||||
kubectl: Kubectl,
|
||||
onlyDeployStable: boolean = false
|
||||
): Promise<DeployResult> {
|
||||
const newObjectsList = []
|
||||
const percentage = parseInt(core.getInput('percentage', {required: true}))
|
||||
|
||||
if (percentage < 0 || percentage > 100)
|
||||
throw Error('Percentage must be between 0 and 100')
|
||||
|
||||
for (const filePath of filePaths) {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath, 'utf8')
|
||||
const parsedYaml = yaml.loadAll(fileContents)
|
||||
for (const inputObject of parsedYaml) {
|
||||
if (
|
||||
inputObject &&
|
||||
typeof inputObject === 'object' &&
|
||||
'metadata' in inputObject &&
|
||||
'kind' in inputObject &&
|
||||
'spec' in inputObject &&
|
||||
typeof inputObject.metadata === 'object' &&
|
||||
'name' in inputObject.metadata &&
|
||||
typeof inputObject.metadata.name === 'string' &&
|
||||
typeof inputObject.kind === 'string'
|
||||
) {
|
||||
const obj = inputObject as K8sObject
|
||||
const name = obj.metadata.name
|
||||
const kind = obj.kind
|
||||
|
||||
if (!onlyDeployStable && isDeploymentEntity(kind)) {
|
||||
core.debug('Calculating replica count for canary')
|
||||
const canaryReplicaCount = calculateReplicaCountForCanary(
|
||||
obj,
|
||||
percentage
|
||||
)
|
||||
core.debug('Replica count is ' + canaryReplicaCount)
|
||||
|
||||
const newCanaryObject =
|
||||
canaryDeploymentHelper.getNewCanaryResource(
|
||||
obj,
|
||||
canaryReplicaCount
|
||||
)
|
||||
newObjectsList.push(newCanaryObject)
|
||||
|
||||
// if there's already a stable object, deploy baseline as well
|
||||
const stableObject =
|
||||
await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
name
|
||||
)
|
||||
if (stableObject) {
|
||||
core.debug(
|
||||
`Stable object found for ${kind} ${name}. Creating baseline objects`
|
||||
)
|
||||
const newBaselineObject =
|
||||
canaryDeploymentHelper.getNewBaselineResource(
|
||||
stableObject,
|
||||
canaryReplicaCount
|
||||
)
|
||||
core.debug(
|
||||
'New baseline object: ' +
|
||||
JSON.stringify(newBaselineObject)
|
||||
)
|
||||
newObjectsList.push(newBaselineObject)
|
||||
}
|
||||
} else {
|
||||
// deploy non deployment entity or regular deployments for promote as they are
|
||||
newObjectsList.push(obj)
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(
|
||||
`Failed to parse YAML file at ${filePath}: ${error.message}`
|
||||
)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
core.debug('New objects list: ' + JSON.stringify(newObjectsList))
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
|
||||
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
|
||||
|
||||
const execResult = await kubectl.apply(manifestFiles, forceDeployment)
|
||||
return {execResult, manifestFiles}
|
||||
}
|
||||
|
||||
export function calculateReplicaCountForCanary(
|
||||
inputObject: any,
|
||||
percentage: number
|
||||
) {
|
||||
const inputReplicaCount = getReplicaCount(inputObject)
|
||||
return Math.max(1, Math.round((inputReplicaCount * percentage) / 100))
|
||||
}
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as core from "@actions/core";
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import * as canaryDeploymentHelper from "./canaryHelper";
|
||||
import { isDeploymentEntity } from "../../types/kubernetesTypes";
|
||||
import { getReplicaCount } from "../../utilities/manifestUpdateUtils";
|
||||
|
||||
export async function deployPodCanary(filePaths: string[], kubectl: Kubectl) {
|
||||
const newObjectsList = [];
|
||||
const percentage = parseInt(core.getInput("percentage"));
|
||||
|
||||
if (percentage < 0 || percentage > 100)
|
||||
throw Error("Percentage must be between 0 and 100");
|
||||
|
||||
for (const filePath of filePaths) {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
const parsedYaml = yaml.safeLoadAll(fileContents);
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
|
||||
if (isDeploymentEntity(kind)) {
|
||||
core.debug("Calculating replica count for canary");
|
||||
const canaryReplicaCount = calculateReplicaCountForCanary(
|
||||
inputObject,
|
||||
percentage
|
||||
);
|
||||
core.debug("Replica count is " + canaryReplicaCount);
|
||||
|
||||
// Get stable object
|
||||
core.debug("Querying stable object");
|
||||
const stableObject = await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
name
|
||||
);
|
||||
|
||||
if (!stableObject) {
|
||||
core.debug("Stable object not found. Creating canary object");
|
||||
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
|
||||
inputObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
newObjectsList.push(newCanaryObject);
|
||||
} else {
|
||||
core.debug(
|
||||
"Creating canary and baseline objects. Stable object found: " +
|
||||
JSON.stringify(stableObject)
|
||||
);
|
||||
|
||||
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
|
||||
inputObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
core.debug("New canary object: " + JSON.stringify(newCanaryObject));
|
||||
|
||||
const newBaselineObject =
|
||||
canaryDeploymentHelper.getNewBaselineResource(
|
||||
stableObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
core.debug(
|
||||
"New baseline object: " + JSON.stringify(newBaselineObject)
|
||||
);
|
||||
|
||||
newObjectsList.push(newCanaryObject);
|
||||
newObjectsList.push(newBaselineObject);
|
||||
}
|
||||
} else {
|
||||
// update non deployment entity as it is
|
||||
newObjectsList.push(inputObject);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
core.debug("New objects list: " + JSON.stringify(newObjectsList));
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
const forceDeployment = core.getInput("force").toLowerCase() === "true";
|
||||
|
||||
const result = await kubectl.apply(manifestFiles, forceDeployment);
|
||||
return { result, newFilePaths: manifestFiles };
|
||||
}
|
||||
|
||||
function calculateReplicaCountForCanary(inputObject: any, percentage: number) {
|
||||
const inputReplicaCount = getReplicaCount(inputObject);
|
||||
return Math.round((inputReplicaCount * percentage) / 100);
|
||||
}
|
||||
|
||||
@@ -1,383 +1,319 @@
|
||||
import {Kubectl} from '../../types/kubectl'
|
||||
import * as core from '@actions/core'
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
|
||||
import * as fileHelper from '../../utilities/fileUtils'
|
||||
import * as kubectlUtils from '../../utilities/trafficSplitUtils'
|
||||
import * as canaryDeploymentHelper from './canaryHelper'
|
||||
import * as podCanaryHelper from './podCanaryHelper'
|
||||
import {isDeploymentEntity, isServiceEntity} from '../../types/kubernetesTypes'
|
||||
import {checkForErrors} from '../../utilities/kubectlUtils'
|
||||
import {inputAnnotations} from '../../inputUtils'
|
||||
import {DeployResult} from '../../types/deployResult'
|
||||
import {K8sObject} from '../../types/k8sObject'
|
||||
|
||||
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = '-workflow-rollout'
|
||||
const TRAFFIC_SPLIT_OBJECT = 'TrafficSplit'
|
||||
|
||||
export async function deploySMICanary(
|
||||
filePaths: string[],
|
||||
kubectl: Kubectl,
|
||||
onlyDeployStable: boolean = false
|
||||
): Promise<DeployResult> {
|
||||
const canaryReplicasInput = core.getInput('baseline-and-canary-replicas')
|
||||
let canaryReplicaCount
|
||||
let calculateReplicas = true
|
||||
if (canaryReplicasInput !== '') {
|
||||
canaryReplicaCount = parseInt(canaryReplicasInput)
|
||||
calculateReplicas = false
|
||||
core.debug(
|
||||
`read replica count ${canaryReplicaCount} from input: ${canaryReplicasInput}`
|
||||
)
|
||||
}
|
||||
|
||||
if (canaryReplicaCount < 0 && canaryReplicaCount > 100)
|
||||
throw Error('Baseline-and-canary-replicas must be between 0 and 100')
|
||||
|
||||
const newObjectsList = []
|
||||
for await (const filePath of filePaths) {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
const inputObjects: K8sObject[] = yaml.loadAll(
|
||||
fileContents
|
||||
) as K8sObject[]
|
||||
for (const inputObject of inputObjects) {
|
||||
const name = inputObject.metadata.name
|
||||
const kind = inputObject.kind
|
||||
|
||||
if (!onlyDeployStable && isDeploymentEntity(kind)) {
|
||||
if (calculateReplicas) {
|
||||
// calculate for each object
|
||||
const percentage = parseInt(
|
||||
core.getInput('percentage', {required: true})
|
||||
)
|
||||
canaryReplicaCount =
|
||||
podCanaryHelper.calculateReplicaCountForCanary(
|
||||
inputObject,
|
||||
percentage
|
||||
)
|
||||
core.debug(`calculated replica count ${canaryReplicaCount}`)
|
||||
}
|
||||
|
||||
core.debug('Creating canary object')
|
||||
const newCanaryObject =
|
||||
canaryDeploymentHelper.getNewCanaryResource(
|
||||
inputObject,
|
||||
canaryReplicaCount
|
||||
)
|
||||
newObjectsList.push(newCanaryObject)
|
||||
|
||||
const stableObject = await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
canaryDeploymentHelper.getStableResourceName(name)
|
||||
)
|
||||
if (stableObject) {
|
||||
core.debug(
|
||||
`Stable object found for ${kind} ${name}. Creating baseline objects`
|
||||
)
|
||||
const newBaselineObject =
|
||||
canaryDeploymentHelper.getBaselineDeploymentFromStableDeployment(
|
||||
stableObject,
|
||||
canaryReplicaCount
|
||||
)
|
||||
newObjectsList.push(newBaselineObject)
|
||||
}
|
||||
} else if (isDeploymentEntity(kind)) {
|
||||
core.debug(
|
||||
`creating stable deployment with ${inputObject.spec.replicas} replicas`
|
||||
)
|
||||
const stableDeployment =
|
||||
canaryDeploymentHelper.getStableResource(inputObject)
|
||||
newObjectsList.push(stableDeployment)
|
||||
} else {
|
||||
// Update non deployment entity or stable deployment as it is
|
||||
newObjectsList.push(inputObject)
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
core.debug(
|
||||
`deploying canary objects with SMI: \n ${JSON.stringify(newObjectsList)}`
|
||||
)
|
||||
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList)
|
||||
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
|
||||
const result = await kubectl.apply(newFilePaths, forceDeployment)
|
||||
const svcDeploymentFiles = await createCanaryService(kubectl, filePaths)
|
||||
newFilePaths.push(...svcDeploymentFiles)
|
||||
return {execResult: result, manifestFiles: newFilePaths}
|
||||
}
|
||||
|
||||
async function createCanaryService(
|
||||
kubectl: Kubectl,
|
||||
filePaths: string[]
|
||||
): Promise<string[]> {
|
||||
const newObjectsList = []
|
||||
const trafficObjectsList: string[] = []
|
||||
|
||||
for (const filePath of filePaths) {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
const parsedYaml: K8sObject[] = yaml.loadAll(
|
||||
fileContents
|
||||
) as K8sObject[]
|
||||
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name
|
||||
const kind = inputObject.kind
|
||||
|
||||
if (isServiceEntity(kind)) {
|
||||
core.debug(`Creating services for ${kind} ${name}`)
|
||||
const newCanaryServiceObject =
|
||||
canaryDeploymentHelper.getNewCanaryResource(inputObject)
|
||||
newObjectsList.push(newCanaryServiceObject)
|
||||
|
||||
const newBaselineServiceObject =
|
||||
canaryDeploymentHelper.getNewBaselineResource(inputObject)
|
||||
newObjectsList.push(newBaselineServiceObject)
|
||||
|
||||
const stableObject = await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
canaryDeploymentHelper.getStableResourceName(name)
|
||||
)
|
||||
if (!stableObject) {
|
||||
const newStableServiceObject =
|
||||
canaryDeploymentHelper.getStableResource(inputObject)
|
||||
newObjectsList.push(newStableServiceObject)
|
||||
|
||||
core.debug('Creating the traffic object for service: ' + name)
|
||||
const trafficObject = await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
name,
|
||||
0,
|
||||
0,
|
||||
1000
|
||||
)
|
||||
|
||||
trafficObjectsList.push(trafficObject)
|
||||
} else {
|
||||
let updateTrafficObject = true
|
||||
const trafficObject =
|
||||
await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
getTrafficSplitResourceName(name)
|
||||
)
|
||||
|
||||
if (trafficObject) {
|
||||
const trafficJObject = JSON.parse(
|
||||
JSON.stringify(trafficObject)
|
||||
)
|
||||
if (trafficJObject?.spec?.backends) {
|
||||
trafficJObject.spec.backends.forEach((s) => {
|
||||
if (
|
||||
s.service ===
|
||||
canaryDeploymentHelper.getCanaryResourceName(
|
||||
name
|
||||
) &&
|
||||
s.weight === '1000m'
|
||||
) {
|
||||
core.debug('Update traffic objcet not required')
|
||||
updateTrafficObject = false
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
if (updateTrafficObject) {
|
||||
core.debug(
|
||||
'Stable service object present so updating the traffic object for service: ' +
|
||||
name
|
||||
)
|
||||
trafficObjectsList.push(
|
||||
await updateTrafficSplitObject(kubectl, name)
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
|
||||
manifestFiles.push(...trafficObjectsList)
|
||||
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
|
||||
|
||||
const result = await kubectl.apply(manifestFiles, forceDeployment)
|
||||
checkForErrors([result])
|
||||
return manifestFiles
|
||||
}
|
||||
|
||||
export async function redirectTrafficToCanaryDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[]
|
||||
) {
|
||||
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000)
|
||||
}
|
||||
|
||||
export async function redirectTrafficToStableDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[]
|
||||
): Promise<string[]> {
|
||||
return await adjustTraffic(kubectl, manifestFilePaths, 1000, 0)
|
||||
}
|
||||
|
||||
async function adjustTraffic(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
stableWeight: number,
|
||||
canaryWeight: number
|
||||
) {
|
||||
if (!manifestFilePaths || manifestFilePaths?.length == 0) {
|
||||
return
|
||||
}
|
||||
|
||||
const trafficSplitManifests = []
|
||||
for (const filePath of manifestFilePaths) {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
const parsedYaml: K8sObject[] = yaml.loadAll(
|
||||
fileContents
|
||||
) as K8sObject[]
|
||||
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name
|
||||
const kind = inputObject.kind
|
||||
|
||||
if (isServiceEntity(kind)) {
|
||||
trafficSplitManifests.push(
|
||||
await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
name,
|
||||
stableWeight,
|
||||
0,
|
||||
canaryWeight
|
||||
)
|
||||
)
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
if (trafficSplitManifests.length <= 0) {
|
||||
return
|
||||
}
|
||||
|
||||
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
|
||||
const result = await kubectl.apply(trafficSplitManifests, forceDeployment)
|
||||
checkForErrors([result])
|
||||
return trafficSplitManifests
|
||||
}
|
||||
|
||||
async function updateTrafficSplitObject(
|
||||
kubectl: Kubectl,
|
||||
serviceName: string
|
||||
): Promise<string> {
|
||||
const percentage = parseInt(core.getInput('percentage', {required: true}))
|
||||
if (percentage < 0 || percentage > 100)
|
||||
throw Error('Percentage must be between 0 and 100')
|
||||
|
||||
const percentageWithMuliplier = percentage * 10
|
||||
const baselineAndCanaryWeight = percentageWithMuliplier / 2
|
||||
const stableDeploymentWeight = 1000 - percentageWithMuliplier
|
||||
|
||||
core.debug(
|
||||
'Creating the traffic object with canary weight: ' +
|
||||
baselineAndCanaryWeight +
|
||||
', baseline weight: ' +
|
||||
baselineAndCanaryWeight +
|
||||
', stable weight: ' +
|
||||
stableDeploymentWeight
|
||||
)
|
||||
return await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
serviceName,
|
||||
stableDeploymentWeight,
|
||||
baselineAndCanaryWeight,
|
||||
baselineAndCanaryWeight
|
||||
)
|
||||
}
|
||||
|
||||
async function createTrafficSplitManifestFile(
|
||||
kubectl: Kubectl,
|
||||
serviceName: string,
|
||||
stableWeight: number,
|
||||
baselineWeight: number,
|
||||
canaryWeight: number
|
||||
): Promise<string> {
|
||||
const smiObjectString = await getTrafficSplitObject(
|
||||
kubectl,
|
||||
serviceName,
|
||||
stableWeight,
|
||||
baselineWeight,
|
||||
canaryWeight
|
||||
)
|
||||
const manifestFile = fileHelper.writeManifestToFile(
|
||||
smiObjectString,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
serviceName
|
||||
)
|
||||
|
||||
if (!manifestFile) {
|
||||
throw new Error('Unable to create traffic split manifest file')
|
||||
}
|
||||
|
||||
return manifestFile
|
||||
}
|
||||
|
||||
let trafficSplitAPIVersion = ''
|
||||
|
||||
async function getTrafficSplitObject(
|
||||
kubectl: Kubectl,
|
||||
name: string,
|
||||
stableWeight: number,
|
||||
baselineWeight: number,
|
||||
canaryWeight: number
|
||||
): Promise<string> {
|
||||
// cached version
|
||||
if (!trafficSplitAPIVersion) {
|
||||
trafficSplitAPIVersion =
|
||||
await kubectlUtils.getTrafficSplitAPIVersion(kubectl)
|
||||
}
|
||||
|
||||
return JSON.stringify({
|
||||
apiVersion: trafficSplitAPIVersion,
|
||||
kind: 'TrafficSplit',
|
||||
metadata: {
|
||||
name: getTrafficSplitResourceName(name),
|
||||
annotations: inputAnnotations
|
||||
},
|
||||
spec: {
|
||||
backends: [
|
||||
{
|
||||
service: canaryDeploymentHelper.getStableResourceName(name),
|
||||
weight: stableWeight
|
||||
},
|
||||
{
|
||||
service: canaryDeploymentHelper.getBaselineResourceName(name),
|
||||
weight: baselineWeight
|
||||
},
|
||||
{
|
||||
service: canaryDeploymentHelper.getCanaryResourceName(name),
|
||||
weight: canaryWeight
|
||||
}
|
||||
],
|
||||
service: name
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
function getTrafficSplitResourceName(name: string) {
|
||||
return name + TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX
|
||||
}
|
||||
import { Kubectl } from "../../types/kubectl";
|
||||
import * as core from "@actions/core";
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
|
||||
import * as fileHelper from "../../utilities/fileUtils";
|
||||
import * as kubectlUtils from "../../utilities/trafficSplitUtils";
|
||||
import * as canaryDeploymentHelper from "./canaryHelper";
|
||||
import {
|
||||
isDeploymentEntity,
|
||||
isServiceEntity,
|
||||
} from "../../types/kubernetesTypes";
|
||||
import { checkForErrors } from "../../utilities/kubectlUtils";
|
||||
|
||||
const TRAFFIC_SPLIT_OBJECT_NAME_SUFFIX = "-workflow-rollout";
|
||||
const TRAFFIC_SPLIT_OBJECT = "TrafficSplit";
|
||||
|
||||
export async function deploySMICanary(filePaths: string[], kubectl: Kubectl) {
|
||||
const canaryReplicaCount = parseInt(
|
||||
core.getInput("baseline-and-canary-replicas")
|
||||
);
|
||||
if (canaryReplicaCount < 0 || canaryReplicaCount > 100)
|
||||
throw Error("Baseline-and-canary-replicas must be between 0 and 100");
|
||||
|
||||
const newObjectsList = [];
|
||||
filePaths.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
yaml.safeLoadAll(fileContents, (inputObject) => {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
|
||||
if (isDeploymentEntity(kind)) {
|
||||
const stableObject = canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
name
|
||||
);
|
||||
|
||||
if (!stableObject) {
|
||||
core.debug("Stable object not found. Creating only canary object");
|
||||
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
|
||||
inputObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
newObjectsList.push(newCanaryObject);
|
||||
} else {
|
||||
if (!canaryDeploymentHelper.isResourceMarkedAsStable(stableObject)) {
|
||||
throw Error(`StableSpecSelectorNotExist : ${name}`);
|
||||
}
|
||||
|
||||
core.debug(
|
||||
"Stable object found. Creating canary and baseline objects"
|
||||
);
|
||||
const newCanaryObject = canaryDeploymentHelper.getNewCanaryResource(
|
||||
inputObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
const newBaselineObject =
|
||||
canaryDeploymentHelper.getNewBaselineResource(
|
||||
stableObject,
|
||||
canaryReplicaCount
|
||||
);
|
||||
newObjectsList.push(newCanaryObject);
|
||||
newObjectsList.push(newBaselineObject);
|
||||
}
|
||||
} else {
|
||||
// Update non deployment entity as it is
|
||||
newObjectsList.push(inputObject);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
const newFilePaths = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
const forceDeployment = core.getInput("force").toLowerCase() === "true";
|
||||
const result = await kubectl.apply(newFilePaths, forceDeployment);
|
||||
await createCanaryService(kubectl, filePaths);
|
||||
return { result, newFilePaths };
|
||||
}
|
||||
|
||||
async function createCanaryService(kubectl: Kubectl, filePaths: string[]) {
|
||||
const newObjectsList = [];
|
||||
const trafficObjectsList = [];
|
||||
|
||||
for (const filePath of filePaths) {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
const parsedYaml = yaml.safeLoadAll(fileContents);
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
|
||||
if (isServiceEntity(kind)) {
|
||||
const newCanaryServiceObject =
|
||||
canaryDeploymentHelper.getNewCanaryResource(inputObject);
|
||||
newObjectsList.push(newCanaryServiceObject);
|
||||
|
||||
const newBaselineServiceObject =
|
||||
canaryDeploymentHelper.getNewBaselineResource(inputObject);
|
||||
newObjectsList.push(newBaselineServiceObject);
|
||||
|
||||
const stableObject = await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
kind,
|
||||
canaryDeploymentHelper.getStableResourceName(name)
|
||||
);
|
||||
if (!stableObject) {
|
||||
const newStableServiceObject =
|
||||
canaryDeploymentHelper.getStableResource(inputObject);
|
||||
newObjectsList.push(newStableServiceObject);
|
||||
|
||||
core.debug("Creating the traffic object for service: " + name);
|
||||
const trafficObject = await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
name,
|
||||
0,
|
||||
0,
|
||||
1000
|
||||
);
|
||||
|
||||
trafficObjectsList.push(trafficObject);
|
||||
} else {
|
||||
let updateTrafficObject = true;
|
||||
const trafficObject = await canaryDeploymentHelper.fetchResource(
|
||||
kubectl,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
getTrafficSplitResourceName(name)
|
||||
);
|
||||
|
||||
if (trafficObject) {
|
||||
const trafficJObject = JSON.parse(JSON.stringify(trafficObject));
|
||||
if (trafficJObject?.spec?.backends) {
|
||||
trafficJObject.spec.backends.forEach((s) => {
|
||||
if (
|
||||
s.service ===
|
||||
canaryDeploymentHelper.getCanaryResourceName(name) &&
|
||||
s.weight === "1000m"
|
||||
) {
|
||||
core.debug("Update traffic objcet not required");
|
||||
updateTrafficObject = false;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (updateTrafficObject) {
|
||||
core.debug(
|
||||
"Stable service object present so updating the traffic object for service: " +
|
||||
name
|
||||
);
|
||||
trafficObjectsList.push(updateTrafficSplitObject(kubectl, name));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
manifestFiles.push(...trafficObjectsList);
|
||||
const forceDeployment = core.getInput("force").toLowerCase() === "true";
|
||||
|
||||
const result = await kubectl.apply(manifestFiles, forceDeployment);
|
||||
checkForErrors([result]);
|
||||
}
|
||||
|
||||
export async function redirectTrafficToCanaryDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[]
|
||||
) {
|
||||
await adjustTraffic(kubectl, manifestFilePaths, 0, 1000);
|
||||
}
|
||||
|
||||
export async function redirectTrafficToStableDeployment(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[]
|
||||
) {
|
||||
await adjustTraffic(kubectl, manifestFilePaths, 1000, 0);
|
||||
}
|
||||
|
||||
async function adjustTraffic(
|
||||
kubectl: Kubectl,
|
||||
manifestFilePaths: string[],
|
||||
stableWeight: number,
|
||||
canaryWeight: number
|
||||
) {
|
||||
if (!manifestFilePaths || manifestFilePaths?.length == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
const trafficSplitManifests = [];
|
||||
for (const filePath of manifestFilePaths) {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
const parsedYaml = yaml.safeLoadAll(fileContents);
|
||||
for (const inputObject of parsedYaml) {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
|
||||
if (isServiceEntity(kind)) {
|
||||
trafficSplitManifests.push(
|
||||
await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
name,
|
||||
stableWeight,
|
||||
0,
|
||||
canaryWeight
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (trafficSplitManifests.length <= 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
const forceDeployment = core.getInput("force").toLowerCase() === "true";
|
||||
const result = await kubectl.apply(trafficSplitManifests, forceDeployment);
|
||||
checkForErrors([result]);
|
||||
}
|
||||
|
||||
async function updateTrafficSplitObject(
|
||||
kubectl: Kubectl,
|
||||
serviceName: string
|
||||
): Promise<string> {
|
||||
const percentage = parseInt(core.getInput("percentage"));
|
||||
if (percentage < 0 || percentage > 100)
|
||||
throw Error("Percentage must be between 0 and 100");
|
||||
|
||||
const percentageWithMuliplier = percentage * 10;
|
||||
const baselineAndCanaryWeight = percentageWithMuliplier / 2;
|
||||
const stableDeploymentWeight = 1000 - percentageWithMuliplier;
|
||||
|
||||
core.debug(
|
||||
"Creating the traffic object with canary weight: " +
|
||||
baselineAndCanaryWeight +
|
||||
",baseling weight: " +
|
||||
baselineAndCanaryWeight +
|
||||
",stable: " +
|
||||
stableDeploymentWeight
|
||||
);
|
||||
return await createTrafficSplitManifestFile(
|
||||
kubectl,
|
||||
serviceName,
|
||||
stableDeploymentWeight,
|
||||
baselineAndCanaryWeight,
|
||||
baselineAndCanaryWeight
|
||||
);
|
||||
}
|
||||
|
||||
async function createTrafficSplitManifestFile(
|
||||
kubectl: Kubectl,
|
||||
serviceName: string,
|
||||
stableWeight: number,
|
||||
baselineWeight: number,
|
||||
canaryWeight: number
|
||||
): Promise<string> {
|
||||
const smiObjectString = await getTrafficSplitObject(
|
||||
kubectl,
|
||||
serviceName,
|
||||
stableWeight,
|
||||
baselineWeight,
|
||||
canaryWeight
|
||||
);
|
||||
const manifestFile = fileHelper.writeManifestToFile(
|
||||
smiObjectString,
|
||||
TRAFFIC_SPLIT_OBJECT,
|
||||
serviceName
|
||||
);
|
||||
|
||||
if (!manifestFile) {
|
||||
throw new Error("Unable to create traffic split manifest file");
|
||||
}
|
||||
|
||||
return manifestFile;
|
||||
}
|
||||
|
||||
let trafficSplitAPIVersion = "";
|
||||
|
||||
async function getTrafficSplitObject(
|
||||
kubectl: Kubectl,
|
||||
name: string,
|
||||
stableWeight: number,
|
||||
baselineWeight: number,
|
||||
canaryWeight: number
|
||||
): Promise<string> {
|
||||
// cached version
|
||||
if (!trafficSplitAPIVersion) {
|
||||
trafficSplitAPIVersion = await kubectlUtils.getTrafficSplitAPIVersion(
|
||||
kubectl
|
||||
);
|
||||
}
|
||||
|
||||
return JSON.stringify({
|
||||
apiVersion: trafficSplitAPIVersion,
|
||||
kind: "TrafficSplit",
|
||||
metadata: {
|
||||
name: getTrafficSplitResourceName(name),
|
||||
},
|
||||
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;
|
||||
}
|
||||
|
||||
@@ -1,298 +1,218 @@
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
import * as canaryDeploymentHelper from './canary/canaryHelper'
|
||||
import * as models from '../types/kubernetesTypes'
|
||||
import {isDeploymentEntity} from '../types/kubernetesTypes'
|
||||
import * as fileHelper from '../utilities/fileUtils'
|
||||
import * as KubernetesManifestUtility from '../utilities/manifestStabilityUtils'
|
||||
import {Kubectl, Resource} from '../types/kubectl'
|
||||
|
||||
import {deployPodCanary} from './canary/podCanaryHelper'
|
||||
import {deploySMICanary} from './canary/smiCanaryHelper'
|
||||
import {DeploymentConfig} from '../types/deploymentConfig'
|
||||
import {deployBlueGreen} from './blueGreen/deploy'
|
||||
import {DeploymentStrategy} from '../types/deploymentStrategy'
|
||||
import * as core from '@actions/core'
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod
|
||||
} from '../types/trafficSplitMethod'
|
||||
import {parseRouteStrategy} from '../types/routeStrategy'
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
import {
|
||||
getWorkflowAnnotationKeyLabel,
|
||||
getWorkflowAnnotations,
|
||||
cleanLabel
|
||||
} from '../utilities/workflowAnnotationUtils'
|
||||
import {
|
||||
annotateChildPods,
|
||||
checkForErrors,
|
||||
getLastSuccessfulRunSha
|
||||
} from '../utilities/kubectlUtils'
|
||||
import {
|
||||
getWorkflowFilePath,
|
||||
normalizeWorkflowStrLabel
|
||||
} from '../utilities/githubUtils'
|
||||
import {getDeploymentConfig} from '../utilities/dockerUtils'
|
||||
import {DeployResult} from '../types/deployResult'
|
||||
import {ClusterType} from '../inputUtils'
|
||||
|
||||
export async function deployManifests(
|
||||
files: string[],
|
||||
deploymentStrategy: DeploymentStrategy,
|
||||
kubectl: Kubectl,
|
||||
trafficSplitMethod: TrafficSplitMethod
|
||||
): Promise<string[]> {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY: {
|
||||
const canaryDeployResult: DeployResult =
|
||||
trafficSplitMethod == TrafficSplitMethod.SMI
|
||||
? await deploySMICanary(files, kubectl)
|
||||
: await deployPodCanary(files, kubectl)
|
||||
|
||||
checkForErrors([canaryDeployResult.execResult])
|
||||
return canaryDeployResult.manifestFiles
|
||||
}
|
||||
|
||||
case DeploymentStrategy.BLUE_GREEN: {
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput('route-method', {required: true})
|
||||
)
|
||||
const blueGreenDeployment = await deployBlueGreen(
|
||||
kubectl,
|
||||
files,
|
||||
routeStrategy
|
||||
)
|
||||
core.debug(
|
||||
`objects deployed for ${routeStrategy}: ${JSON.stringify(
|
||||
blueGreenDeployment.objects
|
||||
)} `
|
||||
)
|
||||
|
||||
checkForErrors([blueGreenDeployment.deployResult.execResult])
|
||||
const deployedManifestFiles =
|
||||
blueGreenDeployment.deployResult.manifestFiles
|
||||
core.debug(
|
||||
`from blue-green service, deployed manifest files are ${deployedManifestFiles}`
|
||||
)
|
||||
return deployedManifestFiles
|
||||
}
|
||||
|
||||
case DeploymentStrategy.BASIC: {
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput('traffic-split-method', {required: true})
|
||||
)
|
||||
|
||||
const forceDeployment = core.getInput('force').toLowerCase() === 'true'
|
||||
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
|
||||
const updatedManifests = appendStableVersionLabelToResource(files)
|
||||
|
||||
const result = await kubectl.apply(
|
||||
updatedManifests,
|
||||
forceDeployment
|
||||
)
|
||||
checkForErrors([result])
|
||||
} else {
|
||||
const result = await kubectl.apply(files, forceDeployment)
|
||||
checkForErrors([result])
|
||||
}
|
||||
|
||||
return files
|
||||
}
|
||||
|
||||
default: {
|
||||
throw new Error('Deployment strategy is not recognized.')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function appendStableVersionLabelToResource(files: string[]): string[] {
|
||||
const manifestFiles = []
|
||||
const newObjectsList = []
|
||||
|
||||
files.forEach((filePath: string) => {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
|
||||
yaml.loadAll(fileContents, function (inputObject) {
|
||||
const kind = (inputObject as {kind: string}).kind
|
||||
|
||||
if (isDeploymentEntity(kind)) {
|
||||
const updatedObject =
|
||||
canaryDeploymentHelper.markResourceAsStable(inputObject)
|
||||
newObjectsList.push(updatedObject)
|
||||
} else {
|
||||
manifestFiles.push(filePath)
|
||||
}
|
||||
})
|
||||
} catch (error) {
|
||||
core.error(`Failed to parse file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
})
|
||||
|
||||
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList)
|
||||
manifestFiles.push(...updatedManifestFiles)
|
||||
|
||||
return manifestFiles
|
||||
}
|
||||
|
||||
export async function checkManifestStability(
|
||||
kubectl: Kubectl,
|
||||
resources: Resource[],
|
||||
resourceType: ClusterType
|
||||
): Promise<void> {
|
||||
await KubernetesManifestUtility.checkManifestStability(
|
||||
kubectl,
|
||||
resources,
|
||||
resourceType
|
||||
)
|
||||
}
|
||||
|
||||
export async function annotateAndLabelResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
resourceTypes: Resource[]
|
||||
) {
|
||||
const defaultWorkflowFileName = 'k8s-deploy-failed-workflow-annotation'
|
||||
const githubToken = core.getInput('token')
|
||||
let workflowFilePath
|
||||
try {
|
||||
workflowFilePath = await getWorkflowFilePath(githubToken)
|
||||
} catch (ex) {
|
||||
core.warning(`Failed to extract workflow file name: ${ex}`)
|
||||
workflowFilePath = defaultWorkflowFileName
|
||||
}
|
||||
|
||||
const deploymentConfig = await getDeploymentConfig()
|
||||
const annotationKeyLabel = getWorkflowAnnotationKeyLabel()
|
||||
|
||||
const shouldAnnotateResources = !(
|
||||
core.getInput('annotate-resources').toLowerCase() === 'false'
|
||||
)
|
||||
|
||||
if (shouldAnnotateResources) {
|
||||
await annotateResources(
|
||||
files,
|
||||
kubectl,
|
||||
resourceTypes,
|
||||
annotationKeyLabel,
|
||||
workflowFilePath,
|
||||
deploymentConfig
|
||||
).catch((err) => core.warning(`Failed to annotate resources: ${err} `))
|
||||
}
|
||||
|
||||
await labelResources(files, kubectl, annotationKeyLabel).catch((err) =>
|
||||
core.warning(`Failed to label resources: ${err}`)
|
||||
)
|
||||
}
|
||||
|
||||
async function annotateResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
resourceTypes: Resource[],
|
||||
annotationKey: string,
|
||||
workflowFilePath: string,
|
||||
deploymentConfig: DeploymentConfig
|
||||
) {
|
||||
const annotateResults: ExecOutput[] = []
|
||||
const namespace = core.getInput('namespace') || 'default'
|
||||
const lastSuccessSha = await getLastSuccessfulRunSha(
|
||||
kubectl,
|
||||
namespace,
|
||||
annotationKey
|
||||
)
|
||||
|
||||
if (core.isDebug()) {
|
||||
try {
|
||||
core.debug(`files getting annotated are ${JSON.stringify(files)}`)
|
||||
for (const filePath of files) {
|
||||
core.debug('printing objects getting annotated...')
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
const inputObjects = yaml.loadAll(fileContents)
|
||||
for (const inputObject of inputObjects) {
|
||||
core.debug(`object: ${JSON.stringify(inputObject)}`)
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Failed to load and parse files: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
|
||||
lastSuccessSha,
|
||||
workflowFilePath,
|
||||
deploymentConfig
|
||||
)}`
|
||||
|
||||
const annotateNamespace = !(
|
||||
core.getInput('annotate-namespace').toLowerCase() === 'false'
|
||||
)
|
||||
if (annotateNamespace) {
|
||||
annotateResults.push(
|
||||
await kubectl.annotate(
|
||||
'namespace',
|
||||
namespace,
|
||||
annotationKeyValStr,
|
||||
namespace
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
for (const file of files) {
|
||||
try {
|
||||
const annotateResult = await kubectl.annotateFiles(
|
||||
file,
|
||||
annotationKeyValStr,
|
||||
namespace
|
||||
)
|
||||
annotateResults.push(annotateResult)
|
||||
} catch (e) {
|
||||
core.warning(`failed to annotate resource: ${e}`)
|
||||
}
|
||||
}
|
||||
|
||||
for (const resource of resourceTypes) {
|
||||
if (
|
||||
resource.type.toLowerCase() !==
|
||||
models.KubernetesWorkload.POD.toLowerCase()
|
||||
) {
|
||||
;(
|
||||
await annotateChildPods(
|
||||
kubectl,
|
||||
resource.type,
|
||||
resource.name,
|
||||
resource.namespace,
|
||||
annotationKeyValStr
|
||||
)
|
||||
).forEach((execResult) => annotateResults.push(execResult))
|
||||
}
|
||||
}
|
||||
|
||||
checkForErrors(annotateResults, true)
|
||||
}
|
||||
|
||||
async function labelResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
label: string
|
||||
) {
|
||||
const labels = [
|
||||
`workflowFriendlyName=${cleanLabel(
|
||||
normalizeWorkflowStrLabel(process.env.GITHUB_WORKFLOW)
|
||||
)}`,
|
||||
`workflow=${cleanLabel(label)}`
|
||||
]
|
||||
|
||||
const labelResults = []
|
||||
for (const file of files) {
|
||||
try {
|
||||
const labelResult = await kubectl.labelFiles(file, labels)
|
||||
labelResults.push(labelResult)
|
||||
} catch (e) {
|
||||
core.warning(`failed to annotate resource: ${e}`)
|
||||
}
|
||||
}
|
||||
checkForErrors(labelResults, true)
|
||||
}
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
import * as canaryDeploymentHelper from "./canary/canaryHelper";
|
||||
import * as models from "../types/kubernetesTypes";
|
||||
import { isDeploymentEntity } from "../types/kubernetesTypes";
|
||||
import * as fileHelper from "../utilities/fileUtils";
|
||||
import * as KubernetesManifestUtility from "../utilities/manifestStabilityUtils";
|
||||
import { Kubectl, Resource } from "../types/kubectl";
|
||||
|
||||
import { deployPodCanary } from "./canary/podCanaryHelper";
|
||||
import { deploySMICanary } from "./canary/smiCanaryHelper";
|
||||
import { DeploymentConfig } from "../types/deploymentConfig";
|
||||
import { deployBlueGreenService } from "./blueGreen/serviceBlueGreenHelper";
|
||||
import { deployBlueGreenIngress } from "./blueGreen/ingressBlueGreenHelper";
|
||||
import { deployBlueGreenSMI } from "./blueGreen/smiBlueGreenHelper";
|
||||
import { DeploymentStrategy } from "../types/deploymentStrategy";
|
||||
import * as core from "@actions/core";
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod,
|
||||
} from "../types/trafficSplitMethod";
|
||||
import { parseRouteStrategy, RouteStrategy } from "../types/routeStrategy";
|
||||
import { ExecOutput } from "@actions/exec";
|
||||
import {
|
||||
getWorkflowAnnotationKeyLabel,
|
||||
getWorkflowAnnotations,
|
||||
} from "../utilities/workflowAnnotationUtils";
|
||||
import {
|
||||
annotateChildPods,
|
||||
checkForErrors,
|
||||
getLastSuccessfulRunSha,
|
||||
} from "../utilities/kubectlUtils";
|
||||
import {
|
||||
getWorkflowFilePath,
|
||||
normalizeWorkflowStrLabel,
|
||||
} from "../utilities/githubUtils";
|
||||
import { getDeploymentConfig } from "../utilities/dockerUtils";
|
||||
|
||||
export async function deployManifests(
|
||||
files: string[],
|
||||
deploymentStrategy: DeploymentStrategy,
|
||||
kubectl: Kubectl,
|
||||
trafficSplitMethod: TrafficSplitMethod
|
||||
): Promise<string[]> {
|
||||
switch (deploymentStrategy) {
|
||||
case DeploymentStrategy.CANARY: {
|
||||
const { result, newFilePaths } =
|
||||
trafficSplitMethod == TrafficSplitMethod.SMI
|
||||
? await deploySMICanary(files, kubectl)
|
||||
: await deployPodCanary(files, kubectl);
|
||||
|
||||
checkForErrors([result]);
|
||||
return newFilePaths;
|
||||
}
|
||||
|
||||
case DeploymentStrategy.BLUE_GREEN: {
|
||||
const routeStrategy = parseRouteStrategy(
|
||||
core.getInput("route-method", { required: true })
|
||||
);
|
||||
|
||||
const { result, newFilePaths } = await Promise.resolve(
|
||||
(routeStrategy == RouteStrategy.INGRESS &&
|
||||
deployBlueGreenIngress(kubectl, files)) ||
|
||||
(routeStrategy == RouteStrategy.SMI &&
|
||||
deployBlueGreenSMI(kubectl, files)) ||
|
||||
deployBlueGreenService(kubectl, files)
|
||||
);
|
||||
|
||||
checkForErrors([result]);
|
||||
return newFilePaths;
|
||||
}
|
||||
|
||||
case undefined: {
|
||||
core.warning("Deployment strategy is not recognized.");
|
||||
}
|
||||
default: {
|
||||
const trafficSplitMethod = parseTrafficSplitMethod(
|
||||
core.getInput("traffic-split-method", { required: true })
|
||||
);
|
||||
|
||||
const forceDeployment = core.getInput("force").toLowerCase() === "true";
|
||||
if (trafficSplitMethod === TrafficSplitMethod.SMI) {
|
||||
const updatedManifests = appendStableVersionLabelToResource(files);
|
||||
|
||||
const result = await kubectl.apply(updatedManifests, forceDeployment);
|
||||
checkForErrors([result]);
|
||||
} else {
|
||||
const result = await kubectl.apply(files, forceDeployment);
|
||||
checkForErrors([result]);
|
||||
}
|
||||
|
||||
return files;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function appendStableVersionLabelToResource(files: string[]): string[] {
|
||||
const manifestFiles = [];
|
||||
const newObjectsList = [];
|
||||
|
||||
files.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
|
||||
yaml.safeLoadAll(fileContents, function (inputObject) {
|
||||
const { kind } = inputObject;
|
||||
|
||||
if (isDeploymentEntity(kind)) {
|
||||
const updatedObject =
|
||||
canaryDeploymentHelper.markResourceAsStable(inputObject);
|
||||
newObjectsList.push(updatedObject);
|
||||
} else {
|
||||
manifestFiles.push(filePath);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
const updatedManifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
manifestFiles.push(...updatedManifestFiles);
|
||||
|
||||
return manifestFiles;
|
||||
}
|
||||
|
||||
export async function checkManifestStability(
|
||||
kubectl: Kubectl,
|
||||
resources: Resource[]
|
||||
): Promise<void> {
|
||||
await KubernetesManifestUtility.checkManifestStability(kubectl, resources);
|
||||
}
|
||||
|
||||
export async function annotateAndLabelResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
resourceTypes: Resource[],
|
||||
allPods: any
|
||||
) {
|
||||
const githubToken = core.getInput("token");
|
||||
const workflowFilePath = await getWorkflowFilePath(githubToken);
|
||||
|
||||
const deploymentConfig = await getDeploymentConfig();
|
||||
const annotationKeyLabel = getWorkflowAnnotationKeyLabel(workflowFilePath);
|
||||
|
||||
await annotateResources(
|
||||
files,
|
||||
kubectl,
|
||||
resourceTypes,
|
||||
allPods,
|
||||
annotationKeyLabel,
|
||||
workflowFilePath,
|
||||
deploymentConfig
|
||||
);
|
||||
await labelResources(files, kubectl, annotationKeyLabel);
|
||||
}
|
||||
|
||||
async function annotateResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
resourceTypes: Resource[],
|
||||
allPods: any,
|
||||
annotationKey: string,
|
||||
workflowFilePath: string,
|
||||
deploymentConfig: DeploymentConfig
|
||||
) {
|
||||
const annotateResults: ExecOutput[] = [];
|
||||
const namespace = core.getInput("namespace") || "default";
|
||||
const lastSuccessSha = await getLastSuccessfulRunSha(
|
||||
kubectl,
|
||||
namespace,
|
||||
annotationKey
|
||||
);
|
||||
|
||||
const annotationKeyValStr = `${annotationKey}=${getWorkflowAnnotations(
|
||||
lastSuccessSha,
|
||||
workflowFilePath,
|
||||
deploymentConfig
|
||||
)}`;
|
||||
|
||||
const annotateNamespace = !(core.getInput("annotate-namespace").toLowerCase() === "false");
|
||||
if (annotateNamespace) {
|
||||
annotateResults.push(
|
||||
await kubectl.annotate("namespace", namespace, annotationKeyValStr)
|
||||
);
|
||||
}
|
||||
annotateResults.push(await kubectl.annotateFiles(files, annotationKeyValStr));
|
||||
|
||||
for (const resource of resourceTypes) {
|
||||
if (
|
||||
resource.type.toLowerCase() !==
|
||||
models.KubernetesWorkload.POD.toLowerCase()
|
||||
) {
|
||||
(
|
||||
await annotateChildPods(
|
||||
kubectl,
|
||||
resource.type,
|
||||
resource.name,
|
||||
annotationKeyValStr,
|
||||
allPods
|
||||
)
|
||||
).forEach((execResult) => annotateResults.push(execResult));
|
||||
}
|
||||
}
|
||||
|
||||
checkForErrors(annotateResults, true);
|
||||
}
|
||||
|
||||
async function labelResources(
|
||||
files: string[],
|
||||
kubectl: Kubectl,
|
||||
label: string
|
||||
) {
|
||||
const labels = [
|
||||
`workflowFriendlyName=${normalizeWorkflowStrLabel(
|
||||
process.env.GITHUB_WORKFLOW
|
||||
)}`,
|
||||
`workflow=${label}`,
|
||||
];
|
||||
|
||||
checkForErrors([await kubectl.labelFiles(files, labels)], true);
|
||||
}
|
||||
|
||||
+19
-19
@@ -1,22 +1,22 @@
|
||||
import {Action, parseAction} from './action'
|
||||
import { Action, parseAction } from "./action";
|
||||
|
||||
describe('Action type', () => {
|
||||
test('it has required values', () => {
|
||||
const vals = <any>Object.values(Action)
|
||||
expect(vals.includes('deploy')).toBe(true)
|
||||
expect(vals.includes('promote')).toBe(true)
|
||||
expect(vals.includes('reject')).toBe(true)
|
||||
})
|
||||
describe("Action type", () => {
|
||||
test("it has required values", () => {
|
||||
const vals = <any>Object.values(Action);
|
||||
expect(vals.includes("deploy")).toBe(true);
|
||||
expect(vals.includes("promote")).toBe(true);
|
||||
expect(vals.includes("reject")).toBe(true);
|
||||
});
|
||||
|
||||
test('it can parse valid values from a string', () => {
|
||||
expect(parseAction('deploy')).toBe(Action.DEPLOY)
|
||||
expect(parseAction('Deploy')).toBe(Action.DEPLOY)
|
||||
expect(parseAction('DEPLOY')).toBe(Action.DEPLOY)
|
||||
expect(parseAction('deploY')).toBe(Action.DEPLOY)
|
||||
})
|
||||
test("it can parse valid values from a string", () => {
|
||||
expect(parseAction("deploy")).toBe(Action.DEPLOY);
|
||||
expect(parseAction("Deploy")).toBe(Action.DEPLOY);
|
||||
expect(parseAction("DEPLOY")).toBe(Action.DEPLOY);
|
||||
expect(parseAction("deploY")).toBe(Action.DEPLOY);
|
||||
});
|
||||
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseAction('invalid')).toBe(undefined)
|
||||
expect(parseAction('unsupportedType')).toBe(undefined)
|
||||
})
|
||||
})
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseAction("invalid")).toBe(undefined);
|
||||
expect(parseAction("unsupportedType")).toBe(undefined);
|
||||
});
|
||||
});
|
||||
|
||||
+8
-8
@@ -1,7 +1,7 @@
|
||||
export enum Action {
|
||||
DEPLOY = 'deploy',
|
||||
PROMOTE = 'promote',
|
||||
REJECT = 'reject'
|
||||
DEPLOY = "deploy",
|
||||
PROMOTE = "promote",
|
||||
REJECT = "reject",
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -10,8 +10,8 @@ export enum Action {
|
||||
* @returns The Action enum or undefined if it can't be parsed
|
||||
*/
|
||||
export const parseAction = (str: string): Action | undefined =>
|
||||
Action[
|
||||
Object.keys(Action).filter(
|
||||
(k) => Action[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof Action
|
||||
]
|
||||
Action[
|
||||
Object.keys(Action).filter(
|
||||
(k) => Action[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof Action
|
||||
];
|
||||
|
||||
@@ -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)
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
|
||||
export interface DeployResult {
|
||||
execResult: ExecOutput
|
||||
manifestFiles: string[]
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
export interface DeploymentConfig {
|
||||
manifestFilePaths: string[]
|
||||
helmChartFilePaths: string[]
|
||||
dockerfilePaths: any
|
||||
manifestFilePaths: string[];
|
||||
helmChartFilePaths: string[];
|
||||
dockerfilePaths: any;
|
||||
}
|
||||
|
||||
@@ -1,25 +1,27 @@
|
||||
import {DeploymentStrategy, parseDeploymentStrategy} from './deploymentStrategy'
|
||||
import {
|
||||
DeploymentStrategy,
|
||||
parseDeploymentStrategy,
|
||||
} from "./deploymentStrategy";
|
||||
|
||||
describe('Deployment strategy type', () => {
|
||||
test('it has required values', () => {
|
||||
const vals = <any>Object.values(DeploymentStrategy)
|
||||
expect(vals.includes('canary')).toBe(true)
|
||||
expect(vals.includes('blue-green')).toBe(true)
|
||||
expect(vals.includes('basic')).toBe(true)
|
||||
})
|
||||
describe("Deployment strategy type", () => {
|
||||
test("it has required values", () => {
|
||||
const vals = <any>Object.values(DeploymentStrategy);
|
||||
expect(vals.includes("canary")).toBe(true);
|
||||
expect(vals.includes("blue-green")).toBe(true);
|
||||
});
|
||||
|
||||
test('it can parse valid values from a string', () => {
|
||||
expect(parseDeploymentStrategy('blue-green')).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
)
|
||||
expect(parseDeploymentStrategy('Blue-green')).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
)
|
||||
expect(parseDeploymentStrategy('BLUE-GREEN')).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
)
|
||||
expect(parseDeploymentStrategy('blue-greeN')).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
)
|
||||
})
|
||||
})
|
||||
test("it can parse valid values from a string", () => {
|
||||
expect(parseDeploymentStrategy("blue-green")).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
);
|
||||
expect(parseDeploymentStrategy("Blue-green")).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
);
|
||||
expect(parseDeploymentStrategy("BLUE-GREEN")).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
);
|
||||
expect(parseDeploymentStrategy("blue-greeN")).toBe(
|
||||
DeploymentStrategy.BLUE_GREEN
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
export enum DeploymentStrategy {
|
||||
BASIC = 'basic',
|
||||
CANARY = 'canary',
|
||||
BLUE_GREEN = 'blue-green'
|
||||
CANARY = "canary",
|
||||
BLUE_GREEN = "blue-green",
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -10,11 +9,11 @@ export enum DeploymentStrategy {
|
||||
* @returns The DeploymentStrategy enum or undefined if it can't be parsed
|
||||
*/
|
||||
export const parseDeploymentStrategy = (
|
||||
str: string
|
||||
str: string
|
||||
): DeploymentStrategy | undefined =>
|
||||
DeploymentStrategy[
|
||||
Object.keys(DeploymentStrategy).filter(
|
||||
(k) =>
|
||||
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof DeploymentStrategy
|
||||
]
|
||||
DeploymentStrategy[
|
||||
Object.keys(DeploymentStrategy).filter(
|
||||
(k) =>
|
||||
DeploymentStrategy[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof DeploymentStrategy
|
||||
];
|
||||
|
||||
+82
-82
@@ -1,98 +1,98 @@
|
||||
import {DockerExec} from './docker'
|
||||
import * as actions from '@actions/exec'
|
||||
import { DockerExec } from "./docker";
|
||||
import * as actions from "@actions/exec";
|
||||
|
||||
const dockerPath = 'dockerPath'
|
||||
const image = 'image'
|
||||
const args = ['arg1', 'arg2', 'arg3']
|
||||
const dockerPath = "dockerPath";
|
||||
const image = "image";
|
||||
const args = ["arg1", "arg2", "arg3"];
|
||||
|
||||
describe('Docker class', () => {
|
||||
const docker = new DockerExec(dockerPath)
|
||||
describe("Docker class", () => {
|
||||
const docker = new DockerExec(dockerPath);
|
||||
|
||||
describe('with a success exec return', () => {
|
||||
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
|
||||
describe("with a success exec return", () => {
|
||||
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
|
||||
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
|
||||
return execReturn
|
||||
})
|
||||
})
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
|
||||
return execReturn;
|
||||
});
|
||||
});
|
||||
|
||||
test('pulls an image', async () => {
|
||||
await docker.pull(image, args)
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
['pull', image, ...args],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
test("pulls an image", async () => {
|
||||
await docker.pull(image, args);
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
["pull", image, ...args],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
test('pulls an image silently', async () => {
|
||||
await docker.pull(image, args, true)
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
['pull', image, ...args],
|
||||
{silent: true}
|
||||
)
|
||||
})
|
||||
test("pulls an image silently", async () => {
|
||||
await docker.pull(image, args, true);
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
["pull", image, ...args],
|
||||
{ silent: true }
|
||||
);
|
||||
});
|
||||
|
||||
test('inspects a docker image', async () => {
|
||||
const result = await docker.inspect(image, args)
|
||||
expect(result).toBe(execReturn.stdout)
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
['inspect', image, ...args],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
test("inspects a docker image", async () => {
|
||||
const result = await docker.inspect(image, args);
|
||||
expect(result).toBe(execReturn.stdout);
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
["inspect", image, ...args],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
test('inspects a docker image silently', async () => {
|
||||
const result = await docker.inspect(image, args, true)
|
||||
expect(result).toBe(execReturn.stdout)
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
['inspect', image, ...args],
|
||||
{silent: true}
|
||||
)
|
||||
})
|
||||
})
|
||||
test("inspects a docker image silently", async () => {
|
||||
const result = await docker.inspect(image, args, true);
|
||||
expect(result).toBe(execReturn.stdout);
|
||||
expect(actions.getExecOutput).toBeCalledWith(
|
||||
dockerPath,
|
||||
["inspect", image, ...args],
|
||||
{ silent: true }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('with an unsuccessful exec return code', () => {
|
||||
const execReturn = {exitCode: 3, stdout: '', stderr: ''}
|
||||
describe("with an unsuccessful exec return code", () => {
|
||||
const execReturn = { exitCode: 3, stdout: "", stderr: "" };
|
||||
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
|
||||
return execReturn
|
||||
})
|
||||
})
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
|
||||
return execReturn;
|
||||
});
|
||||
});
|
||||
|
||||
test('pulls an image', async () => {
|
||||
await expect(docker.pull(image, args)).rejects.toThrow()
|
||||
})
|
||||
test("pulls an image", async () => {
|
||||
await expect(docker.pull(image, args)).rejects.toThrow();
|
||||
});
|
||||
|
||||
test('inspects a docker image', async () => {
|
||||
const result = await expect(
|
||||
docker.inspect(image, args)
|
||||
).rejects.toThrow()
|
||||
})
|
||||
})
|
||||
test("inspects a docker image", async () => {
|
||||
const result = await expect(
|
||||
docker.inspect(image, args)
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('with an unsuccessful exec return code', () => {
|
||||
const execReturn = {exitCode: 0, stdout: '', stderr: 'Output'}
|
||||
describe("with an unsuccessful exec return code", () => {
|
||||
const execReturn = { exitCode: 0, stdout: "", stderr: "Output" };
|
||||
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, 'getExecOutput').mockImplementation(async () => {
|
||||
return execReturn
|
||||
})
|
||||
})
|
||||
beforeEach(() => {
|
||||
jest.spyOn(actions, "getExecOutput").mockImplementation(async () => {
|
||||
return execReturn;
|
||||
});
|
||||
});
|
||||
|
||||
test('pulls an image', async () => {
|
||||
await expect(docker.pull(image, args)).rejects.toThrow()
|
||||
})
|
||||
test("pulls an image", async () => {
|
||||
await expect(docker.pull(image, args)).rejects.toThrow();
|
||||
});
|
||||
|
||||
test('inspects a docker image', async () => {
|
||||
const result = await expect(
|
||||
docker.inspect(image, args)
|
||||
).rejects.toThrow()
|
||||
})
|
||||
})
|
||||
})
|
||||
test("inspects a docker image", async () => {
|
||||
const result = await expect(
|
||||
docker.inspect(image, args)
|
||||
).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
+32
-32
@@ -1,32 +1,32 @@
|
||||
import {getExecOutput} from '@actions/exec'
|
||||
|
||||
export class DockerExec {
|
||||
private readonly dockerPath: string
|
||||
|
||||
constructor(dockerPath: string) {
|
||||
this.dockerPath = dockerPath
|
||||
}
|
||||
|
||||
public async pull(image: string, args: string[], silent?: boolean) {
|
||||
const result = await this.execute(['pull', image, ...args], silent)
|
||||
if (result.stderr != '' || result.exitCode != 0) {
|
||||
throw new Error(`docker images pull failed: ${result.stderr}`)
|
||||
}
|
||||
}
|
||||
|
||||
public async inspect(
|
||||
image: string,
|
||||
args: string[],
|
||||
silent: boolean = false
|
||||
): Promise<string> {
|
||||
const result = await this.execute(['inspect', image, ...args], silent)
|
||||
if (result.stderr != '' || result.exitCode != 0)
|
||||
throw new Error(`docker inspect failed: ${result.stderr}`)
|
||||
|
||||
return result.stdout
|
||||
}
|
||||
|
||||
private async execute(args: string[], silent: boolean = false) {
|
||||
return await getExecOutput(this.dockerPath, args, {silent})
|
||||
}
|
||||
}
|
||||
import { getExecOutput } from "@actions/exec";
|
||||
|
||||
export class DockerExec {
|
||||
private readonly dockerPath: string;
|
||||
|
||||
constructor(dockerPath: string) {
|
||||
this.dockerPath = dockerPath;
|
||||
}
|
||||
|
||||
public async pull(image: string, args: string[], silent?: boolean) {
|
||||
const result = await this.execute(["pull", image, ...args], silent);
|
||||
if (result.stderr != "" || result.exitCode != 0) {
|
||||
throw new Error(`docker images pull failed: ${result.stderr}`);
|
||||
}
|
||||
}
|
||||
|
||||
public async inspect(
|
||||
image: string,
|
||||
args: string[],
|
||||
silent: boolean = false
|
||||
): Promise<string> {
|
||||
const result = await this.execute(["inspect", image, ...args], silent);
|
||||
if (result.stderr != "" || result.exitCode != 0)
|
||||
throw new Error(`docker inspect failed: ${result.stderr}`);
|
||||
|
||||
return result.stdout;
|
||||
}
|
||||
|
||||
private async execute(args: string[], silent: boolean = false) {
|
||||
return await getExecOutput(this.dockerPath, args, { silent });
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
export interface Succeeded<T> {
|
||||
readonly succeeded: true
|
||||
readonly result: T
|
||||
}
|
||||
|
||||
export interface Failed {
|
||||
readonly succeeded: false
|
||||
readonly error: string
|
||||
}
|
||||
|
||||
export type Errorable<T> = Succeeded<T> | Failed
|
||||
|
||||
export function succeeded<T>(e: Errorable<T>): e is Succeeded<T> {
|
||||
return e.succeeded
|
||||
}
|
||||
|
||||
export function failed<T>(e: Errorable<T>): e is Failed {
|
||||
return !e.succeeded
|
||||
}
|
||||
|
||||
export function map<T, U>(e: Errorable<T>, fn: (t: T) => U): Errorable<U> {
|
||||
if (failed(e)) {
|
||||
return {succeeded: false, error: e.error}
|
||||
}
|
||||
return {succeeded: true, result: fn(e.result)}
|
||||
}
|
||||
|
||||
export function combine<T>(es: Errorable<T>[]): Errorable<T[]> {
|
||||
const failures = es.filter(failed)
|
||||
if (failures.length > 0) {
|
||||
return {
|
||||
succeeded: false,
|
||||
error: failures.map((f) => f.error).join('\n')
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
succeeded: true,
|
||||
result: es.map((e) => (e as Succeeded<T>).result)
|
||||
}
|
||||
}
|
||||
|
||||
export function getErrorMessage(error: unknown) {
|
||||
if (error instanceof Error) {
|
||||
return error.message
|
||||
}
|
||||
return String(error)
|
||||
}
|
||||
+29
-31
@@ -1,40 +1,38 @@
|
||||
import * as core from '@actions/core'
|
||||
import {Octokit} from '@octokit/core'
|
||||
import {Endpoints} from '@octokit/types'
|
||||
import {retry} from '@octokit/plugin-retry'
|
||||
import * as core from "@actions/core";
|
||||
import { Octokit } from "@octokit/core";
|
||||
import { Endpoints } from "@octokit/types";
|
||||
import { retry } from "@octokit/plugin-retry";
|
||||
|
||||
export const OkStatusCode = 200
|
||||
export const OkStatusCode = 200;
|
||||
|
||||
const RetryOctokit = Octokit.plugin(retry)
|
||||
const RETRY_COUNT = 5
|
||||
const requestUrl = 'GET /repos/{owner}/{repo}/actions/workflows'
|
||||
const RetryOctokit = Octokit.plugin(retry);
|
||||
const RETRY_COUNT = 5;
|
||||
const requestUrl = "GET /repos/{owner}/{repo}/actions/workflows";
|
||||
type responseType =
|
||||
Endpoints['GET /repos/{owner}/{repo}/actions/workflows']['response']
|
||||
Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
|
||||
|
||||
export class GitHubClient {
|
||||
private readonly repository: string
|
||||
private readonly token: string
|
||||
private readonly repository: string;
|
||||
private readonly token: string;
|
||||
|
||||
constructor(repository: string, token: string) {
|
||||
this.repository = repository
|
||||
this.token = token
|
||||
}
|
||||
constructor(repository: string, token: string) {
|
||||
this.repository = repository;
|
||||
this.token = token;
|
||||
}
|
||||
|
||||
// prettier-ignore
|
||||
public async getWorkflows(): Promise<responseType> {
|
||||
const octokit = new RetryOctokit({
|
||||
auth: this.token,
|
||||
request: {retries: RETRY_COUNT},
|
||||
baseUrl: process.env["GITHUB_API_URL"] || "https://api.github.com",
|
||||
public async getWorkflows(): Promise<responseType> {
|
||||
const octokit = new RetryOctokit({
|
||||
auth: this.token,
|
||||
request: { retries: RETRY_COUNT },
|
||||
});
|
||||
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
|
||||
})
|
||||
)
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
export interface K8sObject {
|
||||
metadata: {
|
||||
name: string
|
||||
labels: Map<string, string>
|
||||
namespace?: string
|
||||
}
|
||||
kind: string
|
||||
spec: any
|
||||
}
|
||||
|
||||
export interface K8sServiceObject extends K8sObject {
|
||||
spec: {
|
||||
selector: Map<string, string>
|
||||
}
|
||||
}
|
||||
|
||||
export interface K8sDeleteObject {
|
||||
name: string
|
||||
kind: string
|
||||
namespace?: 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
|
||||
}
|
||||
+318
-524
@@ -1,537 +1,331 @@
|
||||
import {getKubectlPath, Kubectl} from './kubectl'
|
||||
import * as exec from '@actions/exec'
|
||||
import * as io from '@actions/io'
|
||||
import * as core from '@actions/core'
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
import { getKubectlPath, Kubectl } from "./kubectl";
|
||||
import * as exec from "@actions/exec";
|
||||
import * as io from "@actions/io";
|
||||
import * as core from "@actions/core";
|
||||
import * as toolCache from "@actions/tool-cache";
|
||||
import { config } from "process";
|
||||
|
||||
describe('Kubectl path', () => {
|
||||
const version = '1.1'
|
||||
const path = 'path'
|
||||
describe("Kubectl path", () => {
|
||||
const version = "1.1";
|
||||
const path = "path";
|
||||
|
||||
it('gets the kubectl path', async () => {
|
||||
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
|
||||
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
|
||||
it("gets the kubectl path", async () => {
|
||||
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
|
||||
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 () => {
|
||||
jest.spyOn(core, 'getInput').mockImplementationOnce(() => version)
|
||||
jest.spyOn(toolCache, 'find').mockImplementationOnce(() => path)
|
||||
it("gets the kubectl path with version", async () => {
|
||||
jest.spyOn(core, "getInput").mockImplementationOnce(() => version);
|
||||
jest.spyOn(toolCache, "find").mockImplementationOnce(() => path);
|
||||
|
||||
expect(await getKubectlPath()).toBe(path)
|
||||
})
|
||||
expect(await getKubectlPath()).toBe(path);
|
||||
});
|
||||
|
||||
it('throws if kubectl not found', async () => {
|
||||
// without version
|
||||
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
|
||||
await expect(() => getKubectlPath()).rejects.toThrow()
|
||||
it("throws if kubectl not found", async () => {
|
||||
// without version
|
||||
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
|
||||
await expect(() => getKubectlPath()).rejects.toThrow();
|
||||
|
||||
// with verision
|
||||
jest.spyOn(core, 'getInput').mockImplementationOnce(() => undefined)
|
||||
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
|
||||
await expect(() => getKubectlPath()).rejects.toThrow()
|
||||
})
|
||||
})
|
||||
// with verision
|
||||
jest.spyOn(core, "getInput").mockImplementationOnce(() => undefined);
|
||||
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
|
||||
await expect(() => getKubectlPath()).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
const kubectlPath = 'kubectlPath'
|
||||
const testNamespace = 'testNamespace'
|
||||
const defaultNamespace = 'default'
|
||||
const otherNamespace = 'otherns'
|
||||
describe('Kubectl class', () => {
|
||||
describe('with a success exec return in testNamespace', () => {
|
||||
const kubectl = new Kubectl(kubectlPath, testNamespace)
|
||||
const execReturn = {exitCode: 0, stdout: 'Output', stderr: ''}
|
||||
const kubectlPath = "kubectlPath";
|
||||
const namespace = "namespace";
|
||||
describe("Kubectl class", () => {
|
||||
const kubectl = new Kubectl(kubectlPath, namespace);
|
||||
|
||||
beforeEach(() => {
|
||||
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
|
||||
return execReturn
|
||||
})
|
||||
})
|
||||
describe("with a success exec return", () => {
|
||||
const execReturn = { exitCode: 0, stdout: "Output", stderr: "" };
|
||||
|
||||
it('applies a configuration with a single config path', async () => {
|
||||
const configPaths = 'configPaths'
|
||||
const result = await kubectl.apply(configPaths)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['apply', '-f', configPaths, '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
beforeEach(() => {
|
||||
jest.spyOn(exec, "getExecOutput").mockImplementation(async () => {
|
||||
return execReturn;
|
||||
});
|
||||
});
|
||||
|
||||
it('applies a configuration with multiple config paths', async () => {
|
||||
const configPaths = ['configPath1', 'configPath2', 'configPath3']
|
||||
const result = await kubectl.apply(configPaths)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'apply',
|
||||
'-f',
|
||||
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('applies a configuration with force when specified', async () => {
|
||||
const configPaths = ['configPath1', 'configPath2', 'configPath3']
|
||||
const result = await kubectl.apply(configPaths, true)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'apply',
|
||||
'-f',
|
||||
configPaths[0] + ',' + configPaths[1] + ',' + configPaths[2],
|
||||
'--force',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('describes a resource', async () => {
|
||||
const resourceType = 'type'
|
||||
const resourceName = 'name'
|
||||
const result = await kubectl.describe(resourceType, resourceName)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'describe',
|
||||
resourceType,
|
||||
resourceName,
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// overrided ns
|
||||
const silent = false
|
||||
await kubectl.describe(
|
||||
resourceType,
|
||||
resourceName,
|
||||
silent,
|
||||
otherNamespace
|
||||
)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'describe',
|
||||
resourceType,
|
||||
resourceName,
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent}
|
||||
)
|
||||
})
|
||||
|
||||
it('describes a resource silently', async () => {
|
||||
const resourceType = 'type'
|
||||
const resourceName = 'name'
|
||||
const result = await kubectl.describe(resourceType, resourceName, true)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'describe',
|
||||
resourceType,
|
||||
resourceName,
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: true}
|
||||
)
|
||||
|
||||
// overrided ns
|
||||
const silent = false
|
||||
await kubectl.describe(
|
||||
resourceType,
|
||||
resourceName,
|
||||
silent,
|
||||
otherNamespace
|
||||
)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'describe',
|
||||
resourceType,
|
||||
resourceName,
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent}
|
||||
)
|
||||
})
|
||||
|
||||
it('annotates resource', async () => {
|
||||
const resourceType = 'type'
|
||||
const resourceName = 'name'
|
||||
const annotation = 'annotation'
|
||||
const result = await kubectl.annotate(
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation
|
||||
)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.annotate(
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
otherNamespace
|
||||
)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('annotates files with single file', async () => {
|
||||
const file = 'file'
|
||||
const annotation = 'annotation'
|
||||
const result = await kubectl.annotateFiles(file, annotation)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
'-f',
|
||||
file,
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.annotateFiles(file, annotation, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
'-f',
|
||||
file,
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('annotates files with mulitple files', async () => {
|
||||
const files = ['file1', 'file2', 'file3']
|
||||
const annotation = 'annotation'
|
||||
const result = await kubectl.annotateFiles(files, annotation)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
'-f',
|
||||
files.join(','),
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.annotateFiles(files, annotation, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'annotate',
|
||||
'-f',
|
||||
files.join(','),
|
||||
annotation,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('labels files with single file', async () => {
|
||||
const file = 'file'
|
||||
const labels = ['label1', 'label2']
|
||||
const result = await kubectl.labelFiles(file, labels)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'label',
|
||||
'-f',
|
||||
file,
|
||||
...labels,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
await kubectl.labelFiles(file, labels, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'label',
|
||||
'-f',
|
||||
file,
|
||||
...labels,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('labels files with multiple files', async () => {
|
||||
const files = ['file1', 'file2', 'file3']
|
||||
const labels = ['label1', 'label2']
|
||||
const result = await kubectl.labelFiles(files, labels)
|
||||
expect(result).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'label',
|
||||
'-f',
|
||||
files.join(','),
|
||||
...labels,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
await kubectl.labelFiles(files, labels, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'label',
|
||||
'-f',
|
||||
files.join(','),
|
||||
...labels,
|
||||
'--overwrite',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('gets all pods', async () => {
|
||||
expect(await kubectl.getAllPods()).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['get', 'pods', '-o', 'json', '--namespace', testNamespace],
|
||||
{silent: true}
|
||||
)
|
||||
})
|
||||
|
||||
it('checks rollout status', async () => {
|
||||
const resourceType = 'type'
|
||||
const name = 'name'
|
||||
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
|
||||
execReturn
|
||||
)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'rollout',
|
||||
'status',
|
||||
`${resourceType}/${name}`,
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.checkRolloutStatus(resourceType, name, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'rollout',
|
||||
'status',
|
||||
`${resourceType}/${name}`,
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('gets resource', async () => {
|
||||
const resourceType = 'type'
|
||||
const name = 'name'
|
||||
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'get',
|
||||
`${resourceType}/${name}`,
|
||||
'-o',
|
||||
'json',
|
||||
'--namespace',
|
||||
testNamespace
|
||||
],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
const silent = true
|
||||
await kubectl.getResource(resourceType, name, silent, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
'get',
|
||||
`${resourceType}/${name}`,
|
||||
'-o',
|
||||
'json',
|
||||
'--namespace',
|
||||
otherNamespace
|
||||
],
|
||||
{silent}
|
||||
)
|
||||
})
|
||||
|
||||
it('executes a command', async () => {
|
||||
// no args
|
||||
const command = 'command'
|
||||
expect(await kubectl.executeCommand(command)).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[command, '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// with args
|
||||
const args = 'args'
|
||||
expect(await kubectl.executeCommand(command, args)).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[command, args, '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('deletes with single argument', async () => {
|
||||
const arg = 'argument'
|
||||
expect(await kubectl.delete(arg)).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['delete', arg, '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.delete(arg, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['delete', arg, '--namespace', otherNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
|
||||
it('deletes with multiple arguments', async () => {
|
||||
const args = ['argument1', 'argument2', 'argument3']
|
||||
expect(await kubectl.delete(args)).toBe(execReturn)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['delete', ...args, '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
|
||||
// override ns
|
||||
await kubectl.delete(args, otherNamespace)
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
['delete', ...args, '--namespace', otherNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
it('gets new replica sets', async () => {
|
||||
const kubectl = new Kubectl(kubectlPath, testNamespace)
|
||||
|
||||
const newReplicaSetName = 'newreplicaset'
|
||||
const name = 'name'
|
||||
const describeReturn = {
|
||||
exitCode: 0,
|
||||
stdout: newReplicaSetName + name + ' ' + 'extra',
|
||||
stderr: ''
|
||||
}
|
||||
|
||||
jest.spyOn(exec, 'getExecOutput').mockImplementationOnce(async () => {
|
||||
return describeReturn
|
||||
})
|
||||
|
||||
const deployment = 'deployment'
|
||||
const result = await kubectl.getNewReplicaSet(deployment)
|
||||
expect(result).toBe(name)
|
||||
})
|
||||
|
||||
it('executes with constructor flags', async () => {
|
||||
const skipTls = true
|
||||
const kubectl = new Kubectl(kubectlPath, testNamespace, skipTls)
|
||||
|
||||
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
|
||||
return {exitCode: 0, stderr: '', stdout: ''}
|
||||
})
|
||||
|
||||
const command = 'command'
|
||||
kubectl.executeCommand(command)
|
||||
it("applies a configuration with a single config path", async () => {
|
||||
const configPaths = "configPaths";
|
||||
const result = await kubectl.apply(configPaths);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[command, '--insecure-skip-tls-verify', '--namespace', testNamespace],
|
||||
{silent: false}
|
||||
)
|
||||
kubectlPath,
|
||||
["apply", "-f", configPaths, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
const kubectlNoFlags = new Kubectl(kubectlPath)
|
||||
kubectlNoFlags.executeCommand(command)
|
||||
expect(exec.getExecOutput).toBeCalledWith(kubectlPath, [command], {
|
||||
silent: false
|
||||
})
|
||||
})
|
||||
})
|
||||
it("applies a configuration with multiple config paths", async () => {
|
||||
const configPaths = ["configPath1", "configPath2", "configPath3"];
|
||||
const result = await kubectl.apply(configPaths);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"apply",
|
||||
"-f",
|
||||
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("applies a configuration with force when specified", async () => {
|
||||
const configPaths = ["configPath1", "configPath2", "configPath3"];
|
||||
const result = await kubectl.apply(configPaths, true);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"apply",
|
||||
"-f",
|
||||
configPaths[0] + "," + configPaths[1] + "," + configPaths[2],
|
||||
"--force",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("describes a resource", async () => {
|
||||
const resourceType = "type";
|
||||
const resourceName = "name";
|
||||
const result = await kubectl.describe(resourceType, resourceName);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
["describe", resourceType, resourceName, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("describes a resource silently", async () => {
|
||||
const resourceType = "type";
|
||||
const resourceName = "name";
|
||||
const result = await kubectl.describe(resourceType, resourceName, true);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
["describe", resourceType, resourceName, "--namespace", namespace],
|
||||
{ silent: true }
|
||||
);
|
||||
});
|
||||
|
||||
it("annotates resource", async () => {
|
||||
const resourceType = "type";
|
||||
const resourceName = "name";
|
||||
const annotation = "annotation";
|
||||
const result = await kubectl.annotate(
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation
|
||||
);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"annotate",
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
"--overwrite",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("annotates files with single file", async () => {
|
||||
const file = "file";
|
||||
const annotation = "annotation";
|
||||
const result = await kubectl.annotateFiles(file, annotation);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"annotate",
|
||||
"-f",
|
||||
file,
|
||||
annotation,
|
||||
"--overwrite",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("annotates files with mulitple files", async () => {
|
||||
const files = ["file1", "file2", "file3"];
|
||||
const annotation = "annotation";
|
||||
const result = await kubectl.annotateFiles(files, annotation);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"annotate",
|
||||
"-f",
|
||||
files.join(","),
|
||||
annotation,
|
||||
"--overwrite",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("labels files with single file", async () => {
|
||||
const file = "file";
|
||||
const labels = ["label1", "label2"];
|
||||
const result = await kubectl.labelFiles(file, labels);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"label",
|
||||
"-f",
|
||||
file,
|
||||
...labels,
|
||||
"--overwrite",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("labels files with multiple files", async () => {
|
||||
const files = ["file1", "file2", "file3"];
|
||||
const labels = ["label1", "label2"];
|
||||
const result = await kubectl.labelFiles(files, labels);
|
||||
expect(result).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"label",
|
||||
"-f",
|
||||
files.join(","),
|
||||
...labels,
|
||||
"--overwrite",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("gets all pods", async () => {
|
||||
expect(await kubectl.getAllPods()).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
["get", "pods", "-o", "json", "--namespace", namespace],
|
||||
{ silent: true }
|
||||
);
|
||||
});
|
||||
|
||||
it("checks rollout status", async () => {
|
||||
const resourceType = "type";
|
||||
const name = "name";
|
||||
expect(await kubectl.checkRolloutStatus(resourceType, name)).toBe(
|
||||
execReturn
|
||||
);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"rollout",
|
||||
"status",
|
||||
`${resourceType}/${name}`,
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("gets resource", async () => {
|
||||
const resourceType = "type";
|
||||
const name = "name";
|
||||
expect(await kubectl.getResource(resourceType, name)).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[
|
||||
"get",
|
||||
`${resourceType}/${name}`,
|
||||
"-o",
|
||||
"json",
|
||||
"--namespace",
|
||||
namespace,
|
||||
],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("executes a command", async () => {
|
||||
// no args
|
||||
const command = "command";
|
||||
expect(await kubectl.executeCommand(command)).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[command, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
|
||||
// with args
|
||||
const args = "args";
|
||||
expect(await kubectl.executeCommand(command, args)).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
[command, args, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("deletes with single argument", async () => {
|
||||
const arg = "argument";
|
||||
expect(await kubectl.delete(arg)).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
["delete", arg, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
|
||||
it("deletes with multiple arguments", async () => {
|
||||
const args = ["argument1", "argument2", "argument3"];
|
||||
expect(await kubectl.delete(args)).toBe(execReturn);
|
||||
expect(exec.getExecOutput).toBeCalledWith(
|
||||
kubectlPath,
|
||||
["delete", ...args, "--namespace", namespace],
|
||||
{ silent: false }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it("gets new replica sets", async () => {
|
||||
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
-232
@@ -1,232 +1,168 @@
|
||||
import {ExecOutput, getExecOutput} from '@actions/exec'
|
||||
import {createInlineArray} from '../utilities/arrayUtils'
|
||||
import * as core from '@actions/core'
|
||||
import * as toolCache from '@actions/tool-cache'
|
||||
import * as io from '@actions/io'
|
||||
|
||||
export interface Resource {
|
||||
name: string
|
||||
type: string
|
||||
namespace?: string
|
||||
}
|
||||
|
||||
export class Kubectl {
|
||||
protected readonly kubectlPath: string
|
||||
protected readonly namespace: string
|
||||
protected readonly ignoreSSLErrors: boolean
|
||||
protected readonly resourceGroup: string
|
||||
protected readonly name: string
|
||||
protected isPrivateCluster: boolean
|
||||
|
||||
constructor(
|
||||
kubectlPath: string,
|
||||
namespace: string = '',
|
||||
ignoreSSLErrors: boolean = false,
|
||||
resourceGroup: string = '',
|
||||
name: string = ''
|
||||
) {
|
||||
this.kubectlPath = kubectlPath
|
||||
this.ignoreSSLErrors = !!ignoreSSLErrors
|
||||
this.namespace = namespace
|
||||
this.resourceGroup = resourceGroup
|
||||
this.name = name
|
||||
}
|
||||
|
||||
public async apply(
|
||||
configurationPaths: string | string[],
|
||||
force: boolean = false
|
||||
): Promise<ExecOutput> {
|
||||
try {
|
||||
if (!configurationPaths || configurationPaths?.length === 0)
|
||||
throw Error('Configuration paths must exist')
|
||||
|
||||
const applyArgs: string[] = [
|
||||
'apply',
|
||||
'-f',
|
||||
createInlineArray(configurationPaths)
|
||||
]
|
||||
if (force) applyArgs.push('--force')
|
||||
|
||||
return await this.execute(applyArgs.concat(this.getFlags()))
|
||||
} catch (err) {
|
||||
core.debug('Kubectl apply failed:' + err)
|
||||
}
|
||||
}
|
||||
|
||||
public async describe(
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
silent: boolean = false,
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
return await this.execute(
|
||||
['describe', resourceType, resourceName].concat(
|
||||
this.getFlags(namespace)
|
||||
),
|
||||
silent
|
||||
)
|
||||
}
|
||||
|
||||
public async getNewReplicaSet(deployment: string, namespace?: string) {
|
||||
const result = await this.describe(
|
||||
'deployment',
|
||||
deployment,
|
||||
true,
|
||||
namespace
|
||||
)
|
||||
|
||||
let newReplicaSet = ''
|
||||
if (result?.stdout) {
|
||||
const stdout = result.stdout.split('\n')
|
||||
core.debug('stdout from getNewReplicaSet is ' + JSON.stringify(stdout))
|
||||
stdout.forEach((line: string) => {
|
||||
const newreplicaset = 'newreplicaset'
|
||||
if (line && line.toLowerCase().indexOf(newreplicaset) > -1) {
|
||||
core.debug(
|
||||
`found string of interest for replicaset, line is ${line}`
|
||||
)
|
||||
core.debug(
|
||||
`substring is ${line.substring(newreplicaset.length).trim()}`
|
||||
)
|
||||
newReplicaSet = line
|
||||
.substring(newreplicaset.length)
|
||||
.trim()
|
||||
.split(' ')[0]
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
return newReplicaSet
|
||||
}
|
||||
|
||||
public async annotate(
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
annotation: string,
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
const args = [
|
||||
'annotate',
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
'--overwrite'
|
||||
].concat(this.getFlags(namespace))
|
||||
return await this.execute(args)
|
||||
}
|
||||
|
||||
public async annotateFiles(
|
||||
files: string | string[],
|
||||
annotation: string,
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
const filesToAnnotate = createInlineArray(files)
|
||||
core.debug(`annotating ${filesToAnnotate} with annotation ${annotation}`)
|
||||
const args = [
|
||||
'annotate',
|
||||
'-f',
|
||||
filesToAnnotate,
|
||||
annotation,
|
||||
'--overwrite'
|
||||
].concat(this.getFlags(namespace))
|
||||
return await this.execute(args)
|
||||
}
|
||||
|
||||
public async labelFiles(
|
||||
files: string | string[],
|
||||
labels: string[],
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
const args = [
|
||||
'label',
|
||||
'-f',
|
||||
createInlineArray(files),
|
||||
...labels,
|
||||
'--overwrite'
|
||||
].concat(this.getFlags(namespace))
|
||||
return await this.execute(args)
|
||||
}
|
||||
|
||||
public async getAllPods(): Promise<ExecOutput> {
|
||||
return await this.execute(
|
||||
['get', 'pods', '-o', 'json'].concat(this.getFlags()),
|
||||
true
|
||||
)
|
||||
}
|
||||
|
||||
public async checkRolloutStatus(
|
||||
resourceType: string,
|
||||
name: string,
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
return await this.execute(
|
||||
['rollout', 'status', `${resourceType}/${name}`].concat(
|
||||
this.getFlags(namespace)
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
public async getResource(
|
||||
resourceType: string,
|
||||
name: string,
|
||||
silentFailure: boolean = false,
|
||||
namespace?: string
|
||||
): Promise<ExecOutput> {
|
||||
core.debug(
|
||||
'fetching resource of type ' + resourceType + ' and name ' + name
|
||||
)
|
||||
return await this.execute(
|
||||
['get', `${resourceType}/${name}`, '-o', 'json'].concat(
|
||||
this.getFlags(namespace)
|
||||
),
|
||||
silentFailure
|
||||
)
|
||||
}
|
||||
|
||||
public executeCommand(command: string, args?: string) {
|
||||
if (!command) throw new Error('Command must be defined')
|
||||
const a = args ? [args] : []
|
||||
return this.execute([command, ...a.concat(this.getFlags())])
|
||||
}
|
||||
|
||||
public delete(args: string | string[], namespace?: string) {
|
||||
if (typeof args === 'string')
|
||||
return this.execute(['delete', args].concat(this.getFlags(namespace)))
|
||||
return this.execute(['delete', ...args.concat(this.getFlags(namespace))])
|
||||
}
|
||||
|
||||
protected async execute(args: string[], silent: boolean = false) {
|
||||
core.debug(`Kubectl run with command: ${this.kubectlPath} ${args}`)
|
||||
|
||||
return await getExecOutput(this.kubectlPath, args, {
|
||||
silent
|
||||
})
|
||||
}
|
||||
|
||||
protected getFlags(namespaceOverride?: string): string[] {
|
||||
const flags = []
|
||||
if (this.ignoreSSLErrors) {
|
||||
flags.push('--insecure-skip-tls-verify')
|
||||
}
|
||||
|
||||
const ns = namespaceOverride || this.namespace
|
||||
if (ns) {
|
||||
flags.push('--namespace', ns)
|
||||
}
|
||||
|
||||
return flags
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
import { ExecOutput, getExecOutput } from "@actions/exec";
|
||||
import { createInlineArray } from "../utilities/arrayUtils";
|
||||
import * as core from "@actions/core";
|
||||
import * as toolCache from "@actions/tool-cache";
|
||||
import * as io from "@actions/io";
|
||||
|
||||
export interface Resource {
|
||||
name: string;
|
||||
type: string;
|
||||
}
|
||||
|
||||
export class Kubectl {
|
||||
private readonly kubectlPath: string;
|
||||
private readonly namespace: string;
|
||||
private readonly ignoreSSLErrors: boolean;
|
||||
|
||||
constructor(
|
||||
kubectlPath: string,
|
||||
namespace: string = "default",
|
||||
ignoreSSLErrors: boolean = false
|
||||
) {
|
||||
this.kubectlPath = kubectlPath;
|
||||
this.ignoreSSLErrors = !!ignoreSSLErrors;
|
||||
this.namespace = namespace;
|
||||
}
|
||||
|
||||
public async apply(
|
||||
configurationPaths: string | string[],
|
||||
force: boolean = false
|
||||
): Promise<ExecOutput> {
|
||||
try {
|
||||
if (!configurationPaths || configurationPaths?.length === 0)
|
||||
throw Error("Configuration paths must exist");
|
||||
|
||||
const applyArgs: string[] = [
|
||||
"apply",
|
||||
"-f",
|
||||
createInlineArray(configurationPaths),
|
||||
];
|
||||
if (force) applyArgs.push("--force");
|
||||
|
||||
return await this.execute(applyArgs);
|
||||
} catch (err) {
|
||||
core.debug("Kubectl apply failed:" + err);
|
||||
}
|
||||
}
|
||||
|
||||
public async describe(
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
silent: boolean = false
|
||||
): Promise<ExecOutput> {
|
||||
return await this.execute(["describe", resourceType, resourceName], silent);
|
||||
}
|
||||
|
||||
public async getNewReplicaSet(deployment: string) {
|
||||
const result = await this.describe("deployment", deployment, true);
|
||||
|
||||
let newReplicaSet = "";
|
||||
if (result?.stdout) {
|
||||
const stdout = result.stdout.split("\n");
|
||||
stdout.forEach((line: string) => {
|
||||
const newreplicaset = "newreplicaset";
|
||||
if (line && line.toLowerCase().indexOf(newreplicaset) > -1)
|
||||
newReplicaSet = line
|
||||
.substring(newreplicaset.length)
|
||||
.trim()
|
||||
.split(" ")[0];
|
||||
});
|
||||
}
|
||||
|
||||
return newReplicaSet;
|
||||
}
|
||||
|
||||
public async annotate(
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
annotation: string
|
||||
): Promise<ExecOutput> {
|
||||
const args = [
|
||||
"annotate",
|
||||
resourceType,
|
||||
resourceName,
|
||||
annotation,
|
||||
"--overwrite",
|
||||
];
|
||||
return await this.execute(args);
|
||||
}
|
||||
|
||||
public async annotateFiles(
|
||||
files: string | string[],
|
||||
annotation: string
|
||||
): Promise<ExecOutput> {
|
||||
const args = [
|
||||
"annotate",
|
||||
"-f",
|
||||
createInlineArray(files),
|
||||
annotation,
|
||||
"--overwrite",
|
||||
];
|
||||
return await this.execute(args);
|
||||
}
|
||||
|
||||
public async labelFiles(
|
||||
files: string | string[],
|
||||
labels: string[]
|
||||
): Promise<ExecOutput> {
|
||||
const args = [
|
||||
"label",
|
||||
"-f",
|
||||
createInlineArray(files),
|
||||
...labels,
|
||||
"--overwrite",
|
||||
];
|
||||
return await this.execute(args);
|
||||
}
|
||||
|
||||
public async getAllPods(): Promise<ExecOutput> {
|
||||
return await this.execute(["get", "pods", "-o", "json"], true);
|
||||
}
|
||||
|
||||
public async checkRolloutStatus(
|
||||
resourceType: string,
|
||||
name: string
|
||||
): Promise<ExecOutput> {
|
||||
return await this.execute(["rollout", "status", `${resourceType}/${name}`]);
|
||||
}
|
||||
|
||||
public async getResource(
|
||||
resourceType: string,
|
||||
name: string
|
||||
): Promise<ExecOutput> {
|
||||
return await this.execute(["get", `${resourceType}/${name}`, "-o", "json"]);
|
||||
}
|
||||
|
||||
public executeCommand(command: string, args?: string) {
|
||||
if (!command) throw new Error("Command must be defined");
|
||||
return args ? this.execute([command, args]) : this.execute([command]);
|
||||
}
|
||||
|
||||
public delete(args: string | string[]) {
|
||||
if (typeof args === "string") return this.execute(["delete", args]);
|
||||
return this.execute(["delete", ...args]);
|
||||
}
|
||||
|
||||
private async execute(args: string[], silent: boolean = false) {
|
||||
if (this.ignoreSSLErrors) {
|
||||
args.push("--insecure-skip-tls-verify");
|
||||
}
|
||||
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
@@ -1,117 +1,115 @@
|
||||
import {
|
||||
DEPLOYMENT_TYPES,
|
||||
DiscoveryAndLoadBalancerResource,
|
||||
isDeploymentEntity,
|
||||
isIngressEntity,
|
||||
isServiceEntity,
|
||||
isWorkloadEntity,
|
||||
KubernetesWorkload,
|
||||
ResourceKindNotDefinedError,
|
||||
ServiceTypes,
|
||||
WORKLOAD_TYPES,
|
||||
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS
|
||||
} from './kubernetesTypes'
|
||||
DEPLOYMENT_TYPES,
|
||||
DiscoveryAndLoadBalancerResource,
|
||||
isDeploymentEntity,
|
||||
isIngressEntity,
|
||||
isServiceEntity,
|
||||
isWorkloadEntity,
|
||||
KubernetesWorkload,
|
||||
ResourceKindNotDefinedError,
|
||||
ServiceTypes,
|
||||
WORKLOAD_TYPES,
|
||||
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS,
|
||||
} from "./kubernetesTypes";
|
||||
|
||||
describe('Kubernetes types', () => {
|
||||
it('contains kubernetes workloads', () => {
|
||||
expect(KubernetesWorkload.POD).toBe('Pod')
|
||||
expect(KubernetesWorkload.REPLICASET).toBe('Replicaset')
|
||||
expect(KubernetesWorkload.DEPLOYMENT).toBe('Deployment')
|
||||
expect(KubernetesWorkload.STATEFUL_SET).toBe('StatefulSet')
|
||||
expect(KubernetesWorkload.DAEMON_SET).toBe('DaemonSet')
|
||||
expect(KubernetesWorkload.JOB).toBe('job')
|
||||
expect(KubernetesWorkload.CRON_JOB).toBe('cronjob')
|
||||
})
|
||||
describe("Kubernetes types", () => {
|
||||
it("contains kubernetes workloads", () => {
|
||||
expect(KubernetesWorkload.POD).toBe("Pod");
|
||||
expect(KubernetesWorkload.REPLICASET).toBe("Replicaset");
|
||||
expect(KubernetesWorkload.DEPLOYMENT).toBe("Deployment");
|
||||
expect(KubernetesWorkload.STATEFUL_SET).toBe("StatefulSet");
|
||||
expect(KubernetesWorkload.DAEMON_SET).toBe("DaemonSet");
|
||||
expect(KubernetesWorkload.JOB).toBe("job");
|
||||
expect(KubernetesWorkload.CRON_JOB).toBe("cronjob");
|
||||
});
|
||||
|
||||
it('contains discovery and load balancer resources', () => {
|
||||
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe('service')
|
||||
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe('ingress')
|
||||
})
|
||||
it("contains discovery and load balancer resources", () => {
|
||||
expect(DiscoveryAndLoadBalancerResource.SERVICE).toBe("service");
|
||||
expect(DiscoveryAndLoadBalancerResource.INGRESS).toBe("ingress");
|
||||
});
|
||||
|
||||
it('contains service types', () => {
|
||||
expect(ServiceTypes.LOAD_BALANCER).toBe('LoadBalancer')
|
||||
expect(ServiceTypes.NODE_PORT).toBe('NodePort')
|
||||
expect(ServiceTypes.CLUSTER_IP).toBe('ClusterIP')
|
||||
})
|
||||
it("contains service types", () => {
|
||||
expect(ServiceTypes.LOAD_BALANCER).toBe("LoadBalancer");
|
||||
expect(ServiceTypes.NODE_PORT).toBe("NodePort");
|
||||
expect(ServiceTypes.CLUSTER_IP).toBe("ClusterIP");
|
||||
});
|
||||
|
||||
it('contains deployment types', () => {
|
||||
const expected = [
|
||||
'deployment',
|
||||
'replicaset',
|
||||
'daemonset',
|
||||
'pod',
|
||||
'statefulset'
|
||||
]
|
||||
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true)
|
||||
})
|
||||
it("contains deployment types", () => {
|
||||
const expected = [
|
||||
"deployment",
|
||||
"replicaset",
|
||||
"daemonset",
|
||||
"pod",
|
||||
"statefulset",
|
||||
];
|
||||
expect(expected.every((val) => DEPLOYMENT_TYPES.includes(val))).toBe(true);
|
||||
});
|
||||
|
||||
it('contains workload types', () => {
|
||||
const expected = [
|
||||
'deployment',
|
||||
'replicaset',
|
||||
'daemonset',
|
||||
'pod',
|
||||
'statefulset',
|
||||
'job',
|
||||
'cronjob'
|
||||
]
|
||||
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true)
|
||||
})
|
||||
it("contains workload types", () => {
|
||||
const expected = [
|
||||
"deployment",
|
||||
"replicaset",
|
||||
"daemonset",
|
||||
"pod",
|
||||
"statefulset",
|
||||
"job",
|
||||
"cronjob",
|
||||
];
|
||||
expect(expected.every((val) => WORKLOAD_TYPES.includes(val))).toBe(true);
|
||||
});
|
||||
|
||||
it('contains workload types with rollout status', () => {
|
||||
const expected = ['deployment', 'daemonset', 'statefulset']
|
||||
expect(
|
||||
expected.every((val) =>
|
||||
WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val)
|
||||
)
|
||||
).toBe(true)
|
||||
})
|
||||
it("contains workload types with rollout status", () => {
|
||||
const expected = ["deployment", "daemonset", "statefulset"];
|
||||
expect(
|
||||
expected.every((val) => WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.includes(val))
|
||||
).toBe(true);
|
||||
});
|
||||
|
||||
it('checks if kind is deployment entity', () => {
|
||||
// throws on no kind
|
||||
expect(() => isDeploymentEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
)
|
||||
it("checks if kind is deployment entity", () => {
|
||||
// throws on no kind
|
||||
expect(() => isDeploymentEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
);
|
||||
|
||||
expect(isDeploymentEntity('deployment')).toBe(true)
|
||||
expect(isDeploymentEntity('Deployment')).toBe(true)
|
||||
expect(isDeploymentEntity('deploymenT')).toBe(true)
|
||||
expect(isDeploymentEntity('DEPLOYMENT')).toBe(true)
|
||||
})
|
||||
expect(isDeploymentEntity("deployment")).toBe(true);
|
||||
expect(isDeploymentEntity("Deployment")).toBe(true);
|
||||
expect(isDeploymentEntity("deploymenT")).toBe(true);
|
||||
expect(isDeploymentEntity("DEPLOYMENT")).toBe(true);
|
||||
});
|
||||
|
||||
it('checks if kind is workload entity', () => {
|
||||
// throws on no kind
|
||||
expect(() => isWorkloadEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
)
|
||||
it("checks if kind is workload entity", () => {
|
||||
// throws on no kind
|
||||
expect(() => isWorkloadEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
);
|
||||
|
||||
expect(isWorkloadEntity('deployment')).toBe(true)
|
||||
expect(isWorkloadEntity('Deployment')).toBe(true)
|
||||
expect(isWorkloadEntity('deploymenT')).toBe(true)
|
||||
expect(isWorkloadEntity('DEPLOYMENT')).toBe(true)
|
||||
})
|
||||
expect(isWorkloadEntity("deployment")).toBe(true);
|
||||
expect(isWorkloadEntity("Deployment")).toBe(true);
|
||||
expect(isWorkloadEntity("deploymenT")).toBe(true);
|
||||
expect(isWorkloadEntity("DEPLOYMENT")).toBe(true);
|
||||
});
|
||||
|
||||
it('checks if kind is service entity', () => {
|
||||
// throws on no kind
|
||||
expect(() => isServiceEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
)
|
||||
it("checks if kind is service entity", () => {
|
||||
// throws on no kind
|
||||
expect(() => isServiceEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
);
|
||||
|
||||
expect(isServiceEntity('service')).toBe(true)
|
||||
expect(isServiceEntity('Service')).toBe(true)
|
||||
expect(isServiceEntity('servicE')).toBe(true)
|
||||
expect(isServiceEntity('SERVICE')).toBe(true)
|
||||
})
|
||||
expect(isServiceEntity("service")).toBe(true);
|
||||
expect(isServiceEntity("Service")).toBe(true);
|
||||
expect(isServiceEntity("servicE")).toBe(true);
|
||||
expect(isServiceEntity("SERVICE")).toBe(true);
|
||||
});
|
||||
|
||||
it('checks if kind is ingress entity', () => {
|
||||
// throws on no kind
|
||||
expect(() => isIngressEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
)
|
||||
it("checks if kind is ingress entity", () => {
|
||||
// throws on no kind
|
||||
expect(() => isIngressEntity(undefined)).toThrow(
|
||||
ResourceKindNotDefinedError
|
||||
);
|
||||
|
||||
expect(isIngressEntity('ingress')).toBe(true)
|
||||
expect(isIngressEntity('Ingress')).toBe(true)
|
||||
expect(isIngressEntity('ingresS')).toBe(true)
|
||||
expect(isIngressEntity('INGRESS')).toBe(true)
|
||||
})
|
||||
})
|
||||
expect(isIngressEntity("ingress")).toBe(true);
|
||||
expect(isIngressEntity("Ingress")).toBe(true);
|
||||
expect(isIngressEntity("ingresS")).toBe(true);
|
||||
expect(isIngressEntity("INGRESS")).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,81 +1,81 @@
|
||||
export class KubernetesWorkload {
|
||||
public static POD: string = 'Pod'
|
||||
public static REPLICASET: string = 'Replicaset'
|
||||
public static DEPLOYMENT: string = 'Deployment'
|
||||
public static STATEFUL_SET: string = 'StatefulSet'
|
||||
public static DAEMON_SET: string = 'DaemonSet'
|
||||
public static JOB: string = 'job'
|
||||
public static CRON_JOB: string = 'cronjob'
|
||||
}
|
||||
|
||||
export class DiscoveryAndLoadBalancerResource {
|
||||
public static SERVICE: string = 'service'
|
||||
public static INGRESS: string = 'ingress'
|
||||
}
|
||||
|
||||
export class ServiceTypes {
|
||||
public static LOAD_BALANCER: string = 'LoadBalancer'
|
||||
public static NODE_PORT: string = 'NodePort'
|
||||
public static CLUSTER_IP: string = 'ClusterIP'
|
||||
}
|
||||
|
||||
export const DEPLOYMENT_TYPES: string[] = [
|
||||
'deployment',
|
||||
'replicaset',
|
||||
'daemonset',
|
||||
'pod',
|
||||
'statefulset'
|
||||
]
|
||||
|
||||
export const WORKLOAD_TYPES: string[] = [
|
||||
'deployment',
|
||||
'replicaset',
|
||||
'daemonset',
|
||||
'pod',
|
||||
'statefulset',
|
||||
'job',
|
||||
'cronjob'
|
||||
]
|
||||
|
||||
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
|
||||
'deployment',
|
||||
'daemonset',
|
||||
'statefulset'
|
||||
]
|
||||
|
||||
export function isDeploymentEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError
|
||||
|
||||
return DEPLOYMENT_TYPES.some((type: string) => {
|
||||
return type.toLowerCase() === kind.toLowerCase()
|
||||
})
|
||||
}
|
||||
|
||||
export function isWorkloadEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError
|
||||
|
||||
return WORKLOAD_TYPES.some(
|
||||
(type: string) => type.toLowerCase() === kind.toLowerCase()
|
||||
)
|
||||
}
|
||||
|
||||
export function isServiceEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError
|
||||
|
||||
return 'service' === kind.toLowerCase()
|
||||
}
|
||||
|
||||
export function isIngressEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError
|
||||
|
||||
return 'ingress' === kind.toLowerCase()
|
||||
}
|
||||
|
||||
export const ResourceKindNotDefinedError = Error('Resource kind not defined')
|
||||
export const NullInputObjectError = Error('Null inputObject')
|
||||
export const InputObjectKindNotDefinedError = Error(
|
||||
'Input object kind not defined'
|
||||
)
|
||||
export const InputObjectMetadataNotDefinedError = Error(
|
||||
'Input object metatada not defined'
|
||||
)
|
||||
export class KubernetesWorkload {
|
||||
public static POD: string = "Pod";
|
||||
public static REPLICASET: string = "Replicaset";
|
||||
public static DEPLOYMENT: string = "Deployment";
|
||||
public static STATEFUL_SET: string = "StatefulSet";
|
||||
public static DAEMON_SET: string = "DaemonSet";
|
||||
public static JOB: string = "job";
|
||||
public static CRON_JOB: string = "cronjob";
|
||||
}
|
||||
|
||||
export class DiscoveryAndLoadBalancerResource {
|
||||
public static SERVICE: string = "service";
|
||||
public static INGRESS: string = "ingress";
|
||||
}
|
||||
|
||||
export class ServiceTypes {
|
||||
public static LOAD_BALANCER: string = "LoadBalancer";
|
||||
public static NODE_PORT: string = "NodePort";
|
||||
public static CLUSTER_IP: string = "ClusterIP";
|
||||
}
|
||||
|
||||
export const DEPLOYMENT_TYPES: string[] = [
|
||||
"deployment",
|
||||
"replicaset",
|
||||
"daemonset",
|
||||
"pod",
|
||||
"statefulset",
|
||||
];
|
||||
|
||||
export const WORKLOAD_TYPES: string[] = [
|
||||
"deployment",
|
||||
"replicaset",
|
||||
"daemonset",
|
||||
"pod",
|
||||
"statefulset",
|
||||
"job",
|
||||
"cronjob",
|
||||
];
|
||||
|
||||
export const WORKLOAD_TYPES_WITH_ROLLOUT_STATUS: string[] = [
|
||||
"deployment",
|
||||
"daemonset",
|
||||
"statefulset",
|
||||
];
|
||||
|
||||
export function isDeploymentEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError;
|
||||
|
||||
return DEPLOYMENT_TYPES.some((type: string) => {
|
||||
return type.toLowerCase() === kind.toLowerCase();
|
||||
});
|
||||
}
|
||||
|
||||
export function isWorkloadEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError;
|
||||
|
||||
return WORKLOAD_TYPES.some(
|
||||
(type: string) => type.toLowerCase() === kind.toLowerCase()
|
||||
);
|
||||
}
|
||||
|
||||
export function isServiceEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError;
|
||||
|
||||
return "service" === kind.toLowerCase();
|
||||
}
|
||||
|
||||
export function isIngressEntity(kind: string): boolean {
|
||||
if (!kind) throw ResourceKindNotDefinedError;
|
||||
|
||||
return "ingress" === kind.toLowerCase();
|
||||
}
|
||||
|
||||
export const ResourceKindNotDefinedError = Error("Resource kind not defined");
|
||||
export const NullInputObjectError = Error("Null inputObject");
|
||||
export const InputObjectKindNotDefinedError = Error(
|
||||
"Input object kind not defined"
|
||||
);
|
||||
export const InputObjectMetadataNotDefinedError = Error(
|
||||
"Input object metatada not defined"
|
||||
);
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
import * as fileUtils from '../utilities/fileUtils'
|
||||
import fs from 'node:fs'
|
||||
import {
|
||||
PrivateKubectl,
|
||||
extractFileNames,
|
||||
replaceFileNamesWithShallowNamesRelativeToTemp
|
||||
} from './privatekubectl'
|
||||
import * as exec from '@actions/exec'
|
||||
|
||||
describe('Private kubectl', () => {
|
||||
const testString = `kubectl annotate -f /tmp/testdir/test.yml,/tmp/test2.yml,/tmp/testdir/subdir/test3.yml -f /tmp/test4.yml --filename /tmp/test5.yml actions.github.com/k8s-deploy={"run":"3498366832","repository":"jaiveerk/k8s-deploy","workflow":"Minikube Integration Tests - private cluster","workflowFileName":"run-integration-tests-private.yml","jobName":"run-integration-test","createdBy":"jaiveerk","runUri":"https://github.com/jaiveerk/k8s-deploy/actions/runs/3498366832","commit":"c63b323186ea1320a31290de6dcc094c06385e75","lastSuccessRunCommit":"NA","branch":"refs/heads/main","deployTimestamp":1668787848577,"dockerfilePaths":{"nginx:1.14.2":""},"manifestsPaths":["https://github.com/jaiveerk/k8s-deploy/blob/c63b323186ea1320a31290de6dcc094c06385e75/test/integration/test.yml"],"helmChartPaths":[],"provider":"GitHub"} --overwrite --namespace test-3498366832`
|
||||
const mockKube = new PrivateKubectl(
|
||||
'kubectlPath',
|
||||
'namespace',
|
||||
true,
|
||||
'resourceGroup',
|
||||
'resourceName'
|
||||
)
|
||||
|
||||
const spy = jest
|
||||
.spyOn(fileUtils, 'getTempDirectory')
|
||||
.mockImplementation(() => {
|
||||
return '/tmp'
|
||||
})
|
||||
|
||||
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
|
||||
return 'test contents'
|
||||
})
|
||||
|
||||
it('should extract filenames correctly', () => {
|
||||
expect(extractFileNames(testString)).toEqual([
|
||||
'/tmp/testdir/test.yml',
|
||||
'/tmp/test2.yml',
|
||||
'/tmp/testdir/subdir/test3.yml',
|
||||
'/tmp/test4.yml',
|
||||
'/tmp/test5.yml'
|
||||
])
|
||||
})
|
||||
|
||||
it('should replace filenames with shallow names for relative locations in tmp correctly', () => {
|
||||
expect(
|
||||
replaceFileNamesWithShallowNamesRelativeToTemp(testString)
|
||||
).toEqual(
|
||||
`kubectl annotate -f testdir-test.yml,test2.yml,testdir-subdir-test3.yml -f test4.yml --filename test5.yml actions.github.com/k8s-deploy={"run":"3498366832","repository":"jaiveerk/k8s-deploy","workflow":"Minikube Integration Tests - private cluster","workflowFileName":"run-integration-tests-private.yml","jobName":"run-integration-test","createdBy":"jaiveerk","runUri":"https://github.com/jaiveerk/k8s-deploy/actions/runs/3498366832","commit":"c63b323186ea1320a31290de6dcc094c06385e75","lastSuccessRunCommit":"NA","branch":"refs/heads/main","deployTimestamp":1668787848577,"dockerfilePaths":{"nginx:1.14.2":""},"manifestsPaths":["https://github.com/jaiveerk/k8s-deploy/blob/c63b323186ea1320a31290de6dcc094c06385e75/test/integration/test.yml"],"helmChartPaths":[],"provider":"GitHub"} --overwrite --namespace test-3498366832`
|
||||
)
|
||||
})
|
||||
|
||||
test('Should throw well defined Error on error from Azure', async () => {
|
||||
const errorMsg = 'An error message'
|
||||
jest.spyOn(exec, 'getExecOutput').mockImplementation(async () => {
|
||||
return {exitCode: 1, stdout: '', stderr: errorMsg}
|
||||
})
|
||||
|
||||
await expect(mockKube.executeCommand('az', 'test')).rejects.toThrow(
|
||||
Error(
|
||||
`Call to private cluster failed. Command: 'kubectl az test --insecure-skip-tls-verify --namespace namespace', errormessage: ${errorMsg}`
|
||||
)
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -1,169 +0,0 @@
|
||||
import {Kubectl} from './kubectl'
|
||||
import minimist from 'minimist'
|
||||
import {ExecOptions, ExecOutput, getExecOutput} from '@actions/exec'
|
||||
import * as core from '@actions/core'
|
||||
import fs from 'node:fs'
|
||||
import * as path from 'path'
|
||||
import {getTempDirectory} from '../utilities/fileUtils'
|
||||
|
||||
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: true,
|
||||
failOnStdErr: false,
|
||||
ignoreReturnCode: true
|
||||
}
|
||||
|
||||
if (this.containsFilenames(kubectlCmd)) {
|
||||
kubectlCmd = replaceFileNamesWithShallowNamesRelativeToTemp(kubectlCmd)
|
||||
addFileFlag = true
|
||||
}
|
||||
|
||||
if (this.resourceGroup === '') {
|
||||
throw Error('Resource group must be specified for private cluster')
|
||||
}
|
||||
if (this.name === '') {
|
||||
throw Error('Cluster name must be specified for private cluster')
|
||||
}
|
||||
|
||||
const privateClusterArgs = [
|
||||
'aks',
|
||||
'command',
|
||||
'invoke',
|
||||
'--resource-group',
|
||||
this.resourceGroup,
|
||||
'--name',
|
||||
this.name,
|
||||
'--command',
|
||||
`${kubectlCmd}`
|
||||
]
|
||||
|
||||
if (addFileFlag) {
|
||||
const tempDirectory = getTempDirectory()
|
||||
eo.cwd = path.join(tempDirectory, 'manifests')
|
||||
privateClusterArgs.push(...['--file', '.'])
|
||||
}
|
||||
|
||||
core.debug(
|
||||
`private cluster Kubectl run with invoke command: ${kubectlCmd}`
|
||||
)
|
||||
|
||||
const allArgs = [...privateClusterArgs, '-o', 'json']
|
||||
core.debug(`full form of az command: az ${allArgs.join(' ')}`)
|
||||
const runOutput = await getExecOutput('az', allArgs, eo)
|
||||
core.debug(
|
||||
`from kubectl private cluster command got run output ${JSON.stringify(
|
||||
runOutput
|
||||
)}`
|
||||
)
|
||||
|
||||
if (runOutput.exitCode !== 0) {
|
||||
throw Error(
|
||||
`Call to private cluster failed. Command: '${kubectlCmd}', errormessage: ${runOutput.stderr}`
|
||||
)
|
||||
}
|
||||
|
||||
const runObj: {logs: string; exitCode: number} = JSON.parse(
|
||||
runOutput.stdout
|
||||
)
|
||||
if (!silent) core.info(runObj.logs)
|
||||
if (runObj.exitCode !== 0) {
|
||||
throw Error(`failed private cluster Kubectl command: ${kubectlCmd}`)
|
||||
}
|
||||
|
||||
return {
|
||||
exitCode: runObj.exitCode,
|
||||
stdout: runObj.logs,
|
||||
stderr: ''
|
||||
} as ExecOutput
|
||||
}
|
||||
|
||||
private containsFilenames(str: string) {
|
||||
return str.includes('-f ') || str.includes('filename ')
|
||||
}
|
||||
}
|
||||
|
||||
function createTempManifestsDirectory(): string {
|
||||
const manifestsDirPath = path.join(getTempDirectory(), 'manifests')
|
||||
if (!fs.existsSync(manifestsDirPath)) {
|
||||
fs.mkdirSync(manifestsDirPath, {recursive: true})
|
||||
}
|
||||
|
||||
return manifestsDirPath
|
||||
}
|
||||
|
||||
export function replaceFileNamesWithShallowNamesRelativeToTemp(
|
||||
kubectlCmd: string
|
||||
) {
|
||||
let filenames = extractFileNames(kubectlCmd)
|
||||
core.debug(`filenames originally provided in kubectl command: ${filenames}`)
|
||||
let relativeShallowNames = filenames.map((filename) => {
|
||||
const relativeName = path.relative(getTempDirectory(), filename)
|
||||
|
||||
const relativePathElements = relativeName.split(path.sep)
|
||||
|
||||
const shallowName = relativePathElements.join('-')
|
||||
|
||||
// make manifests dir in temp if it doesn't already exist
|
||||
const manifestsTempDir = createTempManifestsDirectory()
|
||||
|
||||
const shallowPath = path.join(manifestsTempDir, shallowName)
|
||||
core.debug(
|
||||
`moving contents from ${filename} to shallow location at ${shallowPath}`
|
||||
)
|
||||
|
||||
core.debug(`reading contents from ${filename}`)
|
||||
const contents = fs.readFileSync(filename).toString()
|
||||
|
||||
core.debug(`writing contents to new path ${shallowPath}`)
|
||||
fs.writeFileSync(shallowPath, contents)
|
||||
|
||||
return shallowName
|
||||
})
|
||||
|
||||
let result = kubectlCmd
|
||||
if (filenames.length != relativeShallowNames.length) {
|
||||
throw Error(
|
||||
'replacing filenames with relative path from temp dir, ' +
|
||||
filenames.length +
|
||||
' filenames != ' +
|
||||
relativeShallowNames.length +
|
||||
'basenames'
|
||||
)
|
||||
}
|
||||
for (let index = 0; index < filenames.length; index++) {
|
||||
result = result.replace(filenames[index], relativeShallowNames[index])
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
export function extractFileNames(strToParse: string) {
|
||||
const fileNames: string[] = []
|
||||
const argv = minimist(strToParse.split(' '))
|
||||
const fArg = 'f'
|
||||
const filenameArg = 'filename'
|
||||
|
||||
fileNames.push(...extractFilesFromMinimist(argv, fArg))
|
||||
fileNames.push(...extractFilesFromMinimist(argv, filenameArg))
|
||||
|
||||
return fileNames
|
||||
}
|
||||
|
||||
export function extractFilesFromMinimist(argv, arg: string): string[] {
|
||||
if (!argv[arg]) {
|
||||
return []
|
||||
}
|
||||
const toReturn: string[] = []
|
||||
if (typeof argv[arg] === 'string') {
|
||||
toReturn.push(...argv[arg].split(','))
|
||||
} else {
|
||||
for (const value of argv[arg] as string[]) {
|
||||
toReturn.push(...value.split(','))
|
||||
}
|
||||
}
|
||||
|
||||
return toReturn
|
||||
}
|
||||
@@ -1,22 +1,22 @@
|
||||
import {parseRouteStrategy, RouteStrategy} from './routeStrategy'
|
||||
import { parseRouteStrategy, RouteStrategy } from "./routeStrategy";
|
||||
|
||||
describe('Route strategy type', () => {
|
||||
test('it has required values', () => {
|
||||
const vals = <any>Object.values(RouteStrategy)
|
||||
expect(vals.includes('ingress')).toBe(true)
|
||||
expect(vals.includes('smi')).toBe(true)
|
||||
expect(vals.includes('service')).toBe(true)
|
||||
})
|
||||
describe("Route strategy type", () => {
|
||||
test("it has required values", () => {
|
||||
const vals = <any>Object.values(RouteStrategy);
|
||||
expect(vals.includes("ingress")).toBe(true);
|
||||
expect(vals.includes("smi")).toBe(true);
|
||||
expect(vals.includes("service")).toBe(true);
|
||||
});
|
||||
|
||||
test('it can parse valid values from a string', () => {
|
||||
expect(parseRouteStrategy('ingress')).toBe(RouteStrategy.INGRESS)
|
||||
expect(parseRouteStrategy('Ingress')).toBe(RouteStrategy.INGRESS)
|
||||
expect(parseRouteStrategy('ingresS')).toBe(RouteStrategy.INGRESS)
|
||||
expect(parseRouteStrategy('INGRESS')).toBe(RouteStrategy.INGRESS)
|
||||
})
|
||||
test("it can parse valid values from a string", () => {
|
||||
expect(parseRouteStrategy("ingress")).toBe(RouteStrategy.INGRESS);
|
||||
expect(parseRouteStrategy("Ingress")).toBe(RouteStrategy.INGRESS);
|
||||
expect(parseRouteStrategy("ingresS")).toBe(RouteStrategy.INGRESS);
|
||||
expect(parseRouteStrategy("INGRESS")).toBe(RouteStrategy.INGRESS);
|
||||
});
|
||||
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseRouteStrategy('invalid')).toBe(undefined)
|
||||
expect(parseRouteStrategy('unsupportedType')).toBe(undefined)
|
||||
})
|
||||
})
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseRouteStrategy("invalid")).toBe(undefined);
|
||||
expect(parseRouteStrategy("unsupportedType")).toBe(undefined);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
export enum RouteStrategy {
|
||||
INGRESS = 'ingress',
|
||||
SMI = 'smi',
|
||||
SERVICE = 'service'
|
||||
INGRESS = "ingress",
|
||||
SMI = "smi",
|
||||
SERVICE = "service",
|
||||
}
|
||||
|
||||
export const parseRouteStrategy = (str: string): RouteStrategy | undefined =>
|
||||
RouteStrategy[
|
||||
Object.keys(RouteStrategy).filter(
|
||||
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof RouteStrategy
|
||||
]
|
||||
RouteStrategy[
|
||||
Object.keys(RouteStrategy).filter(
|
||||
(k) => RouteStrategy[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof RouteStrategy
|
||||
];
|
||||
|
||||
@@ -1,21 +1,24 @@
|
||||
import {parseTrafficSplitMethod, TrafficSplitMethod} from './trafficSplitMethod'
|
||||
import {
|
||||
parseTrafficSplitMethod,
|
||||
TrafficSplitMethod,
|
||||
} from "./trafficSplitMethod";
|
||||
|
||||
describe('Traffic split method type', () => {
|
||||
test('it has required values', () => {
|
||||
const vals = <any>Object.values(TrafficSplitMethod)
|
||||
expect(vals.includes('pod')).toBe(true)
|
||||
expect(vals.includes('smi')).toBe(true)
|
||||
})
|
||||
describe("Traffic split method type", () => {
|
||||
test("it has required values", () => {
|
||||
const vals = <any>Object.values(TrafficSplitMethod);
|
||||
expect(vals.includes("pod")).toBe(true);
|
||||
expect(vals.includes("smi")).toBe(true);
|
||||
});
|
||||
|
||||
test('it can parse valid values from a string', () => {
|
||||
expect(parseTrafficSplitMethod('pod')).toBe(TrafficSplitMethod.POD)
|
||||
expect(parseTrafficSplitMethod('Pod')).toBe(TrafficSplitMethod.POD)
|
||||
expect(parseTrafficSplitMethod('poD')).toBe(TrafficSplitMethod.POD)
|
||||
expect(parseTrafficSplitMethod('POD')).toBe(TrafficSplitMethod.POD)
|
||||
})
|
||||
test("it can parse valid values from a string", () => {
|
||||
expect(parseTrafficSplitMethod("pod")).toBe(TrafficSplitMethod.POD);
|
||||
expect(parseTrafficSplitMethod("Pod")).toBe(TrafficSplitMethod.POD);
|
||||
expect(parseTrafficSplitMethod("poD")).toBe(TrafficSplitMethod.POD);
|
||||
expect(parseTrafficSplitMethod("POD")).toBe(TrafficSplitMethod.POD);
|
||||
});
|
||||
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseTrafficSplitMethod('invalid')).toBe(undefined)
|
||||
expect(parseTrafficSplitMethod('unsupportedType')).toBe(undefined)
|
||||
})
|
||||
})
|
||||
test("it will return undefined if it can't parse values from a string", () => {
|
||||
expect(parseTrafficSplitMethod("invalid")).toBe(undefined);
|
||||
expect(parseTrafficSplitMethod("unsupportedType")).toBe(undefined);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
export enum TrafficSplitMethod {
|
||||
POD = 'pod',
|
||||
SMI = 'smi'
|
||||
POD = "pod",
|
||||
SMI = "smi",
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -9,11 +9,11 @@ export enum TrafficSplitMethod {
|
||||
* @returns The TrafficSplitMethod enum or undefined if it can't be parsed
|
||||
*/
|
||||
export const parseTrafficSplitMethod = (
|
||||
str: string
|
||||
str: string
|
||||
): TrafficSplitMethod | undefined =>
|
||||
TrafficSplitMethod[
|
||||
Object.keys(TrafficSplitMethod).filter(
|
||||
(k) =>
|
||||
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof TrafficSplitMethod
|
||||
]
|
||||
TrafficSplitMethod[
|
||||
Object.keys(TrafficSplitMethod).filter(
|
||||
(k) =>
|
||||
TrafficSplitMethod[k].toString().toLowerCase() === str.toLowerCase()
|
||||
)[0] as keyof typeof TrafficSplitMethod
|
||||
];
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
import {createInlineArray} from './arrayUtils'
|
||||
import { createInlineArray } from "./arrayUtils";
|
||||
|
||||
describe('array utilities', () => {
|
||||
it('creates an inline array', () => {
|
||||
const strings = ['str1', 'str2', 'str3']
|
||||
expect(createInlineArray(strings)).toBe(strings.join(','))
|
||||
describe("array utilities", () => {
|
||||
it("creates an inline array", () => {
|
||||
const strings = ["str1", "str2", "str3"];
|
||||
expect(createInlineArray(strings)).toBe(strings.join(","));
|
||||
|
||||
const string = 'str1'
|
||||
expect(createInlineArray([string])).toBe(string)
|
||||
expect(createInlineArray(string)).toBe(string)
|
||||
})
|
||||
})
|
||||
const string = "str1";
|
||||
expect(createInlineArray([string])).toBe(string);
|
||||
expect(createInlineArray(string)).toBe(string);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
export function createInlineArray(str: string | string[]): string {
|
||||
if (typeof str === 'string') {
|
||||
return str
|
||||
}
|
||||
return str.join(',')
|
||||
}
|
||||
export function createInlineArray(str: string | string[]): string {
|
||||
if (typeof str === "string") {
|
||||
return str;
|
||||
}
|
||||
return str.join(",");
|
||||
}
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
import * as io from '@actions/io'
|
||||
import {checkDockerPath} from './dockerUtils'
|
||||
import * as io from "@actions/io";
|
||||
import { checkDockerPath } from "./dockerUtils";
|
||||
|
||||
describe('docker utilities', () => {
|
||||
it('checks if docker is installed', async () => {
|
||||
// docker installed
|
||||
const path = 'path'
|
||||
jest.spyOn(io, 'which').mockImplementationOnce(async () => path)
|
||||
expect(() => checkDockerPath()).not.toThrow()
|
||||
describe("docker utilities", () => {
|
||||
it("checks if docker is installed", async () => {
|
||||
// docker installed
|
||||
const path = "path";
|
||||
jest.spyOn(io, "which").mockImplementationOnce(async () => path);
|
||||
expect(() => checkDockerPath()).not.toThrow();
|
||||
|
||||
// docker not installed
|
||||
jest.spyOn(io, 'which').mockImplementationOnce(async () => undefined)
|
||||
await expect(() => checkDockerPath()).rejects.toThrow()
|
||||
})
|
||||
})
|
||||
// docker not installed
|
||||
jest.spyOn(io, "which").mockImplementationOnce(async () => undefined);
|
||||
await expect(() => checkDockerPath()).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,79 +1,75 @@
|
||||
import * as io from '@actions/io'
|
||||
import {DeploymentConfig} from '../types/deploymentConfig'
|
||||
import * as core from '@actions/core'
|
||||
import {DockerExec} from '../types/docker'
|
||||
import {getNormalizedPath} from './githubUtils'
|
||||
import * as io from "@actions/io";
|
||||
import { DeploymentConfig } from "../types/deploymentConfig";
|
||||
import * as core from "@actions/core";
|
||||
import { DockerExec } from "../types/docker";
|
||||
import { getNormalizedPath } from "./githubUtils";
|
||||
|
||||
export async function getDeploymentConfig(): Promise<DeploymentConfig> {
|
||||
let helmChartPaths: string[] =
|
||||
process.env?.HELM_CHART_PATHS?.split(';').filter((path) => path != '') ||
|
||||
[]
|
||||
helmChartPaths = helmChartPaths.map((helmchart) =>
|
||||
getNormalizedPath(helmchart.trim())
|
||||
)
|
||||
let helmChartPaths: string[] =
|
||||
process.env?.HELM_CHART_PATHS?.split(";").filter((path) => path != "") ||
|
||||
[];
|
||||
helmChartPaths = helmChartPaths.map((helmchart) =>
|
||||
getNormalizedPath(helmchart.trim())
|
||||
);
|
||||
|
||||
let inputManifestFiles: string[] =
|
||||
core
|
||||
.getInput('manifests')
|
||||
.split(/[\n,;]+/)
|
||||
.filter((manifest) => manifest.trim().length > 0) || []
|
||||
if (helmChartPaths?.length == 0) {
|
||||
inputManifestFiles = inputManifestFiles.map((manifestFile) =>
|
||||
getNormalizedPath(manifestFile)
|
||||
)
|
||||
}
|
||||
let inputManifestFiles: string[] =
|
||||
core
|
||||
.getInput("manifests")
|
||||
.split(/[\n,;]+/)
|
||||
.filter((manifest) => manifest.trim().length > 0) || [];
|
||||
if (helmChartPaths?.length == 0) {
|
||||
inputManifestFiles = inputManifestFiles.map((manifestFile) =>
|
||||
getNormalizedPath(manifestFile)
|
||||
);
|
||||
}
|
||||
|
||||
const imageNames =
|
||||
core
|
||||
.getInput('images')
|
||||
.split('\n')
|
||||
.filter((image) => image.length > 0) || []
|
||||
const imageDockerfilePathMap: {[id: string]: string} = {}
|
||||
const imageNames = core.getInput("images").split("\n") || [];
|
||||
const imageDockerfilePathMap: { [id: string]: string } = {};
|
||||
|
||||
const pullImages = !(core.getInput('pull-images').toLowerCase() === 'false')
|
||||
if (pullImages) {
|
||||
//Fetching from image label if available
|
||||
for (const image of imageNames) {
|
||||
try {
|
||||
imageDockerfilePathMap[image] = await getDockerfilePath(image)
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Failed to get dockerfile path for image ${image.toString()}: ${ex} `
|
||||
)
|
||||
}
|
||||
const pullImages = !(core.getInput("pull-images").toLowerCase() === "false");
|
||||
if (pullImages) {
|
||||
//Fetching from image label if available
|
||||
for (const image of imageNames) {
|
||||
try {
|
||||
imageDockerfilePathMap[image] = await getDockerfilePath(image);
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Failed to get dockerfile path for image ${image.toString()}: ${ex} `
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return Promise.resolve(<DeploymentConfig>{
|
||||
manifestFilePaths: inputManifestFiles,
|
||||
helmChartFilePaths: helmChartPaths,
|
||||
dockerfilePaths: imageDockerfilePathMap
|
||||
})
|
||||
return Promise.resolve(<DeploymentConfig>{
|
||||
manifestFilePaths: inputManifestFiles,
|
||||
helmChartFilePaths: helmChartPaths,
|
||||
dockerfilePaths: imageDockerfilePathMap,
|
||||
});
|
||||
}
|
||||
|
||||
async function getDockerfilePath(image: any): Promise<string> {
|
||||
await checkDockerPath()
|
||||
const dockerExec: DockerExec = new DockerExec('docker')
|
||||
await dockerExec.pull(image, [], false)
|
||||
await checkDockerPath();
|
||||
const dockerExec: DockerExec = new DockerExec("docker");
|
||||
await dockerExec.pull(image, [], false);
|
||||
|
||||
const imageInspectResult: string = await dockerExec.inspect(image, [], false)
|
||||
const imageConfig = JSON.parse(imageInspectResult)[0]
|
||||
const DOCKERFILE_PATH_LABEL_KEY = 'dockerfile-path'
|
||||
const imageInspectResult: string = await dockerExec.inspect(image, [], false);
|
||||
const imageConfig = JSON.parse(imageInspectResult)[0];
|
||||
const DOCKERFILE_PATH_LABEL_KEY = "dockerfile-path";
|
||||
|
||||
let pathValue: string = ''
|
||||
if (
|
||||
imageConfig?.Config?.Labels &&
|
||||
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
|
||||
) {
|
||||
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY]
|
||||
pathValue = getNormalizedPath(pathLabel)
|
||||
}
|
||||
return Promise.resolve(pathValue)
|
||||
let pathValue: string = "";
|
||||
if (
|
||||
imageConfig?.Config?.Labels &&
|
||||
imageConfig?.Config?.Labels[DOCKERFILE_PATH_LABEL_KEY]
|
||||
) {
|
||||
const pathLabel = imageConfig.Config.Labels[DOCKERFILE_PATH_LABEL_KEY];
|
||||
pathValue = getNormalizedPath(pathLabel);
|
||||
}
|
||||
return Promise.resolve(pathValue);
|
||||
}
|
||||
|
||||
export async function checkDockerPath() {
|
||||
const dockerPath = await io.which('docker', false)
|
||||
if (!dockerPath) {
|
||||
throw new Error('Docker is not installed.')
|
||||
}
|
||||
const dockerPath = await io.which("docker", false);
|
||||
if (!dockerPath) {
|
||||
throw new Error("Docker is not installed.");
|
||||
}
|
||||
}
|
||||
|
||||
+39
-112
@@ -1,122 +1,49 @@
|
||||
import * as fileUtils from './fileUtils'
|
||||
import {
|
||||
getFilesFromDirectories
|
||||
} from "./fileUtils";
|
||||
|
||||
import * as path from "path";
|
||||
|
||||
import * as yaml from 'js-yaml'
|
||||
import fs from 'node:fs'
|
||||
import * as path from 'path'
|
||||
import {K8sObject} from '../types/k8sObject'
|
||||
describe("File utils", () => {
|
||||
it("detects files in nested directories and ignores non-manifest files and empty dirs", () => {
|
||||
const testPath = path.join("test", "unit", "manifests")
|
||||
const testSearch: string[] = getFilesFromDirectories([testPath])
|
||||
|
||||
const sampleYamlUrl =
|
||||
'https://raw.githubusercontent.com/kubernetes/website/main/content/en/examples/controllers/nginx-deployment.yaml'
|
||||
describe('File utils', () => {
|
||||
test('correctly parses a yaml file from a URL', async () => {
|
||||
const tempFile = await fileUtils.writeYamlFromURLToFile(sampleYamlUrl, 0)
|
||||
const fileContents = fs.readFileSync(tempFile).toString()
|
||||
const inputObjects: K8sObject[] = yaml.loadAll(
|
||||
fileContents
|
||||
) as K8sObject[]
|
||||
expect(inputObjects).toHaveLength(1)
|
||||
|
||||
for (const obj of inputObjects) {
|
||||
expect(obj.metadata.name).toBe('nginx-deployment')
|
||||
expect(obj.kind).toBe('Deployment')
|
||||
}
|
||||
})
|
||||
|
||||
it('fails when a bad URL is given among other files', async () => {
|
||||
const badUrl = 'https://www.github.com'
|
||||
|
||||
const testPath = path.join('test', 'unit', 'manifests')
|
||||
await expect(
|
||||
fileUtils.getFilesFromDirectoriesAndURLs([testPath, badUrl])
|
||||
).rejects.toThrow()
|
||||
})
|
||||
|
||||
it('detects files in nested directories with the same name and ignores non-manifest files and empty dirs', async () => {
|
||||
const testPath = path.join('test', 'unit', 'manifests')
|
||||
const testSearch: string[] =
|
||||
await fileUtils.getFilesFromDirectoriesAndURLs([
|
||||
testPath,
|
||||
sampleYamlUrl
|
||||
])
|
||||
|
||||
const expectedManifests = [
|
||||
'test/unit/manifests/manifest_test_dir/another_layer/test-ingress.yaml',
|
||||
'test/unit/manifests/manifest_test_dir/another_layer/nested-test-service.yaml',
|
||||
'test/unit/manifests/manifest_test_dir/nested-test-service.yaml',
|
||||
'test/unit/manifests/test-ingress.yml',
|
||||
'test/unit/manifests/test-ingress-new.yml',
|
||||
'test/unit/manifests/test-service.yml'
|
||||
]
|
||||
|
||||
expect(testSearch).toHaveLength(8)
|
||||
const expectedManifests =
|
||||
[
|
||||
"test/unit/manifests/manifest_test_dir/another_layer/deep-ingress.yaml",
|
||||
"test/unit/manifests/manifest_test_dir/another_layer/deep-service.yaml",
|
||||
"test/unit/manifests/manifest_test_dir/nested-test-service.yaml",
|
||||
"test/unit/manifests/test-ingress.yml",
|
||||
"test/unit/manifests/test-service.yml"
|
||||
]
|
||||
|
||||
|
||||
// is there a more efficient way to test equality w random order?
|
||||
expect(testSearch).toHaveLength(5);
|
||||
expectedManifests.forEach((fileName) => {
|
||||
if (fileName.startsWith('test/unit')) {
|
||||
expect(testSearch).toContain(fileName)
|
||||
} else {
|
||||
expect(fileName.includes(fileUtils.urlFileKind)).toBe(true)
|
||||
expect(fileName.startsWith(fileUtils.getTempDirectory()))
|
||||
}
|
||||
expect(testSearch).toContain(fileName)
|
||||
})
|
||||
})
|
||||
|
||||
it('crashes when an invalid file is provided', async () => {
|
||||
const badPath = path.join('test', 'unit', 'manifests', 'nonexistent.yaml')
|
||||
const goodPath = path.join(
|
||||
'test',
|
||||
'unit',
|
||||
'manifests',
|
||||
'manifest_test_dir'
|
||||
)
|
||||
});
|
||||
|
||||
expect(
|
||||
fileUtils.getFilesFromDirectoriesAndURLs([badPath, goodPath])
|
||||
).rejects.toThrowError()
|
||||
})
|
||||
it("crashes when an invalid file is provided", () => {
|
||||
const badPath = path.join("test", "unit", "manifests", "nonexistent.yaml")
|
||||
const goodPath = path.join("test", "unit", "manifests", "manifest_test_dir")
|
||||
|
||||
it("doesn't duplicate files when nested dir included", async () => {
|
||||
const outerPath = path.join('test', 'unit', 'manifests')
|
||||
const fileAtOuter = path.join(
|
||||
'test',
|
||||
'unit',
|
||||
'manifests',
|
||||
'test-service.yml'
|
||||
)
|
||||
const innerPath = path.join(
|
||||
'test',
|
||||
'unit',
|
||||
'manifests',
|
||||
'manifest_test_dir'
|
||||
)
|
||||
expect(() => {getFilesFromDirectories([badPath, goodPath])}).toThrowError()
|
||||
});
|
||||
|
||||
expect(
|
||||
await fileUtils.getFilesFromDirectoriesAndURLs([
|
||||
outerPath,
|
||||
fileAtOuter,
|
||||
innerPath
|
||||
])
|
||||
).toHaveLength(7)
|
||||
})
|
||||
it("doesn't duplicate files when nested dir included", () => {
|
||||
const outerPath = path.join("test", "unit", "manifests")
|
||||
const fileAtOuter = path.join("test", "unit", "manifests", "test-service.yml")
|
||||
const innerPath = path.join("test", "unit", "manifests", "manifest_test_dir")
|
||||
|
||||
it('throws an error for an invalid URL', async () => {
|
||||
const badUrl = 'https://www.github.com'
|
||||
await expect(
|
||||
fileUtils.writeYamlFromURLToFile(badUrl, 0)
|
||||
).rejects.toBeTruthy()
|
||||
})
|
||||
})
|
||||
expect(getFilesFromDirectories([outerPath, fileAtOuter, innerPath])).toHaveLength(5)
|
||||
})
|
||||
});
|
||||
|
||||
describe('moving files to temp', () => {
|
||||
it('correctly moves the contents of a file to the temporary directory', () => {
|
||||
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
|
||||
return 'test contents'
|
||||
})
|
||||
const originalFilePath = path.join('path', 'in', 'repo')
|
||||
|
||||
const output = fileUtils.moveFileToTmpDir(originalFilePath)
|
||||
|
||||
expect(output).toEqual(
|
||||
path.join(fileUtils.getTempDirectory(), '/path/in/repo')
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
// 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
-235
@@ -1,235 +1,109 @@
|
||||
import fs from 'node:fs'
|
||||
import * as https from 'https'
|
||||
import * as path from 'path'
|
||||
import * as core from '@actions/core'
|
||||
import * as os from 'os'
|
||||
import * as yaml from 'js-yaml'
|
||||
import {Errorable, succeeded, failed, Failed} from '../types/errorable'
|
||||
import {getCurrentTime} from './timeUtils'
|
||||
import {isHttpUrl} from './githubUtils'
|
||||
import {K8sObject} from '../types/k8sObject'
|
||||
|
||||
export const urlFileKind = 'urlfile'
|
||||
|
||||
export function getTempDirectory(): string {
|
||||
return process.env['runner.tempDirectory'] || os.tmpdir()
|
||||
}
|
||||
|
||||
export function writeObjectsToFile(inputObjects: any[]): string[] {
|
||||
const newFilePaths = []
|
||||
|
||||
inputObjects.forEach((inputObject: any) => {
|
||||
try {
|
||||
const inputObjectString = JSON.stringify(inputObject)
|
||||
|
||||
if (inputObject?.metadata?.name) {
|
||||
const fileName = getNewTempManifestFileName(
|
||||
inputObject.kind,
|
||||
inputObject.metadata.name
|
||||
)
|
||||
fs.writeFileSync(path.join(fileName), inputObjectString)
|
||||
newFilePaths.push(fileName)
|
||||
} else {
|
||||
core.debug(
|
||||
'Input object is not proper K8s resource object. Object: ' +
|
||||
inputObjectString
|
||||
)
|
||||
}
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while writing object to file ${inputObject}: ${ex}`
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
return newFilePaths
|
||||
}
|
||||
|
||||
export function writeManifestToFile(
|
||||
inputObjectString: string,
|
||||
kind: string,
|
||||
name: string
|
||||
): string {
|
||||
if (inputObjectString) {
|
||||
try {
|
||||
const fileName = getNewTempManifestFileName(kind, name)
|
||||
fs.writeFileSync(path.join(fileName), inputObjectString)
|
||||
return fileName
|
||||
} catch (ex) {
|
||||
throw Error(
|
||||
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function moveFileToTmpDir(originalFilepath: string) {
|
||||
const tempDirectory = getTempDirectory()
|
||||
const newPath = path.join(tempDirectory, originalFilepath)
|
||||
|
||||
core.debug(`reading original contents from path: ${originalFilepath}`)
|
||||
const contents = fs.readFileSync(originalFilepath).toString()
|
||||
|
||||
const dirName = path.dirname(newPath)
|
||||
if (!fs.existsSync(dirName)) {
|
||||
core.debug(`path ${dirName} doesn't exist yet, making new dir...`)
|
||||
fs.mkdirSync(dirName, {recursive: true})
|
||||
}
|
||||
core.debug(`writing contents to new path ${newPath}`)
|
||||
fs.writeFileSync(path.join(newPath), contents)
|
||||
|
||||
core.debug(`moved contents from ${originalFilepath} to ${newPath}`)
|
||||
|
||||
return newPath
|
||||
}
|
||||
|
||||
function getNewTempManifestFileName(kind: string, name: string) {
|
||||
const filePath = `${kind}_${name}_${getCurrentTime().toString()}`
|
||||
const tempDirectory = getTempDirectory()
|
||||
return path.join(tempDirectory, path.basename(filePath))
|
||||
}
|
||||
|
||||
export async function getFilesFromDirectoriesAndURLs(
|
||||
filePaths: string[]
|
||||
): Promise<string[]> {
|
||||
const fullPathSet: Set<string> = new Set<string>()
|
||||
|
||||
let fileCounter = 0
|
||||
for (const fileName of filePaths) {
|
||||
try {
|
||||
if (isHttpUrl(fileName)) {
|
||||
try {
|
||||
const tempFilePath: string = await writeYamlFromURLToFile(
|
||||
fileName,
|
||||
fileCounter++
|
||||
)
|
||||
fullPathSet.add(tempFilePath)
|
||||
} catch (e) {
|
||||
throw Error(
|
||||
`encountered error trying to pull YAML from URL ${fileName}: ${e}`
|
||||
)
|
||||
}
|
||||
} else if (fs.lstatSync(fileName).isDirectory()) {
|
||||
recurisveManifestGetter(fileName).forEach((file) => {
|
||||
fullPathSet.add(file)
|
||||
})
|
||||
} else if (
|
||||
getFileExtension(fileName) === 'yml' ||
|
||||
getFileExtension(fileName) === 'yaml'
|
||||
) {
|
||||
fullPathSet.add(fileName)
|
||||
} else {
|
||||
core.debug(
|
||||
`Detected non-manifest file, ${fileName}, continuing... `
|
||||
)
|
||||
}
|
||||
} catch (ex) {
|
||||
throw Error(
|
||||
`Exception occurred while reading the file ${fileName}: ${ex}`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
const arr = Array.from(fullPathSet)
|
||||
return arr
|
||||
}
|
||||
|
||||
export async function writeYamlFromURLToFile(
|
||||
url: string,
|
||||
fileNumber: number
|
||||
): Promise<string> {
|
||||
return new Promise((resolve, reject) => {
|
||||
https
|
||||
.get(url, async (response) => {
|
||||
const code = response.statusCode ?? 0
|
||||
if (code >= 400) {
|
||||
reject(
|
||||
Error(
|
||||
`received response status ${response.statusMessage} from url ${url}`
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
const targetPath = getNewTempManifestFileName(
|
||||
urlFileKind,
|
||||
fileNumber.toString()
|
||||
)
|
||||
// save the file to disk
|
||||
const fileWriter = fs
|
||||
.createWriteStream(targetPath)
|
||||
.on('finish', () => {
|
||||
const verification = verifyYaml(targetPath, url)
|
||||
if (succeeded(verification)) {
|
||||
core.debug(
|
||||
`outputting YAML contents from ${url} to ${targetPath}: ${JSON.stringify(
|
||||
verification.result
|
||||
)}`
|
||||
)
|
||||
resolve(targetPath)
|
||||
} else {
|
||||
reject(verification.error)
|
||||
}
|
||||
})
|
||||
|
||||
response.pipe(fileWriter)
|
||||
})
|
||||
.on('error', (error) => {
|
||||
reject(error)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
function verifyYaml(filepath: string, url: string): Errorable<K8sObject[]> {
|
||||
const fileContents = fs.readFileSync(filepath).toString()
|
||||
let inputObjects
|
||||
try {
|
||||
inputObjects = yaml.loadAll(fileContents)
|
||||
} catch (e) {
|
||||
return {
|
||||
succeeded: false,
|
||||
error: `failed to parse manifest from url ${url}: ${e}`
|
||||
}
|
||||
}
|
||||
|
||||
if (!inputObjects || inputObjects.length == 0) {
|
||||
return {
|
||||
succeeded: false,
|
||||
error: `failed to parse manifest from url ${url}: no objects detected in manifest`
|
||||
}
|
||||
}
|
||||
|
||||
for (const obj of inputObjects) {
|
||||
if (!obj.kind || !obj.apiVersion || !obj.metadata) {
|
||||
return {
|
||||
succeeded: false,
|
||||
error: `failed to parse manifest from ${url}: missing fields`
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return {succeeded: true, result: inputObjects}
|
||||
}
|
||||
|
||||
function recurisveManifestGetter(dirName: string): string[] {
|
||||
const toRet: string[] = []
|
||||
|
||||
fs.readdirSync(dirName).forEach((fileName) => {
|
||||
const fnwd: string = path.join(dirName, fileName)
|
||||
if (fs.lstatSync(fnwd).isDirectory()) {
|
||||
toRet.push(...recurisveManifestGetter(fnwd))
|
||||
} else if (
|
||||
getFileExtension(fileName) === 'yml' ||
|
||||
getFileExtension(fileName) === 'yaml'
|
||||
) {
|
||||
toRet.push(path.join(dirName, fileName))
|
||||
} else {
|
||||
core.debug(`Detected non-manifest file, ${fileName}, continuing... `)
|
||||
}
|
||||
})
|
||||
|
||||
return toRet
|
||||
}
|
||||
|
||||
function getFileExtension(fileName: string) {
|
||||
return fileName.slice(((fileName.lastIndexOf('.') - 1) >>> 0) + 2)
|
||||
}
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import * as core from "@actions/core";
|
||||
import * as os from "os";
|
||||
import { getCurrentTime } from "./timeUtils";
|
||||
|
||||
export function getTempDirectory(): string {
|
||||
return process.env["runner.tempDirectory"] || os.tmpdir();
|
||||
}
|
||||
|
||||
export function writeObjectsToFile(inputObjects: any[]): string[] {
|
||||
const newFilePaths = [];
|
||||
|
||||
inputObjects.forEach((inputObject: any) => {
|
||||
try {
|
||||
const inputObjectString = JSON.stringify(inputObject);
|
||||
|
||||
if (inputObject?.metadata?.name) {
|
||||
const fileName = getManifestFileName(
|
||||
inputObject.kind,
|
||||
inputObject.metadata.name
|
||||
);
|
||||
fs.writeFileSync(path.join(fileName), inputObjectString);
|
||||
newFilePaths.push(fileName);
|
||||
} else {
|
||||
core.debug(
|
||||
"Input object is not proper K8s resource object. Object: " +
|
||||
inputObjectString
|
||||
);
|
||||
}
|
||||
} catch (ex) {
|
||||
core.debug(
|
||||
`Exception occurred while writing object to file ${inputObject}: ${ex}`
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
return newFilePaths;
|
||||
}
|
||||
|
||||
export function writeManifestToFile(
|
||||
inputObjectString: string,
|
||||
kind: string,
|
||||
name: string
|
||||
): string {
|
||||
if (inputObjectString) {
|
||||
try {
|
||||
const fileName = getManifestFileName(kind, name);
|
||||
fs.writeFileSync(path.join(fileName), inputObjectString);
|
||||
return fileName;
|
||||
} catch (ex) {
|
||||
throw Error(
|
||||
`Exception occurred while writing object to file: ${inputObjectString}. Exception: ${ex}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function getManifestFileName(kind: string, name: string) {
|
||||
const filePath = `${kind}_${name}_ ${getCurrentTime().toString()}`;
|
||||
const tempDirectory = getTempDirectory();
|
||||
return path.join(tempDirectory, path.basename(filePath));
|
||||
}
|
||||
|
||||
export function getFilesFromDirectories(
|
||||
filePaths: string[]
|
||||
): string[]{
|
||||
|
||||
const fullPathSet: Set<string> = new Set<string>()
|
||||
|
||||
filePaths.forEach((fileName => {
|
||||
try {
|
||||
if(fs.lstatSync(fileName).isDirectory()){
|
||||
recurisveManifestGetter(fileName).forEach((file) => {fullPathSet.add(file)})
|
||||
} else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
|
||||
fullPathSet.add(fileName)
|
||||
} else{
|
||||
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
|
||||
}
|
||||
} catch (ex) {
|
||||
throw Error(
|
||||
`Exception occurred while reading the file ${fileName}: ${ex}`
|
||||
);
|
||||
}
|
||||
}))
|
||||
|
||||
return Array.from(fullPathSet)
|
||||
}
|
||||
|
||||
function recurisveManifestGetter(dirName: string): string[]{
|
||||
const toRet: string[] = []
|
||||
|
||||
fs.readdirSync(dirName).forEach((fileName) => {
|
||||
const fnwd: string = path.join(dirName, fileName)
|
||||
if(fs.lstatSync(fnwd).isDirectory()){
|
||||
toRet.push(...recurisveManifestGetter(fnwd))
|
||||
} else if(getFileExtension(fileName) === "yml" || getFileExtension(fileName) === "yaml"){
|
||||
toRet.push(path.join(dirName, fileName))
|
||||
} else{
|
||||
core.debug(`Detected non-manifest file, ${fileName}, continuing... ` )
|
||||
}
|
||||
})
|
||||
|
||||
return toRet
|
||||
}
|
||||
|
||||
function getFileExtension(fileName: string){
|
||||
return fileName.slice((fileName.lastIndexOf(".") - 1 >>> 0) + 2)
|
||||
}
|
||||
@@ -1,48 +1,48 @@
|
||||
import {
|
||||
getNormalizedPath,
|
||||
isHttpUrl,
|
||||
normalizeWorkflowStrLabel
|
||||
} from './githubUtils'
|
||||
getNormalizedPath,
|
||||
isHttpUrl,
|
||||
normalizeWorkflowStrLabel,
|
||||
} from "./githubUtils";
|
||||
|
||||
describe('Github utils', () => {
|
||||
it('normalizes workflow string labels', () => {
|
||||
const workflowsPath = '.github/workflows/'
|
||||
describe("Github utils", () => {
|
||||
it("normalizes workflow string labels", () => {
|
||||
const workflowsPath = ".github/workflows/";
|
||||
|
||||
const path = 'test/path/test'
|
||||
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path)
|
||||
expect(normalizeWorkflowStrLabel(path)).toBe(path)
|
||||
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
|
||||
path + workflowsPath
|
||||
)
|
||||
expect(normalizeWorkflowStrLabel(path + ' ' + path)).toBe(
|
||||
path + '_' + path
|
||||
)
|
||||
})
|
||||
const path = "test/path/test";
|
||||
expect(normalizeWorkflowStrLabel(workflowsPath + path)).toBe(path);
|
||||
expect(normalizeWorkflowStrLabel(path)).toBe(path);
|
||||
expect(normalizeWorkflowStrLabel(path + workflowsPath)).toBe(
|
||||
path + workflowsPath
|
||||
);
|
||||
expect(normalizeWorkflowStrLabel(path + " " + path)).toBe(
|
||||
path + "_" + path
|
||||
);
|
||||
});
|
||||
|
||||
it('normalizes path', () => {
|
||||
const httpUrl = 'http://www.test.com'
|
||||
expect(getNormalizedPath(httpUrl)).toBe(httpUrl)
|
||||
it("normalizes path", () => {
|
||||
const httpUrl = "http://www.test.com";
|
||||
expect(getNormalizedPath(httpUrl)).toBe(httpUrl);
|
||||
|
||||
const httpsUrl = 'https://www.test.com'
|
||||
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl)
|
||||
const httpsUrl = "https://www.test.com";
|
||||
expect(getNormalizedPath(httpsUrl)).toBe(httpsUrl);
|
||||
|
||||
const repo = 'gh_repo'
|
||||
const sha = 'gh_sha'
|
||||
const path = 'path'
|
||||
process.env.GITHUB_REPOSITORY = repo
|
||||
process.env.GITHUB_SHA = sha
|
||||
expect(getNormalizedPath(path)).toBe(
|
||||
`https://github.com/${repo}/blob/${sha}/${path}`
|
||||
)
|
||||
})
|
||||
const repo = "gh_repo";
|
||||
const sha = "gh_sha";
|
||||
const path = "path";
|
||||
process.env.GITHUB_REPOSITORY = repo;
|
||||
process.env.GITHUB_SHA = sha;
|
||||
expect(getNormalizedPath(path)).toBe(
|
||||
`https://github.com/${repo}/blob/${sha}/${path}`
|
||||
);
|
||||
});
|
||||
|
||||
it('checks if url is http', () => {
|
||||
expect(isHttpUrl('www.test.com')).toBe(false)
|
||||
expect(isHttpUrl('http.test.com')).toBe(false)
|
||||
expect(isHttpUrl('http:.test.com')).toBe(false)
|
||||
expect(isHttpUrl('http:/.test.com')).toBe(false)
|
||||
it("checks if url is http", () => {
|
||||
expect(isHttpUrl("www.test.com")).toBe(false);
|
||||
expect(isHttpUrl("http.test.com")).toBe(false);
|
||||
expect(isHttpUrl("http:.test.com")).toBe(false);
|
||||
expect(isHttpUrl("http:/.test.com")).toBe(false);
|
||||
|
||||
expect(isHttpUrl('https://www.test.com')).toBe(true)
|
||||
expect(isHttpUrl('http://wwww.test.com')).toBe(true)
|
||||
})
|
||||
})
|
||||
expect(isHttpUrl("https://www.test.com")).toBe(true);
|
||||
expect(isHttpUrl("http://wwww.test.com")).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,54 +1,54 @@
|
||||
import {GitHubClient, OkStatusCode} from '../types/githubClient'
|
||||
import * as core from '@actions/core'
|
||||
import { GitHubClient, OkStatusCode } from "../types/githubClient";
|
||||
import * as core from "@actions/core";
|
||||
|
||||
export async function getWorkflowFilePath(
|
||||
githubToken: string
|
||||
githubToken: string
|
||||
): Promise<string> {
|
||||
let workflowFilePath = process.env.GITHUB_WORKFLOW
|
||||
if (!workflowFilePath.startsWith('.github/workflows/')) {
|
||||
const githubClient = new GitHubClient(
|
||||
process.env.GITHUB_REPOSITORY,
|
||||
githubToken
|
||||
)
|
||||
const response = await githubClient.getWorkflows()
|
||||
if (response) {
|
||||
if (response.status === OkStatusCode && response.data.total_count) {
|
||||
if (response.data.total_count > 0) {
|
||||
for (const workflow of response.data.workflows) {
|
||||
if (process.env.GITHUB_WORKFLOW === workflow.name) {
|
||||
workflowFilePath = workflow.path
|
||||
break
|
||||
}
|
||||
}
|
||||
let workflowFilePath = process.env.GITHUB_WORKFLOW;
|
||||
if (!workflowFilePath.startsWith(".github/workflows/")) {
|
||||
const githubClient = new GitHubClient(
|
||||
process.env.GITHUB_REPOSITORY,
|
||||
githubToken
|
||||
);
|
||||
const response = await githubClient.getWorkflows();
|
||||
if (response) {
|
||||
if (response.status === OkStatusCode && response.data.total_count) {
|
||||
if (response.data.total_count > 0) {
|
||||
for (const workflow of response.data.workflows) {
|
||||
if (process.env.GITHUB_WORKFLOW === workflow.name) {
|
||||
workflowFilePath = workflow.path;
|
||||
break;
|
||||
}
|
||||
} else if (response.status != OkStatusCode) {
|
||||
core.error(
|
||||
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}`
|
||||
)
|
||||
}
|
||||
} else {
|
||||
core.error(`Failed to get response from workflow list API`)
|
||||
}
|
||||
}
|
||||
} else if (response.status != OkStatusCode) {
|
||||
core.error(
|
||||
`An error occurred while getting list of workflows on the repo. Status code: ${response.status}`
|
||||
);
|
||||
}
|
||||
}
|
||||
return Promise.resolve(workflowFilePath)
|
||||
} else {
|
||||
core.error(`Failed to get response from workflow list API`);
|
||||
}
|
||||
}
|
||||
return Promise.resolve(workflowFilePath);
|
||||
}
|
||||
|
||||
export function normalizeWorkflowStrLabel(workflowName: string): string {
|
||||
const workflowsPath = '.github/workflows/'
|
||||
workflowName = workflowName.startsWith(workflowsPath)
|
||||
? workflowName.replace(workflowsPath, '')
|
||||
: workflowName
|
||||
return workflowName.replace(/ /g, '_')
|
||||
const workflowsPath = ".github/workflows/";
|
||||
workflowName = workflowName.startsWith(workflowsPath)
|
||||
? workflowName.replace(workflowsPath, "")
|
||||
: workflowName;
|
||||
return workflowName.replace(/ /g, "_");
|
||||
}
|
||||
|
||||
export function getNormalizedPath(pathValue: string) {
|
||||
if (!isHttpUrl(pathValue)) {
|
||||
//if it is not an http url then convert to link from current repo and commit
|
||||
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`
|
||||
}
|
||||
return pathValue
|
||||
if (!isHttpUrl(pathValue)) {
|
||||
//if it is not an http url then convert to link from current repo and commit
|
||||
return `https://github.com/${process.env.GITHUB_REPOSITORY}/blob/${process.env.GITHUB_SHA}/${pathValue}`;
|
||||
}
|
||||
return pathValue;
|
||||
}
|
||||
|
||||
export function isHttpUrl(url: string) {
|
||||
return /^https?:\/\/.*$/.test(url)
|
||||
return /^https?:\/\/.*$/.test(url);
|
||||
}
|
||||
|
||||
@@ -1,61 +1,61 @@
|
||||
import * as core from '@actions/core'
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
import {checkForErrors} from './kubectlUtils'
|
||||
import * as core from "@actions/core";
|
||||
import { ExecOutput } from "@actions/exec";
|
||||
import { checkForErrors } from "./kubectlUtils";
|
||||
|
||||
describe('Kubectl utils', () => {
|
||||
it('checks for errors', () => {
|
||||
const success: ExecOutput = {stderr: '', stdout: 'success', exitCode: 0}
|
||||
const successWithStderr: ExecOutput = {
|
||||
stderr: 'error',
|
||||
stdout: '',
|
||||
exitCode: 0
|
||||
}
|
||||
const failWithExitCode: ExecOutput = {
|
||||
stderr: '',
|
||||
stdout: '',
|
||||
exitCode: 1
|
||||
}
|
||||
const failWithExitWithStderr: ExecOutput = {
|
||||
stderr: 'error',
|
||||
stdout: '',
|
||||
exitCode: 2
|
||||
}
|
||||
describe("Kubectl utils", () => {
|
||||
it("checks for errors", () => {
|
||||
const success: ExecOutput = { stderr: "", stdout: "success", exitCode: 0 };
|
||||
const successWithStderr: ExecOutput = {
|
||||
stderr: "error",
|
||||
stdout: "",
|
||||
exitCode: 0,
|
||||
};
|
||||
const failWithExitCode: ExecOutput = {
|
||||
stderr: "",
|
||||
stdout: "",
|
||||
exitCode: 1,
|
||||
};
|
||||
const failWithExitWithStderr: ExecOutput = {
|
||||
stderr: "error",
|
||||
stdout: "",
|
||||
exitCode: 2,
|
||||
};
|
||||
|
||||
// with throw behavior
|
||||
expect(() => checkForErrors([success])).not.toThrow()
|
||||
expect(() => checkForErrors([successWithStderr])).not.toThrow()
|
||||
expect(() => checkForErrors([success, successWithStderr])).not.toThrow()
|
||||
expect(() => checkForErrors([failWithExitCode])).toThrow()
|
||||
expect(() => checkForErrors([failWithExitWithStderr])).toThrow()
|
||||
expect(() => checkForErrors([success, failWithExitCode])).toThrow()
|
||||
expect(() =>
|
||||
checkForErrors([successWithStderr, failWithExitCode])
|
||||
).toThrow()
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr, failWithExitCode])
|
||||
).toThrow()
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr, failWithExitWithStderr])
|
||||
).toThrow()
|
||||
// with throw behavior
|
||||
expect(() => checkForErrors([success])).not.toThrow();
|
||||
expect(() => checkForErrors([successWithStderr])).not.toThrow();
|
||||
expect(() => checkForErrors([success, successWithStderr])).not.toThrow();
|
||||
expect(() => checkForErrors([failWithExitCode])).toThrow();
|
||||
expect(() => checkForErrors([failWithExitWithStderr])).toThrow();
|
||||
expect(() => checkForErrors([success, failWithExitCode])).toThrow();
|
||||
expect(() =>
|
||||
checkForErrors([successWithStderr, failWithExitCode])
|
||||
).toThrow();
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr, failWithExitCode])
|
||||
).toThrow();
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr, failWithExitWithStderr])
|
||||
).toThrow();
|
||||
|
||||
// with warn behavior
|
||||
jest.spyOn(core, 'warning').mockImplementation(() => {})
|
||||
let warningCalls = 0
|
||||
expect(() => checkForErrors([success], true)).not.toThrow()
|
||||
expect(core.warning).toBeCalledTimes(warningCalls)
|
||||
// with warn behavior
|
||||
jest.spyOn(core, "warning").mockImplementation(() => {});
|
||||
let warningCalls = 0;
|
||||
expect(() => checkForErrors([success], true)).not.toThrow();
|
||||
expect(core.warning).toBeCalledTimes(warningCalls);
|
||||
|
||||
expect(() => checkForErrors([successWithStderr], true)).not.toThrow()
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls)
|
||||
expect(() => checkForErrors([successWithStderr], true)).not.toThrow();
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls);
|
||||
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr], true)
|
||||
).not.toThrow()
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls)
|
||||
expect(() =>
|
||||
checkForErrors([success, successWithStderr], true)
|
||||
).not.toThrow();
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls);
|
||||
|
||||
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow()
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls)
|
||||
expect(() => checkForErrors([failWithExitCode], true)).not.toThrow();
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls);
|
||||
|
||||
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow()
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls)
|
||||
})
|
||||
})
|
||||
expect(() => checkForErrors([failWithExitWithStderr], true)).not.toThrow();
|
||||
expect(core.warning).toBeCalledTimes(++warningCalls);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,102 +1,82 @@
|
||||
import * as core from '@actions/core'
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
import {Kubectl} from '../types/kubectl'
|
||||
|
||||
const NAMESPACE = 'namespace'
|
||||
import * as core from "@actions/core";
|
||||
import { ExecOutput } from "@actions/exec";
|
||||
import { Kubectl } from "../types/kubectl";
|
||||
|
||||
export function checkForErrors(
|
||||
execResults: ExecOutput[],
|
||||
warnIfError?: boolean
|
||||
execResults: ExecOutput[],
|
||||
warnIfError?: boolean
|
||||
) {
|
||||
let stderr = ''
|
||||
execResults.forEach((result) => {
|
||||
if (result?.exitCode !== 0) {
|
||||
stderr += result?.stderr + ' \n'
|
||||
} else if (result?.stderr) {
|
||||
core.warning(result.stderr)
|
||||
}
|
||||
})
|
||||
let stderr = "";
|
||||
execResults.forEach((result) => {
|
||||
if (result?.exitCode !== 0) {
|
||||
stderr += result?.stderr + " \n";
|
||||
} else if (result?.stderr) {
|
||||
core.warning(result.stderr);
|
||||
}
|
||||
});
|
||||
|
||||
if (stderr.length > 0) {
|
||||
if (warnIfError) {
|
||||
core.warning(stderr.trim())
|
||||
} else {
|
||||
throw new Error(stderr.trim())
|
||||
}
|
||||
}
|
||||
if (stderr.length > 0) {
|
||||
if (warnIfError) {
|
||||
core.warning(stderr.trim());
|
||||
} else {
|
||||
throw new Error(stderr.trim());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function getLastSuccessfulRunSha(
|
||||
kubectl: Kubectl,
|
||||
namespaceName: string,
|
||||
annotationKey: string
|
||||
kubectl: Kubectl,
|
||||
namespaceName: string,
|
||||
annotationKey: string
|
||||
): Promise<string> {
|
||||
try {
|
||||
const result = await kubectl.getResource(
|
||||
NAMESPACE,
|
||||
namespaceName,
|
||||
false,
|
||||
namespaceName
|
||||
)
|
||||
if (result?.stderr) {
|
||||
core.warning(result.stderr)
|
||||
return process.env.GITHUB_SHA
|
||||
} else if (result?.stdout) {
|
||||
const annotationsSet = JSON.parse(result.stdout).metadata.annotations
|
||||
if (annotationsSet && annotationsSet[annotationKey]) {
|
||||
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
|
||||
.commit
|
||||
} else {
|
||||
return 'NA'
|
||||
}
|
||||
try {
|
||||
const result = await kubectl.getResource("namespace", namespaceName);
|
||||
if (result?.stderr) {
|
||||
core.warning(result.stderr);
|
||||
return process.env.GITHUB_SHA;
|
||||
} else if (result?.stdout) {
|
||||
const annotationsSet = JSON.parse(result.stdout).metadata.annotations;
|
||||
if (annotationsSet && annotationsSet[annotationKey]) {
|
||||
return JSON.parse(annotationsSet[annotationKey].replace(/'/g, '"'))
|
||||
.commit;
|
||||
} else {
|
||||
return "NA";
|
||||
}
|
||||
} catch (ex) {
|
||||
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`)
|
||||
return ''
|
||||
}
|
||||
}
|
||||
} catch (ex) {
|
||||
core.warning(`Failed to get commits from cluster. ${JSON.stringify(ex)}`);
|
||||
return "";
|
||||
}
|
||||
}
|
||||
|
||||
export async function annotateChildPods(
|
||||
kubectl: Kubectl,
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
namespace: string | undefined,
|
||||
annotationKeyValStr: string
|
||||
kubectl: Kubectl,
|
||||
resourceType: string,
|
||||
resourceName: string,
|
||||
annotationKeyValStr: string,
|
||||
allPods
|
||||
): Promise<ExecOutput[]> {
|
||||
let owner = resourceName
|
||||
if (resourceType.toLowerCase().indexOf('deployment') > -1) {
|
||||
owner = await kubectl.getNewReplicaSet(resourceName, namespace)
|
||||
}
|
||||
let owner = resourceName;
|
||||
if (resourceType.toLowerCase().indexOf("deployment") > -1) {
|
||||
owner = await kubectl.getNewReplicaSet(resourceName);
|
||||
}
|
||||
|
||||
const commandExecutionResults = []
|
||||
const commandExecutionResults = [];
|
||||
if (allPods?.items && allPods.items?.length > 0) {
|
||||
allPods.items.forEach((pod) => {
|
||||
const owners = pod?.metadata?.ownerReferences;
|
||||
if (owners) {
|
||||
for (const ownerRef of owners) {
|
||||
if (ownerRef.name === owner) {
|
||||
commandExecutionResults.push(
|
||||
kubectl.annotate("pod", pod.metadata.name, annotationKeyValStr)
|
||||
);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
let allPods
|
||||
try {
|
||||
allPods = JSON.parse((await kubectl.getAllPods()).stdout)
|
||||
} catch (e) {
|
||||
core.debug(`Unable to parse pods: ${e}`)
|
||||
}
|
||||
|
||||
if (allPods?.items && allPods.items?.length > 0) {
|
||||
allPods.items.forEach((pod) => {
|
||||
const owners = pod?.metadata?.ownerReferences
|
||||
if (owners) {
|
||||
for (const ownerRef of owners) {
|
||||
if (ownerRef.name === owner) {
|
||||
commandExecutionResults.push(
|
||||
kubectl.annotate(
|
||||
'pod',
|
||||
pod.metadata.name,
|
||||
annotationKeyValStr,
|
||||
namespace
|
||||
)
|
||||
)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
return await Promise.all(commandExecutionResults)
|
||||
return await Promise.all(commandExecutionResults);
|
||||
}
|
||||
|
||||
@@ -1,48 +1,44 @@
|
||||
import {KubernetesWorkload} from '../types/kubernetesTypes'
|
||||
import { KubernetesWorkload } from "../types/kubernetesTypes";
|
||||
|
||||
export function getImagePullSecrets(inputObject: any) {
|
||||
if (!inputObject?.spec) return null
|
||||
if (!inputObject?.spec) return null;
|
||||
|
||||
if (
|
||||
inputObject.kind.toLowerCase() ===
|
||||
KubernetesWorkload.CRON_JOB.toLowerCase()
|
||||
)
|
||||
return inputObject?.spec?.jobTemplate?.spec?.template?.spec
|
||||
?.imagePullSecrets
|
||||
if (
|
||||
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
|
||||
)
|
||||
return inputObject?.spec?.jobTemplate?.spec?.template?.spec
|
||||
?.imagePullSecrets;
|
||||
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return inputObject.spec.imagePullSecrets
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return inputObject.spec.imagePullSecrets;
|
||||
|
||||
if (inputObject?.spec?.template?.spec) {
|
||||
return inputObject.spec.template.spec.imagePullSecrets
|
||||
}
|
||||
if (inputObject?.spec?.template?.spec) {
|
||||
return inputObject.spec.template.spec.imagePullSecrets;
|
||||
}
|
||||
}
|
||||
|
||||
export function setImagePullSecrets(
|
||||
inputObject: any,
|
||||
newImagePullSecrets: any
|
||||
inputObject: any,
|
||||
newImagePullSecrets: any
|
||||
) {
|
||||
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return
|
||||
if (!inputObject || !inputObject.spec || !newImagePullSecrets) return;
|
||||
|
||||
if (
|
||||
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
|
||||
) {
|
||||
inputObject.spec.imagePullSecrets = newImagePullSecrets
|
||||
return
|
||||
}
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
|
||||
inputObject.spec.imagePullSecrets = newImagePullSecrets;
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
inputObject.kind.toLowerCase() ===
|
||||
KubernetesWorkload.CRON_JOB.toLowerCase()
|
||||
) {
|
||||
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
|
||||
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
|
||||
newImagePullSecrets
|
||||
return
|
||||
}
|
||||
if (
|
||||
inputObject.kind.toLowerCase() === KubernetesWorkload.CRON_JOB.toLowerCase()
|
||||
) {
|
||||
if (inputObject?.spec?.jobTemplate?.spec?.template?.spec)
|
||||
inputObject.spec.jobTemplate.spec.template.spec.imagePullSecrets =
|
||||
newImagePullSecrets;
|
||||
return;
|
||||
}
|
||||
|
||||
if (inputObject?.spec?.template?.spec) {
|
||||
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets
|
||||
return
|
||||
}
|
||||
if (inputObject?.spec?.template?.spec) {
|
||||
inputObject.spec.template.spec.imagePullSecrets = newImagePullSecrets;
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,73 +1,71 @@
|
||||
import {
|
||||
InputObjectKindNotDefinedError,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload,
|
||||
NullInputObjectError
|
||||
} from '../types/kubernetesTypes'
|
||||
InputObjectKindNotDefinedError,
|
||||
isServiceEntity,
|
||||
KubernetesWorkload,
|
||||
NullInputObjectError,
|
||||
} from "../types/kubernetesTypes";
|
||||
|
||||
export function updateSpecLabels(
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
override: boolean
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
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)
|
||||
if (override) {
|
||||
existingLabels = newLabels
|
||||
} else {
|
||||
existingLabels = existingLabels || new Map<string, string>()
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
)
|
||||
}
|
||||
let existingLabels = getSpecLabels(inputObject);
|
||||
if (override) {
|
||||
existingLabels = newLabels;
|
||||
} else {
|
||||
existingLabels = existingLabels || new Map<string, string>();
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
);
|
||||
}
|
||||
|
||||
setSpecLabels(inputObject, existingLabels)
|
||||
setSpecLabels(inputObject, existingLabels);
|
||||
}
|
||||
|
||||
function getSpecLabels(inputObject: any) {
|
||||
if (!inputObject) return null
|
||||
if (!inputObject) return null;
|
||||
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return inputObject.metadata.labels
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return inputObject.metadata.labels;
|
||||
|
||||
if (inputObject?.spec?.template?.metadata)
|
||||
return inputObject.spec.template.metadata.labels
|
||||
if (inputObject?.spec?.template?.metadata)
|
||||
return inputObject.spec.template.metadata.labels;
|
||||
|
||||
return null
|
||||
return null;
|
||||
}
|
||||
|
||||
function setSpecLabels(inputObject: any, newLabels: any) {
|
||||
if (!inputObject || !newLabels) return null
|
||||
if (!inputObject || !newLabels) return null;
|
||||
|
||||
if (
|
||||
inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()
|
||||
) {
|
||||
inputObject.metadata.labels = newLabels
|
||||
return
|
||||
}
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase()) {
|
||||
inputObject.metadata.labels = newLabels;
|
||||
return;
|
||||
}
|
||||
|
||||
if (inputObject?.spec?.template?.metatada) {
|
||||
inputObject.spec.template.metatada.labels = newLabels
|
||||
return
|
||||
}
|
||||
if (inputObject?.spec?.template?.metatada) {
|
||||
inputObject.spec.template.metatada.labels = newLabels;
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
export function getSpecSelectorLabels(inputObject: any) {
|
||||
if (inputObject?.spec?.selector) {
|
||||
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector
|
||||
else return inputObject.spec.selector.matchLabels
|
||||
}
|
||||
if (inputObject?.spec?.selector) {
|
||||
if (isServiceEntity(inputObject.kind)) return inputObject.spec.selector;
|
||||
else return inputObject.spec.selector.matchLabels;
|
||||
}
|
||||
}
|
||||
|
||||
export function setSpecSelectorLabels(inputObject: any, newLabels: any) {
|
||||
if (inputObject?.spec?.selector) {
|
||||
if (isServiceEntity(inputObject.kind))
|
||||
inputObject.spec.selector = newLabels
|
||||
else inputObject.spec.selector.matchLabels = newLabels
|
||||
}
|
||||
if (inputObject?.spec?.selector) {
|
||||
if (isServiceEntity(inputObject.kind))
|
||||
inputObject.spec.selector = newLabels;
|
||||
else inputObject.spec.selector.matchLabels = newLabels;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
import * as manifestStabilityUtils from './manifestStabilityUtils'
|
||||
import {Kubectl} from '../types/kubectl'
|
||||
import {ResourceTypeFleet, ResourceTypeManagedCluster} from '../actions/deploy'
|
||||
import {ExecOutput} from '@actions/exec'
|
||||
import {exitCode, stdout} from 'process'
|
||||
|
||||
describe('manifestStabilityUtils', () => {
|
||||
const kc = new Kubectl('')
|
||||
const resources = [
|
||||
{
|
||||
type: 'deployment',
|
||||
name: 'test',
|
||||
namespace: 'default'
|
||||
}
|
||||
]
|
||||
|
||||
it('should return immediately if the resource type is fleet', async () => {
|
||||
const spy = jest.spyOn(manifestStabilityUtils, 'checkManifestStability')
|
||||
const checkRolloutStatusSpy = jest.spyOn(kc, 'checkRolloutStatus')
|
||||
await manifestStabilityUtils.checkManifestStability(
|
||||
kc,
|
||||
resources,
|
||||
ResourceTypeFleet
|
||||
)
|
||||
|
||||
expect(checkRolloutStatusSpy).not.toHaveBeenCalled()
|
||||
expect(spy).toHaveReturned()
|
||||
})
|
||||
|
||||
it('should run fully if the resource type is managedCluster', async () => {
|
||||
const spy = jest.spyOn(manifestStabilityUtils, 'checkManifestStability')
|
||||
const checkRolloutStatusSpy = jest
|
||||
.spyOn(kc, 'checkRolloutStatus')
|
||||
.mockImplementation(() => {
|
||||
return new Promise<ExecOutput>((resolve, reject) => {
|
||||
resolve({
|
||||
exitCode: 0,
|
||||
stderr: '',
|
||||
stdout: ''
|
||||
})
|
||||
})
|
||||
})
|
||||
await manifestStabilityUtils.checkManifestStability(
|
||||
kc,
|
||||
resources,
|
||||
ResourceTypeManagedCluster
|
||||
)
|
||||
|
||||
expect(checkRolloutStatusSpy).toHaveBeenCalled()
|
||||
expect(spy).toHaveReturned()
|
||||
})
|
||||
})
|
||||
@@ -1,220 +1,184 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as KubernetesConstants from '../types/kubernetesTypes'
|
||||
import {Kubectl, Resource} from '../types/kubectl'
|
||||
import {checkForErrors} from './kubectlUtils'
|
||||
import {sleep} from './timeUtils'
|
||||
import {ResourceTypeFleet} from '../actions/deploy'
|
||||
import {ClusterType} from '../inputUtils'
|
||||
|
||||
const IS_SILENT = false
|
||||
const POD = 'pod'
|
||||
|
||||
export async function checkManifestStability(
|
||||
kubectl: Kubectl,
|
||||
resources: Resource[],
|
||||
resourceType: ClusterType
|
||||
): Promise<void> {
|
||||
// Skip if resource type is microsoft.containerservice/fleets
|
||||
if (resourceType === ResourceTypeFleet) {
|
||||
core.info(`Skipping checkManifestStability for ${ResourceTypeFleet}`)
|
||||
return
|
||||
}
|
||||
let rolloutStatusHasErrors = false
|
||||
for (let i = 0; i < resources.length; i++) {
|
||||
const resource = resources[i]
|
||||
|
||||
if (
|
||||
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
|
||||
resource.type.toLowerCase()
|
||||
) >= 0
|
||||
) {
|
||||
try {
|
||||
const result = await kubectl.checkRolloutStatus(
|
||||
resource.type,
|
||||
resource.name,
|
||||
resource.namespace
|
||||
)
|
||||
checkForErrors([result])
|
||||
} catch (ex) {
|
||||
core.error(ex)
|
||||
await kubectl.describe(
|
||||
resource.type,
|
||||
resource.name,
|
||||
IS_SILENT,
|
||||
resource.namespace
|
||||
)
|
||||
rolloutStatusHasErrors = true
|
||||
}
|
||||
}
|
||||
|
||||
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
|
||||
try {
|
||||
await checkPodStatus(kubectl, resource)
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Could not determine pod status: ${JSON.stringify(ex)}`
|
||||
)
|
||||
await kubectl.describe(
|
||||
resource.type,
|
||||
resource.name,
|
||||
IS_SILENT,
|
||||
resource.namespace
|
||||
)
|
||||
}
|
||||
}
|
||||
if (
|
||||
resource.type ==
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
|
||||
) {
|
||||
try {
|
||||
const service = await getService(kubectl, resource)
|
||||
const {spec, status} = service
|
||||
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
|
||||
if (!isLoadBalancerIPAssigned(status)) {
|
||||
await waitForServiceExternalIPAssignment(kubectl, resource)
|
||||
} else {
|
||||
core.info(
|
||||
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
|
||||
)
|
||||
}
|
||||
}
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Could not determine service status of: ${resource.name} Error: ${ex}`
|
||||
)
|
||||
await kubectl.describe(
|
||||
resource.type,
|
||||
resource.name,
|
||||
IS_SILENT,
|
||||
resource.namespace
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (rolloutStatusHasErrors) {
|
||||
throw new Error('Rollout status error')
|
||||
}
|
||||
}
|
||||
|
||||
export async function checkPodStatus(
|
||||
kubectl: Kubectl,
|
||||
pod: Resource
|
||||
): Promise<void> {
|
||||
const sleepTimeout = 10 * 1000 // 10 seconds
|
||||
const iterations = 60 // 60 * 10 seconds timeout = 10 minutes max timeout
|
||||
|
||||
let podStatus
|
||||
let kubectlDescribeNeeded = false
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
await sleep(sleepTimeout)
|
||||
|
||||
core.debug(`Polling for pod status: ${pod.name}`)
|
||||
podStatus = await getPodStatus(kubectl, pod)
|
||||
|
||||
if (
|
||||
podStatus &&
|
||||
podStatus?.phase !== 'Pending' &&
|
||||
podStatus?.phase !== 'Unknown'
|
||||
) {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
podStatus = await getPodStatus(kubectl, pod)
|
||||
switch (podStatus.phase) {
|
||||
case 'Succeeded':
|
||||
case 'Running':
|
||||
if (isPodReady(podStatus)) {
|
||||
console.log(`pod/${pod.name} is successfully rolled out`)
|
||||
} else {
|
||||
kubectlDescribeNeeded = true
|
||||
}
|
||||
break
|
||||
case 'Pending':
|
||||
if (!isPodReady(podStatus)) {
|
||||
core.warning(`pod/${pod.name} rollout status check timed out`)
|
||||
kubectlDescribeNeeded = true
|
||||
}
|
||||
break
|
||||
case 'Failed':
|
||||
core.error(`pod/${pod.name} rollout failed`)
|
||||
kubectlDescribeNeeded = true
|
||||
break
|
||||
default:
|
||||
core.warning(`pod/${pod.name} rollout status: ${podStatus.phase}`)
|
||||
}
|
||||
|
||||
if (kubectlDescribeNeeded) {
|
||||
await kubectl.describe(POD, pod.name, IS_SILENT, pod.namespace)
|
||||
}
|
||||
}
|
||||
|
||||
async function getPodStatus(kubectl: Kubectl, pod: Resource) {
|
||||
const podResult = await kubectl.getResource(
|
||||
POD,
|
||||
pod.name,
|
||||
IS_SILENT,
|
||||
pod.namespace
|
||||
)
|
||||
checkForErrors([podResult])
|
||||
|
||||
return JSON.parse(podResult.stdout).status
|
||||
}
|
||||
|
||||
function isPodReady(podStatus: any): boolean {
|
||||
let allContainersAreReady = true
|
||||
podStatus.containerStatuses.forEach((container) => {
|
||||
if (container.ready === false) {
|
||||
core.info(
|
||||
`'${container.name}' status: ${JSON.stringify(container.state)}`
|
||||
)
|
||||
allContainersAreReady = false
|
||||
}
|
||||
})
|
||||
|
||||
if (!allContainersAreReady) {
|
||||
core.warning('All containers not in ready state')
|
||||
}
|
||||
|
||||
return allContainersAreReady
|
||||
}
|
||||
|
||||
async function getService(kubectl: Kubectl, service: Resource) {
|
||||
const serviceResult = await kubectl.getResource(
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
|
||||
service.name,
|
||||
IS_SILENT,
|
||||
service.namespace
|
||||
)
|
||||
|
||||
checkForErrors([serviceResult])
|
||||
return JSON.parse(serviceResult.stdout)
|
||||
}
|
||||
|
||||
async function waitForServiceExternalIPAssignment(
|
||||
kubectl: Kubectl,
|
||||
service: Resource
|
||||
): Promise<void> {
|
||||
const sleepTimeout = 10 * 1000 // 10 seconds
|
||||
const iterations = 18 // 18 * 10 seconds timeout = 3 minutes max timeout
|
||||
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
core.info(`Wait for service ip assignment : ${service.name}`)
|
||||
await sleep(sleepTimeout)
|
||||
|
||||
const status = (await getService(kubectl, service)).status
|
||||
if (isLoadBalancerIPAssigned(status)) {
|
||||
core.info(
|
||||
`ServiceExternalIP ${service.name} ${status.loadBalancer.ingress[0].ip}`
|
||||
)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
core.warning(`Wait for service ip assignment timed out ${service.name}`)
|
||||
}
|
||||
|
||||
function isLoadBalancerIPAssigned(status: any) {
|
||||
return status?.loadBalancer?.ingress?.length > 0
|
||||
}
|
||||
import * as core from "@actions/core";
|
||||
import * as KubernetesConstants from "../types/kubernetesTypes";
|
||||
import { Kubectl, Resource } from "../types/kubectl";
|
||||
import { checkForErrors } from "./kubectlUtils";
|
||||
import { sleep } from "./timeUtils";
|
||||
|
||||
export async function checkManifestStability(
|
||||
kubectl: Kubectl,
|
||||
resources: Resource[]
|
||||
): Promise<void> {
|
||||
let rolloutStatusHasErrors = false;
|
||||
for (let i = 0; i < resources.length; i++) {
|
||||
const resource = resources[i];
|
||||
|
||||
if (
|
||||
KubernetesConstants.WORKLOAD_TYPES_WITH_ROLLOUT_STATUS.indexOf(
|
||||
resource.type.toLowerCase()
|
||||
) >= 0
|
||||
) {
|
||||
try {
|
||||
const result = await kubectl.checkRolloutStatus(
|
||||
resource.type,
|
||||
resource.name
|
||||
);
|
||||
checkForErrors([result]);
|
||||
} catch (ex) {
|
||||
core.error(ex);
|
||||
await kubectl.describe(resource.type, resource.name);
|
||||
rolloutStatusHasErrors = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (resource.type == KubernetesConstants.KubernetesWorkload.POD) {
|
||||
try {
|
||||
await checkPodStatus(kubectl, resource.name);
|
||||
} catch (ex) {
|
||||
core.warning(`Could not determine pod status: ${JSON.stringify(ex)}`);
|
||||
await kubectl.describe(resource.type, resource.name);
|
||||
}
|
||||
}
|
||||
if (
|
||||
resource.type ==
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE
|
||||
) {
|
||||
try {
|
||||
const service = await getService(kubectl, resource.name);
|
||||
const { spec, status } = service;
|
||||
if (spec.type === KubernetesConstants.ServiceTypes.LOAD_BALANCER) {
|
||||
if (!isLoadBalancerIPAssigned(status)) {
|
||||
await waitForServiceExternalIPAssignment(kubectl, resource.name);
|
||||
} else {
|
||||
core.info(
|
||||
`ServiceExternalIP ${resource.name} ${status.loadBalancer.ingress[0].ip}`
|
||||
);
|
||||
}
|
||||
}
|
||||
} catch (ex) {
|
||||
core.warning(
|
||||
`Could not determine service status of: ${resource.name} Error: ${ex}`
|
||||
);
|
||||
await kubectl.describe(resource.type, resource.name);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (rolloutStatusHasErrors) {
|
||||
throw new Error("Rollout status error");
|
||||
}
|
||||
}
|
||||
|
||||
export async function checkPodStatus(
|
||||
kubectl: Kubectl,
|
||||
podName: string
|
||||
): Promise<void> {
|
||||
const sleepTimeout = 10 * 1000; // 10 seconds
|
||||
const iterations = 60; // 60 * 10 seconds timeout = 10 minutes max timeout
|
||||
|
||||
let podStatus;
|
||||
let kubectlDescribeNeeded = false;
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
await sleep(sleepTimeout);
|
||||
|
||||
core.debug(`Polling for pod status: ${podName}`);
|
||||
podStatus = await getPodStatus(kubectl, podName);
|
||||
|
||||
if (
|
||||
podStatus &&
|
||||
podStatus?.phase !== "Pending" &&
|
||||
podStatus?.phase !== "Unknown"
|
||||
) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
podStatus = await getPodStatus(kubectl, podName);
|
||||
switch (podStatus.phase) {
|
||||
case "Succeeded":
|
||||
case "Running":
|
||||
if (isPodReady(podStatus)) {
|
||||
console.log(`pod/${podName} is successfully rolled out`);
|
||||
} else {
|
||||
kubectlDescribeNeeded = true;
|
||||
}
|
||||
break;
|
||||
case "Pending":
|
||||
if (!isPodReady(podStatus)) {
|
||||
core.warning(`pod/${podName} rollout status check timed out`);
|
||||
kubectlDescribeNeeded = true;
|
||||
}
|
||||
break;
|
||||
case "Failed":
|
||||
core.error(`pod/${podName} rollout failed`);
|
||||
kubectlDescribeNeeded = true;
|
||||
break;
|
||||
default:
|
||||
core.warning(`pod/${podName} rollout status: ${podStatus.phase}`);
|
||||
}
|
||||
|
||||
if (kubectlDescribeNeeded) {
|
||||
await kubectl.describe("pod", podName);
|
||||
}
|
||||
}
|
||||
|
||||
async function getPodStatus(kubectl: Kubectl, podName: string) {
|
||||
const podResult = await kubectl.getResource("pod", podName);
|
||||
checkForErrors([podResult]);
|
||||
|
||||
return JSON.parse(podResult.stdout).status;
|
||||
}
|
||||
|
||||
function isPodReady(podStatus: any): boolean {
|
||||
let allContainersAreReady = true;
|
||||
podStatus.containerStatuses.forEach((container) => {
|
||||
if (container.ready === false) {
|
||||
core.info(
|
||||
`'${container.name}' status: ${JSON.stringify(container.state)}`
|
||||
);
|
||||
allContainersAreReady = false;
|
||||
}
|
||||
});
|
||||
|
||||
if (!allContainersAreReady) {
|
||||
core.warning("All containers not in ready state");
|
||||
}
|
||||
|
||||
return allContainersAreReady;
|
||||
}
|
||||
|
||||
async function getService(kubectl: Kubectl, serviceName) {
|
||||
const serviceResult = await kubectl.getResource(
|
||||
KubernetesConstants.DiscoveryAndLoadBalancerResource.SERVICE,
|
||||
serviceName
|
||||
);
|
||||
|
||||
checkForErrors([serviceResult]);
|
||||
return JSON.parse(serviceResult.stdout);
|
||||
}
|
||||
|
||||
async function waitForServiceExternalIPAssignment(
|
||||
kubectl: Kubectl,
|
||||
serviceName: string
|
||||
): Promise<void> {
|
||||
const sleepTimeout = 10 * 1000; // 10 seconds
|
||||
const iterations = 18; // 18 * 10 seconds timeout = 3 minutes max timeout
|
||||
|
||||
for (let i = 0; i < iterations; i++) {
|
||||
core.info(`Wait for service ip assignment : ${serviceName}`);
|
||||
await sleep(sleepTimeout);
|
||||
|
||||
const status = (await getService(kubectl, serviceName)).status;
|
||||
if (isLoadBalancerIPAssigned(status)) {
|
||||
core.info(
|
||||
`ServiceExternalIP ${serviceName} ${status.loadBalancer.ingress[0].ip}`
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
core.warning(`Wait for service ip assignment timed out${serviceName}`);
|
||||
}
|
||||
|
||||
function isLoadBalancerIPAssigned(status: any) {
|
||||
return status?.loadBalancer?.ingress?.length > 0;
|
||||
}
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
import * as fileUtils from './fileUtils'
|
||||
import * as manifestUpdateUtils from './manifestUpdateUtils'
|
||||
import * as path from 'path'
|
||||
import * as fs from 'fs'
|
||||
|
||||
describe('manifestUpdateUtils', () => {
|
||||
jest.spyOn(fileUtils, 'moveFileToTmpDir').mockImplementation((filename) => {
|
||||
return path.join('/tmp', filename)
|
||||
})
|
||||
jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {})
|
||||
jest.spyOn(fs, 'readFileSync').mockImplementation((filename) => {
|
||||
return 'test contents'
|
||||
})
|
||||
|
||||
it('should place all files within the temp dir with the same path that they have in the repo', () => {
|
||||
const originalFilePaths: string[] = [
|
||||
'path/in/repo/test.txt',
|
||||
'path/deeper/in/repo/test.txt'
|
||||
]
|
||||
const expected: string[] = [
|
||||
'/tmp/path/in/repo/test.txt',
|
||||
'/tmp/path/deeper/in/repo/test.txt'
|
||||
]
|
||||
const newFilePaths =
|
||||
manifestUpdateUtils.moveFilesToTmpDir(originalFilePaths)
|
||||
expect(newFilePaths).toEqual(expected)
|
||||
})
|
||||
})
|
||||
@@ -1,332 +1,310 @@
|
||||
import * as core from '@actions/core'
|
||||
import * as fs from 'fs'
|
||||
import * as yaml from 'js-yaml'
|
||||
import * as path from 'path'
|
||||
import * as fileHelper from './fileUtils'
|
||||
import {moveFileToTmpDir} from './fileUtils'
|
||||
import {
|
||||
InputObjectKindNotDefinedError,
|
||||
InputObjectMetadataNotDefinedError,
|
||||
isWorkloadEntity,
|
||||
KubernetesWorkload,
|
||||
NullInputObjectError
|
||||
} from '../types/kubernetesTypes'
|
||||
import {
|
||||
getSpecSelectorLabels,
|
||||
setSpecSelectorLabels
|
||||
} from './manifestSpecLabelUtils'
|
||||
import {
|
||||
getImagePullSecrets,
|
||||
setImagePullSecrets
|
||||
} from './manifestPullSecretUtils'
|
||||
import {Resource} from '../types/kubectl'
|
||||
import {K8sObject} from '../types/k8sObject'
|
||||
|
||||
export function updateManifestFiles(manifestFilePaths: string[]) {
|
||||
if (manifestFilePaths?.length === 0) {
|
||||
throw new Error('Manifest files not provided')
|
||||
}
|
||||
|
||||
// move original set of input files to tmp dir
|
||||
const manifestFilesInTempDir = moveFilesToTmpDir(manifestFilePaths)
|
||||
|
||||
// update container images
|
||||
const containers: string[] = core.getInput('images').split('\n')
|
||||
|
||||
const manifestFiles = updateContainerImagesInManifestFiles(
|
||||
manifestFilesInTempDir,
|
||||
containers
|
||||
)
|
||||
|
||||
// update pull secrets
|
||||
const imagePullSecrets: string[] = core
|
||||
.getInput('imagepullsecrets')
|
||||
.split('\n')
|
||||
.filter((secret) => secret.trim().length > 0)
|
||||
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets)
|
||||
}
|
||||
|
||||
export function moveFilesToTmpDir(filepaths: string[]): string[] {
|
||||
return filepaths.map((filename) => {
|
||||
return moveFileToTmpDir(filename)
|
||||
})
|
||||
}
|
||||
|
||||
export function UnsetClusterSpecificDetails(resource: any) {
|
||||
if (!resource) {
|
||||
return
|
||||
}
|
||||
|
||||
// Unset cluster specific details in the object
|
||||
if (!!resource) {
|
||||
const {metadata, status} = resource
|
||||
|
||||
if (!!metadata) {
|
||||
resource.metadata = {
|
||||
annotations: metadata.annotations,
|
||||
labels: metadata.labels,
|
||||
name: metadata.name
|
||||
}
|
||||
}
|
||||
|
||||
if (!!status) {
|
||||
resource.status = {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function updateContainerImagesInManifestFiles(
|
||||
filePaths: string[],
|
||||
containers: string[]
|
||||
): string[] {
|
||||
if (filePaths?.length <= 0) return filePaths
|
||||
|
||||
// update container images
|
||||
filePaths.forEach((filePath: string) => {
|
||||
let contents = fs.readFileSync(filePath).toString()
|
||||
containers.forEach((container: string) => {
|
||||
let [imageName] = container.split(':')
|
||||
if (imageName.indexOf('@') > 0) {
|
||||
imageName = imageName.split('@')[0]
|
||||
}
|
||||
|
||||
if (contents.indexOf(imageName) > 0)
|
||||
contents = substituteImageNameInSpecFile(
|
||||
contents,
|
||||
imageName,
|
||||
container
|
||||
)
|
||||
})
|
||||
|
||||
// write updated files
|
||||
fs.writeFileSync(path.join(filePath), contents)
|
||||
})
|
||||
|
||||
return filePaths
|
||||
}
|
||||
|
||||
/*
|
||||
Example:
|
||||
|
||||
Input of
|
||||
currentString: `image: "example/example-image"`
|
||||
imageName: `example/example-image`
|
||||
imageNameWithNewTag: `example/example-image:identifiertag`
|
||||
|
||||
would return
|
||||
`image: "example/example-image:identifiertag"`
|
||||
*/
|
||||
export function substituteImageNameInSpecFile(
|
||||
spec: string,
|
||||
imageName: string,
|
||||
imageNameWithNewTag: string
|
||||
) {
|
||||
if (spec.indexOf(imageName) < 0) return spec
|
||||
|
||||
return spec.split('\n').reduce((acc, line) => {
|
||||
const imageKeyword = line.match(/^ *-? *image:/)
|
||||
if (imageKeyword) {
|
||||
let [currentImageName] = line
|
||||
.substring(imageKeyword[0].length) // consume the line from keyword onwards
|
||||
.trim()
|
||||
.replace(/[',"]/g, '') // replace allowed quotes with nothing
|
||||
.split(':')
|
||||
|
||||
if (currentImageName?.indexOf(' ') > 0) {
|
||||
currentImageName = currentImageName.split(' ')[0] // remove comments
|
||||
}
|
||||
|
||||
if (currentImageName === imageName) {
|
||||
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`
|
||||
}
|
||||
}
|
||||
|
||||
return acc + line + '\n'
|
||||
}, '')
|
||||
}
|
||||
|
||||
export function getReplicaCount(inputObject: any): any {
|
||||
if (!inputObject) throw NullInputObjectError
|
||||
|
||||
if (!inputObject.kind) {
|
||||
throw InputObjectKindNotDefinedError
|
||||
}
|
||||
|
||||
const {kind} = inputObject
|
||||
if (
|
||||
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
|
||||
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
|
||||
)
|
||||
return inputObject.spec.replicas
|
||||
|
||||
return 0
|
||||
}
|
||||
|
||||
export function updateObjectLabels(
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError
|
||||
|
||||
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
|
||||
|
||||
if (!newLabels) return
|
||||
|
||||
if (override) {
|
||||
inputObject.metadata.labels = newLabels
|
||||
} else {
|
||||
let existingLabels =
|
||||
inputObject.metadata.labels || new Map<string, string>()
|
||||
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
)
|
||||
|
||||
inputObject.metadata.labels = existingLabels
|
||||
}
|
||||
}
|
||||
|
||||
export function updateObjectAnnotations(
|
||||
inputObject: any,
|
||||
newAnnotations: Map<string, string>,
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError
|
||||
|
||||
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError
|
||||
|
||||
if (!newAnnotations) return
|
||||
|
||||
if (override) {
|
||||
inputObject.metadata.annotations = newAnnotations
|
||||
} else {
|
||||
const existingAnnotations =
|
||||
inputObject.metadata.annotations || new Map<string, string>()
|
||||
|
||||
Object.keys(newAnnotations).forEach(
|
||||
(key) => (existingAnnotations[key] = newAnnotations[key])
|
||||
)
|
||||
|
||||
inputObject.metadata.annotations = existingAnnotations
|
||||
}
|
||||
}
|
||||
|
||||
export function updateImagePullSecrets(
|
||||
inputObject: any,
|
||||
newImagePullSecrets: string[],
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject?.spec || !newImagePullSecrets) return
|
||||
|
||||
const newImagePullSecretsObjects = Array.from(
|
||||
newImagePullSecrets,
|
||||
(name) => {
|
||||
return {name}
|
||||
}
|
||||
)
|
||||
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject)
|
||||
|
||||
if (override) {
|
||||
existingImagePullSecretObjects = newImagePullSecretsObjects
|
||||
} else {
|
||||
existingImagePullSecretObjects = existingImagePullSecretObjects || []
|
||||
|
||||
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
|
||||
newImagePullSecretsObjects
|
||||
)
|
||||
}
|
||||
|
||||
setImagePullSecrets(inputObject, existingImagePullSecretObjects)
|
||||
}
|
||||
|
||||
export function updateSelectorLabels(
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
override: boolean
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError
|
||||
|
||||
if (!inputObject.kind) throw InputObjectKindNotDefinedError
|
||||
|
||||
if (!newLabels) return
|
||||
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return
|
||||
|
||||
let existingLabels = getSpecSelectorLabels(inputObject)
|
||||
if (override) {
|
||||
existingLabels = newLabels
|
||||
} else {
|
||||
existingLabels = existingLabels || new Map<string, string>()
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
)
|
||||
}
|
||||
|
||||
setSpecSelectorLabels(inputObject, existingLabels)
|
||||
}
|
||||
|
||||
export function getResources(
|
||||
filePaths: string[],
|
||||
filterResourceTypes: string[]
|
||||
): Resource[] {
|
||||
if (!filePaths) return []
|
||||
|
||||
const resources: Resource[] = []
|
||||
filePaths.forEach((filePath: string) => {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
const inputObjects: K8sObject[] = yaml.loadAll(
|
||||
fileContents
|
||||
) as K8sObject[]
|
||||
inputObjects.forEach((inputObject) => {
|
||||
const inputObjectKind = inputObject?.kind || ''
|
||||
if (
|
||||
filterResourceTypes.filter(
|
||||
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
|
||||
).length > 0
|
||||
) {
|
||||
resources.push({
|
||||
type: inputObject.kind,
|
||||
name: inputObject.metadata.name,
|
||||
namespace: inputObject?.metadata?.namespace
|
||||
})
|
||||
}
|
||||
})
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
})
|
||||
|
||||
return resources
|
||||
}
|
||||
|
||||
function updateImagePullSecretsInManifestFiles(
|
||||
filePaths: string[],
|
||||
imagePullSecrets: string[]
|
||||
): string[] {
|
||||
if (imagePullSecrets?.length <= 0) return filePaths
|
||||
|
||||
const newObjectsList = []
|
||||
filePaths.forEach((filePath: string) => {
|
||||
try {
|
||||
const fileContents = fs.readFileSync(filePath).toString()
|
||||
yaml.loadAll(fileContents, (inputObject: any) => {
|
||||
if (inputObject?.kind) {
|
||||
const {kind} = inputObject
|
||||
if (isWorkloadEntity(kind)) {
|
||||
updateImagePullSecrets(inputObject, imagePullSecrets)
|
||||
}
|
||||
newObjectsList.push(inputObject)
|
||||
}
|
||||
})
|
||||
} catch (error) {
|
||||
core.error(`Failed to process file at ${filePath}: ${error.message}`)
|
||||
throw error
|
||||
}
|
||||
})
|
||||
|
||||
return fileHelper.writeObjectsToFile(newObjectsList)
|
||||
}
|
||||
import * as core from "@actions/core";
|
||||
import * as fs from "fs";
|
||||
import * as yaml from "js-yaml";
|
||||
import * as path from "path";
|
||||
import * as fileHelper from "./fileUtils";
|
||||
import { getTempDirectory } from "./fileUtils";
|
||||
import {
|
||||
InputObjectKindNotDefinedError,
|
||||
InputObjectMetadataNotDefinedError,
|
||||
isWorkloadEntity,
|
||||
KubernetesWorkload,
|
||||
NullInputObjectError,
|
||||
} from "../types/kubernetesTypes";
|
||||
import {
|
||||
getSpecSelectorLabels,
|
||||
setSpecSelectorLabels,
|
||||
} from "./manifestSpecLabelUtils";
|
||||
import {
|
||||
getImagePullSecrets,
|
||||
setImagePullSecrets,
|
||||
} from "./manifestPullSecretUtils";
|
||||
import { Resource } from "../types/kubectl";
|
||||
|
||||
export function updateManifestFiles(manifestFilePaths: string[]) {
|
||||
if (manifestFilePaths?.length === 0) {
|
||||
throw new Error("Manifest files not provided");
|
||||
}
|
||||
|
||||
// update container images
|
||||
const containers: string[] = core.getInput("images").split("\n");
|
||||
const manifestFiles = updateContainerImagesInManifestFiles(
|
||||
manifestFilePaths,
|
||||
containers
|
||||
);
|
||||
|
||||
// update pull secrets
|
||||
const imagePullSecrets: string[] = core
|
||||
.getInput("imagepullsecrets")
|
||||
.split("\n")
|
||||
.filter((secret) => secret.trim().length > 0);
|
||||
return updateImagePullSecretsInManifestFiles(manifestFiles, imagePullSecrets);
|
||||
}
|
||||
|
||||
export function UnsetClusterSpecificDetails(resource: any) {
|
||||
if (!resource) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Unset cluster specific details in the object
|
||||
if (!!resource) {
|
||||
const { metadata, status } = resource;
|
||||
|
||||
if (!!metadata) {
|
||||
resource.metadata = {
|
||||
annotations: metadata.annotations,
|
||||
labels: metadata.labels,
|
||||
name: metadata.name,
|
||||
};
|
||||
}
|
||||
|
||||
if (!!status) {
|
||||
resource.status = {};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function updateContainerImagesInManifestFiles(
|
||||
filePaths: string[],
|
||||
containers: string[]
|
||||
): string[] {
|
||||
if (filePaths?.length <= 0) return filePaths;
|
||||
|
||||
const newFilePaths = [];
|
||||
|
||||
// update container images
|
||||
filePaths.forEach((filePath: string) => {
|
||||
let contents = fs.readFileSync(filePath).toString();
|
||||
|
||||
containers.forEach((container: string) => {
|
||||
let [imageName] = container.split(":");
|
||||
if (imageName.indexOf("@") > 0) {
|
||||
imageName = imageName.split("@")[0];
|
||||
}
|
||||
|
||||
if (contents.indexOf(imageName) > 0)
|
||||
contents = substituteImageNameInSpecFile(
|
||||
contents,
|
||||
imageName,
|
||||
container
|
||||
);
|
||||
});
|
||||
|
||||
// write updated files
|
||||
const tempDirectory = getTempDirectory();
|
||||
const fileName = path.join(tempDirectory, path.basename(filePath));
|
||||
fs.writeFileSync(path.join(fileName), contents);
|
||||
newFilePaths.push(fileName);
|
||||
});
|
||||
|
||||
return newFilePaths;
|
||||
}
|
||||
|
||||
/*
|
||||
Example:
|
||||
|
||||
Input of
|
||||
currentString: `image: "example/example-image"`
|
||||
imageName: `example/example-image`
|
||||
imageNameWithNewTag: `example/example-image:identifiertag`
|
||||
|
||||
would return
|
||||
`image: "example/example-image:identifiertag"`
|
||||
*/
|
||||
export function substituteImageNameInSpecFile(
|
||||
spec: string,
|
||||
imageName: string,
|
||||
imageNameWithNewTag: string
|
||||
) {
|
||||
if (spec.indexOf(imageName) < 0) return spec;
|
||||
|
||||
return spec.split("\n").reduce((acc, line) => {
|
||||
const imageKeyword = line.match(/^ *-? *image:/);
|
||||
if (imageKeyword) {
|
||||
let [currentImageName] = line
|
||||
.substring(imageKeyword[0].length) // consume the line from keyword onwards
|
||||
.trim()
|
||||
.replace(/[',"]/g, "") // replace allowed quotes with nothing
|
||||
.split(":");
|
||||
|
||||
if (currentImageName?.indexOf(" ") > 0) {
|
||||
currentImageName = currentImageName.split(" ")[0]; // remove comments
|
||||
}
|
||||
|
||||
if (currentImageName === imageName) {
|
||||
return acc + `${imageKeyword[0]} ${imageNameWithNewTag}\n`;
|
||||
}
|
||||
}
|
||||
|
||||
return acc + line + "\n";
|
||||
}, "");
|
||||
}
|
||||
|
||||
export function getReplicaCount(inputObject: any): any {
|
||||
if (!inputObject) throw NullInputObjectError;
|
||||
|
||||
if (!inputObject.kind) {
|
||||
throw InputObjectKindNotDefinedError;
|
||||
}
|
||||
|
||||
const { kind } = inputObject;
|
||||
if (
|
||||
kind.toLowerCase() !== KubernetesWorkload.POD.toLowerCase() &&
|
||||
kind.toLowerCase() !== KubernetesWorkload.DAEMON_SET.toLowerCase()
|
||||
)
|
||||
return inputObject.spec.replicas;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
export function updateObjectLabels(
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError;
|
||||
|
||||
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
|
||||
|
||||
if (!newLabels) return;
|
||||
|
||||
if (override) {
|
||||
inputObject.metadata.labels = newLabels;
|
||||
} else {
|
||||
let existingLabels =
|
||||
inputObject.metadata.labels || new Map<string, string>();
|
||||
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
);
|
||||
|
||||
inputObject.metadata.labels = existingLabels;
|
||||
}
|
||||
}
|
||||
|
||||
export function updateObjectAnnotations(
|
||||
inputObject: any,
|
||||
newAnnotations: Map<string, string>,
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError;
|
||||
|
||||
if (!inputObject.metadata) throw InputObjectMetadataNotDefinedError;
|
||||
|
||||
if (!newAnnotations) return;
|
||||
|
||||
if (override) {
|
||||
inputObject.metadata.annotations = newAnnotations;
|
||||
} else {
|
||||
const existingAnnotations =
|
||||
inputObject.metadata.annotations || new Map<string, string>();
|
||||
|
||||
Object.keys(newAnnotations).forEach(
|
||||
(key) => (existingAnnotations[key] = newAnnotations[key])
|
||||
);
|
||||
|
||||
inputObject.metadata.annotations = existingAnnotations;
|
||||
}
|
||||
}
|
||||
|
||||
export function updateImagePullSecrets(
|
||||
inputObject: any,
|
||||
newImagePullSecrets: string[],
|
||||
override: boolean = false
|
||||
) {
|
||||
if (!inputObject?.spec || !newImagePullSecrets) return;
|
||||
|
||||
const newImagePullSecretsObjects = Array.from(newImagePullSecrets, (name) => {
|
||||
return { name };
|
||||
});
|
||||
let existingImagePullSecretObjects: any = getImagePullSecrets(inputObject);
|
||||
|
||||
if (override) {
|
||||
existingImagePullSecretObjects = newImagePullSecretsObjects;
|
||||
} else {
|
||||
existingImagePullSecretObjects = existingImagePullSecretObjects || [];
|
||||
|
||||
existingImagePullSecretObjects = existingImagePullSecretObjects.concat(
|
||||
newImagePullSecretsObjects
|
||||
);
|
||||
}
|
||||
|
||||
setImagePullSecrets(inputObject, existingImagePullSecretObjects);
|
||||
}
|
||||
|
||||
export function updateSelectorLabels(
|
||||
inputObject: any,
|
||||
newLabels: Map<string, string>,
|
||||
override: boolean
|
||||
) {
|
||||
if (!inputObject) throw NullInputObjectError;
|
||||
|
||||
if (!inputObject.kind) throw InputObjectKindNotDefinedError;
|
||||
|
||||
if (!newLabels) return;
|
||||
|
||||
if (inputObject.kind.toLowerCase() === KubernetesWorkload.POD.toLowerCase())
|
||||
return;
|
||||
|
||||
let existingLabels = getSpecSelectorLabels(inputObject);
|
||||
if (override) {
|
||||
existingLabels = newLabels;
|
||||
} else {
|
||||
existingLabels = existingLabels || new Map<string, string>();
|
||||
Object.keys(newLabels).forEach(
|
||||
(key) => (existingLabels[key] = newLabels[key])
|
||||
);
|
||||
}
|
||||
|
||||
setSpecSelectorLabels(inputObject, existingLabels);
|
||||
}
|
||||
|
||||
export function getResources(
|
||||
filePaths: string[],
|
||||
filterResourceTypes: string[]
|
||||
): Resource[] {
|
||||
if (!filePaths) return [];
|
||||
|
||||
const resources: Resource[] = [];
|
||||
filePaths.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
yaml.safeLoadAll(fileContents, (inputObject) => {
|
||||
const inputObjectKind = inputObject?.kind || "";
|
||||
if (
|
||||
filterResourceTypes.filter(
|
||||
(type) => inputObjectKind.toLowerCase() === type.toLowerCase()
|
||||
).length > 0
|
||||
) {
|
||||
resources.push({
|
||||
type: inputObject.kind,
|
||||
name: inputObject.metadata.name,
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return resources;
|
||||
}
|
||||
|
||||
function updateImagePullSecretsInManifestFiles(
|
||||
filePaths: string[],
|
||||
imagePullSecrets: string[]
|
||||
): string[] {
|
||||
if (imagePullSecrets?.length <= 0) return filePaths;
|
||||
|
||||
const newObjectsList = [];
|
||||
filePaths.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath).toString();
|
||||
yaml.safeLoadAll(fileContents, (inputObject: any) => {
|
||||
if (inputObject?.kind) {
|
||||
const { kind } = inputObject;
|
||||
if (isWorkloadEntity(kind)) {
|
||||
updateImagePullSecrets(inputObject, imagePullSecrets);
|
||||
}
|
||||
newObjectsList.push(inputObject);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
return fileHelper.writeObjectsToFile(newObjectsList);
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
export function sleep(timeout: number) {
|
||||
return new Promise((resolve) => setTimeout(resolve, timeout))
|
||||
return new Promise((resolve) => setTimeout(resolve, timeout));
|
||||
}
|
||||
|
||||
export function getCurrentTime(): number {
|
||||
return new Date().getTime()
|
||||
return new Date().getTime();
|
||||
}
|
||||
|
||||
@@ -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(
|
||||
kubectl: Kubectl
|
||||
kubectl: Kubectl
|
||||
): Promise<string> {
|
||||
const result = await kubectl.executeCommand('api-versions')
|
||||
const trafficSplitAPIVersion = result.stdout
|
||||
.split('\n')
|
||||
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix))
|
||||
const result = await kubectl.executeCommand("api-versions");
|
||||
const trafficSplitAPIVersion = result.stdout
|
||||
.split("\n")
|
||||
.find((version) => version.startsWith(trafficSplitAPIVersionPrefix));
|
||||
|
||||
if (!trafficSplitAPIVersion) {
|
||||
throw new Error('Unable to find traffic split api version')
|
||||
}
|
||||
if (!trafficSplitAPIVersion) {
|
||||
throw new Error("Unable to find traffic split api version");
|
||||
}
|
||||
|
||||
return trafficSplitAPIVersion
|
||||
return trafficSplitAPIVersion;
|
||||
}
|
||||
|
||||
@@ -1,33 +1,18 @@
|
||||
import {
|
||||
cleanLabel,
|
||||
removeInvalidLabelCharacters,
|
||||
VALID_LABEL_REGEX
|
||||
} from '../utilities/workflowAnnotationUtils'
|
||||
import { prefixObjectKeys } from "../utilities/workflowAnnotationUtils";
|
||||
|
||||
describe('WorkflowAnnotationUtils', () => {
|
||||
describe('cleanLabel', () => {
|
||||
it('should clean label', () => {
|
||||
const alreadyClean = 'alreadyClean'
|
||||
expect(cleanLabel(alreadyClean)).toEqual(alreadyClean)
|
||||
expect(cleanLabel('.startInvalid')).toEqual('startInvalid')
|
||||
expect(cleanLabel('with%S0ME&invalid#chars')).toEqual(
|
||||
'withS0MEinvalidchars'
|
||||
)
|
||||
expect(cleanLabel('with⚒️emoji')).toEqual('withemoji')
|
||||
})
|
||||
it('should remove slashes from label', () => {
|
||||
expect(
|
||||
cleanLabel('Workflow Name / With Slashes / And Spaces')
|
||||
).toEqual('Workflow_Name_-_With_Slashes_-_And_Spaces')
|
||||
})
|
||||
it('should return a blank string when regex fails (https://github.com/Azure/k8s-deploy/issues/266)', () => {
|
||||
const label = '持续部署'
|
||||
expect(cleanLabel(label)).toEqual('github-workflow-file')
|
||||
|
||||
let removedInvalidChars = removeInvalidLabelCharacters(label)
|
||||
|
||||
const regexResult = VALID_LABEL_REGEX.exec(removedInvalidChars)
|
||||
expect(regexResult).toBe(null)
|
||||
})
|
||||
})
|
||||
})
|
||||
describe("WorkflowAnnotationUtils", () => {
|
||||
describe("prefixObjectKeys", () => {
|
||||
it("should prefix an object with a given prefix", () => {
|
||||
const obj = {
|
||||
foo: "bar",
|
||||
baz: "qux",
|
||||
};
|
||||
const prefix = "prefix.";
|
||||
const expected = {
|
||||
"prefix.foo": "bar",
|
||||
"prefix.baz": "qux",
|
||||
};
|
||||
expect(prefixObjectKeys(obj, prefix)).toEqual(expected);
|
||||
});
|
||||
});
|
||||
});
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user