mirror of
https://github.com/Azure/k8s-deploy.git
synced 2026-07-02 19:09:28 +08:00
added blue green strategy (#47)
* added blue green strategy * Addressed review comments * addressed pr comments * updated names in test * addressed final pr comments
This commit is contained in:
Sundar
@@ -0,0 +1,329 @@
|
||||
'use strict';
|
||||
|
||||
import * as core from '@actions/core';
|
||||
import * as fs from 'fs';
|
||||
import * as yaml from 'js-yaml';
|
||||
import { checkForErrors, sleep } from '../utility';
|
||||
import { Kubectl } from '../../kubectl-object-model';
|
||||
import { KubernetesWorkload } from '../../constants';
|
||||
import * as fileHelper from '../files-helper';
|
||||
import * as helper from '../resource-object-utility';
|
||||
import * as TaskInputParameters from '../../input-parameters';
|
||||
import { routeBlueGreenService } from './service-blue-green-helper';
|
||||
import { routeBlueGreenIngress } from './ingress-blue-green-helper';
|
||||
import { routeBlueGreenSMI } from './smi-blue-green-helper';
|
||||
|
||||
export const BLUE_GREEN_DEPLOYMENT_STRATEGY = 'BLUE-GREEN';
|
||||
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'
|
||||
const INGRESS_ROUTE = 'INGRESS';
|
||||
const SMI_ROUTE = 'SMI';
|
||||
|
||||
export function isBlueGreenDeploymentStrategy() {
|
||||
const deploymentStrategy = TaskInputParameters.deploymentStrategy;
|
||||
return deploymentStrategy && deploymentStrategy.toUpperCase() === BLUE_GREEN_DEPLOYMENT_STRATEGY;
|
||||
}
|
||||
|
||||
export function isIngressRoute(): boolean {
|
||||
const routeMethod = TaskInputParameters.routeMethod;
|
||||
return routeMethod && routeMethod.toUpperCase() === INGRESS_ROUTE;
|
||||
}
|
||||
|
||||
export function isSMIRoute(): boolean {
|
||||
const routeMethod = TaskInputParameters.routeMethod;
|
||||
return routeMethod && routeMethod.toUpperCase() === SMI_ROUTE;
|
||||
}
|
||||
|
||||
export async function routeBlueGreen(kubectl: Kubectl, inputManifestFiles: string[]) {
|
||||
// get buffer time
|
||||
let bufferTime: number = parseInt(TaskInputParameters.versionSwitchBuffer);
|
||||
|
||||
//logging start of buffer time
|
||||
let dateNow = new Date();
|
||||
console.log('starting buffer time of '+bufferTime+' minute/s at '+dateNow.toISOString()+' UTC');
|
||||
// waiting
|
||||
await sleep(bufferTime*1000*60);
|
||||
// logging end of buffer time
|
||||
dateNow = new Date();
|
||||
console.log('stopping buffer time of '+bufferTime+' minute/s at '+dateNow.toISOString()+' UTC');
|
||||
|
||||
const manifestObjects = getManifestObjects(inputManifestFiles);
|
||||
// routing to new deployments
|
||||
if (isIngressRoute()) {
|
||||
routeBlueGreenIngress(kubectl, GREEN_LABEL_VALUE, manifestObjects.serviceNameMap, manifestObjects.serviceEntityList, manifestObjects.ingressEntityList);
|
||||
} else if (isSMIRoute()) {
|
||||
routeBlueGreenSMI(kubectl, GREEN_LABEL_VALUE, manifestObjects.deploymentEntityList, manifestObjects.serviceEntityList);
|
||||
} else {
|
||||
routeBlueGreenService(kubectl, GREEN_LABEL_VALUE, manifestObjects.deploymentEntityList, manifestObjects.serviceEntityList);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
export function deleteWorkloadsWithLabel(kubectl: Kubectl, deleteLabel: string, deploymentEntityList: any[]) {
|
||||
let resourcesToDelete = []
|
||||
deploymentEntityList.forEach((inputObject) => {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
if (deleteLabel === NONE_LABEL_VALUE) {
|
||||
// if dellabel is none, deletes stable deployments
|
||||
const resourceToDelete = { name : name, kind : kind};
|
||||
resourcesToDelete.push(resourceToDelete);
|
||||
} else {
|
||||
// if dellabel is not none, then deletes new green deployments
|
||||
const resourceToDelete = { name : getBlueGreenResourceName(name, GREEN_SUFFIX), kind : kind };
|
||||
resourcesToDelete.push(resourceToDelete);
|
||||
}
|
||||
});
|
||||
|
||||
// deletes the deployments
|
||||
deleteObjects(kubectl, resourcesToDelete);
|
||||
}
|
||||
|
||||
export function cleanUp(kubectl: Kubectl, deploymentEntityList: any[], serviceEntityList: any[]) {
|
||||
// checks if services has some stable deployments to target or deletes them too
|
||||
let deleteList = [];
|
||||
deploymentEntityList.forEach((deploymentObject) => {
|
||||
const existingDeploy = fetchResource(kubectl, deploymentObject.kind, deploymentObject.metadata.name);
|
||||
if (!existingDeploy) {
|
||||
serviceEntityList.forEach((serviceObject) => {
|
||||
const serviceSelector: string = getServiceSelector(serviceObject);
|
||||
const matchLabels: string = getDeploymentMatchLabels(deploymentObject);
|
||||
if (!!serviceSelector && !!matchLabels && isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)) {
|
||||
const resourceToDelete = { name : serviceObject.metadata.name, kind : serviceObject.kind };
|
||||
deleteList.push(resourceToDelete);
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// delete service not targeting a deployment
|
||||
deleteObjects(kubectl, deleteList);
|
||||
}
|
||||
|
||||
export function deleteWorkloadsAndServicesWithLabel(kubectl: Kubectl, deleteLabel: string, deploymentEntityList: any[], serviceEntityList: any[]) {
|
||||
// need to delete services and deployments
|
||||
const deletionEntitiesList = deploymentEntityList.concat(serviceEntityList);
|
||||
let resourcesToDelete = []
|
||||
deletionEntitiesList.forEach((inputObject) => {
|
||||
const name = inputObject.metadata.name;
|
||||
const kind = inputObject.kind;
|
||||
if (deleteLabel === NONE_LABEL_VALUE) {
|
||||
// if not dellabel, delete stable objects
|
||||
const resourceToDelete = { name : name, kind : kind};
|
||||
resourcesToDelete.push(resourceToDelete);
|
||||
} else {
|
||||
// else delete green labels
|
||||
const resourceToDelete = { name : getBlueGreenResourceName(name, GREEN_SUFFIX), kind : kind };
|
||||
resourcesToDelete.push(resourceToDelete);
|
||||
}
|
||||
});
|
||||
deleteObjects(kubectl, resourcesToDelete);
|
||||
}
|
||||
|
||||
export function deleteObjects(kubectl: Kubectl, deleteList: any[]) {
|
||||
// delete services and deployments
|
||||
deleteList.forEach((delObject) => {
|
||||
try {
|
||||
const result = kubectl.delete([delObject.kind, delObject.name]);
|
||||
checkForErrors([result]);
|
||||
} catch (ex) {
|
||||
// Ignore failures of delete if doesn't exist
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
export function getSuffix(label: string): string {
|
||||
if(label === GREEN_LABEL_VALUE) {
|
||||
return GREEN_SUFFIX
|
||||
} else {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
// other common functions
|
||||
export function getManifestObjects (filePaths: string[]): any {
|
||||
const deploymentEntityList = [];
|
||||
const serviceEntityList = [];
|
||||
const ingressEntityList = [];
|
||||
const otherEntitiesList = [];
|
||||
filePaths.forEach((filePath: string) => {
|
||||
const fileContents = fs.readFileSync(filePath);
|
||||
yaml.safeLoadAll(fileContents, function (inputObject) {
|
||||
if(!!inputObject) {
|
||||
const kind = inputObject.kind;
|
||||
if (helper.isDeploymentEntity(kind)) {
|
||||
deploymentEntityList.push(inputObject);
|
||||
} else if (helper.isServiceEntity(kind)) {
|
||||
serviceEntityList.push(inputObject);
|
||||
} else if (helper.isIngressEntity(kind)) {
|
||||
ingressEntityList.push(inputObject);
|
||||
} else {
|
||||
otherEntitiesList.push(inputObject);
|
||||
}
|
||||
}
|
||||
});
|
||||
})
|
||||
|
||||
let serviceNameMap = new Map<string, string>();
|
||||
// find all services and add their names with blue green suffix
|
||||
serviceEntityList.forEach(inputObject => {
|
||||
const name = inputObject.metadata.name;
|
||||
serviceNameMap.set(name, getBlueGreenResourceName(name, GREEN_SUFFIX));
|
||||
});
|
||||
|
||||
return { serviceEntityList: serviceEntityList, serviceNameMap: serviceNameMap, deploymentEntityList: deploymentEntityList, ingressEntityList: ingressEntityList, otherObjects: otherEntitiesList };
|
||||
}
|
||||
|
||||
export function isServiceRouted(serviceObject: any[], deploymentEntityList: any[]): boolean {
|
||||
let shouldBeRouted: boolean = false;
|
||||
const serviceSelector: string = getServiceSelector(serviceObject);
|
||||
if (!!serviceSelector) {
|
||||
deploymentEntityList.every((depObject) => {
|
||||
// finding if there is a deployment in the given manifests the service targets
|
||||
const matchLabels: string = getDeploymentMatchLabels(depObject);
|
||||
if (!!matchLabels && isServiceSelectorSubsetOfMatchLabel(serviceSelector, matchLabels)) {
|
||||
shouldBeRouted = true;
|
||||
return false;
|
||||
}
|
||||
});
|
||||
}
|
||||
return shouldBeRouted;
|
||||
}
|
||||
|
||||
export 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);
|
||||
});
|
||||
const manifestFiles = fileHelper.writeObjectsToFile(newObjectsList);
|
||||
const result = kubectl.apply(manifestFiles);
|
||||
|
||||
return { 'result': result, 'newFilePaths': manifestFiles };
|
||||
}
|
||||
|
||||
export function getNewBlueGreenObject(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);
|
||||
}
|
||||
|
||||
// Adding labels and annotations
|
||||
addBlueGreenLabelsAndAnnotations(newObject, labelValue);
|
||||
|
||||
return newObject;
|
||||
}
|
||||
|
||||
export function addBlueGreenLabelsAndAnnotations(inputObject: any, labelValue: string) {
|
||||
//creating the k8s.deploy.color label
|
||||
const newLabels = new Map<string, string>();
|
||||
newLabels[BLUE_GREEN_VERSION_LABEL] = labelValue;
|
||||
|
||||
// updating object labels and selector labels
|
||||
helper.updateObjectLabels(inputObject, newLabels, false);
|
||||
helper.updateSelectorLabels(inputObject, newLabels, false);
|
||||
|
||||
// updating spec labels if it is a service
|
||||
if (!helper.isServiceEntity(inputObject.kind)) {
|
||||
helper.updateSpecLabels(inputObject, newLabels, false);
|
||||
}
|
||||
}
|
||||
|
||||
export function getBlueGreenResourceName(name: string, suffix: string) {
|
||||
return `${name}${suffix}`;
|
||||
}
|
||||
|
||||
export function getSpecLabel(inputObject: any): string {
|
||||
if(!!inputObject && inputObject.spec && inputObject.spec.selector && inputObject.spec.selector.matchLabels && inputObject.spec.selector.matchLabels[BLUE_GREEN_VERSION_LABEL]) {
|
||||
return inputObject.spec.selector.matchLabels[BLUE_GREEN_VERSION_LABEL];
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
export function getDeploymentMatchLabels(deploymentObject: any): string {
|
||||
if (!!deploymentObject && deploymentObject.kind.toUpperCase()==KubernetesWorkload.pod.toUpperCase() && !!deploymentObject.metadata && !!deploymentObject.metadata.labels) {
|
||||
return JSON.stringify(deploymentObject.metadata.labels);
|
||||
} else if (!!deploymentObject && deploymentObject.spec && deploymentObject.spec.selector && deploymentObject.spec.selector.matchLabels) {
|
||||
return JSON.stringify(deploymentObject.spec.selector.matchLabels);
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
export function getServiceSelector(serviceObject: any): string {
|
||||
if (!!serviceObject && serviceObject.spec && serviceObject.spec.selector) {
|
||||
return JSON.stringify(serviceObject.spec.selector);
|
||||
} else return '';
|
||||
}
|
||||
|
||||
export function isServiceSelectorSubsetOfMatchLabel(serviceSelector: string, matchLabels: string): boolean {
|
||||
let serviceSelectorMap = new Map();
|
||||
let matchLabelsMap = new Map();
|
||||
|
||||
JSON.parse(serviceSelector, (key, value) => {
|
||||
serviceSelectorMap.set(key, value);
|
||||
});
|
||||
JSON.parse(matchLabels, (key, value) => {
|
||||
matchLabelsMap.set(key, value);
|
||||
});
|
||||
|
||||
let isMatch = true;
|
||||
serviceSelectorMap.forEach((value, key) => {
|
||||
if (!!key && (!matchLabelsMap.has(key) || matchLabelsMap.get(key)) != value) {
|
||||
isMatch = false;
|
||||
}
|
||||
});
|
||||
|
||||
return isMatch;
|
||||
}
|
||||
|
||||
export function fetchResource(kubectl: Kubectl, kind: string, name: string) {
|
||||
const result = kubectl.getResource(kind, name);
|
||||
if (result == null || !!result.stderr) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!!result.stdout) {
|
||||
const resource = JSON.parse(result.stdout);
|
||||
try {
|
||||
UnsetsClusterSpecficDetails(resource);
|
||||
return resource;
|
||||
} catch (ex) {
|
||||
core.debug('Exception occurred while Parsing ' + resource + ' in Json object');
|
||||
core.debug(`Exception:${ex}`);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function UnsetsClusterSpecficDetails(resource: any) {
|
||||
if (resource == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Unsets the cluster specific details in the object
|
||||
if (!!resource) {
|
||||
const metadata = resource.metadata;
|
||||
const status = resource.status;
|
||||
|
||||
if (!!metadata) {
|
||||
const newMetadata = {
|
||||
'annotations': metadata.annotations,
|
||||
'labels': metadata.labels,
|
||||
'name': metadata.name
|
||||
};
|
||||
|
||||
resource.metadata = newMetadata;
|
||||
}
|
||||
|
||||
if (!!status) {
|
||||
resource.status = {};
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user