Flagger addon #440
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| ## Flagger Add-On | ||
|
|
||
| [Flagger](https://flagger.app/) is a progressive delivery tool that automates the release process for applications running on Kubernetes. It reduces the risk of introducing a new software version in production by gradually shifting traffic to the new version while measuring metrics and running conformance tests. The Flagger add-on provisions the necessary Helm chart, and namespace to allow support for flagger in an EKS workload. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import 'source-map-support/register'; | ||
| import * as cdk from 'aws-cdk-lib'; | ||
| import * as blueprints from '@aws-quickstart/eks-blueprints'; | ||
|
|
||
| const app = new cdk.App(); | ||
|
|
||
| const addOn = new blueprints.addons.Flagger(); | ||
|
|
||
| const blueprint = blueprints.EksBlueprint.builder() | ||
| .addOns(addOn) | ||
| .build(app, 'my-stack-name'); | ||
| ``` | ||
|
|
||
| ## Functionality | ||
|
|
||
| 1. Creates the `flagger` namespace. This parameter is optional and may be provided by the user in the namespace field of your addon props. | ||
| 2. Deploys the `flagger` Helm chart into the cluster. | ||
| 3. Supports [standard helm configuration options](./index.md#standard-helm-add-on-configuration-options) | ||
|
|
||
| ## Configuration Options | ||
|
|
||
| - `prometheus`: Pass true or false if you wish to track deployment metrics via prometheus. `True by default`. | ||
| - `meshProvider`: Pass from the following enum list of meshProviderOptions. `KUBERNETES by default`. | ||
|
|
||
| ```typescript | ||
| export const enum MeshProviderOptions { | ||
| KUBERNETES = 'kubernetes', | ||
| ISTIO = 'istio', | ||
| LINKERD = 'linkerd', | ||
| APPMESH = 'appmesh', | ||
| CONTOUR = 'contour', | ||
| NGINX = 'nginx', | ||
| GLOO = 'gloo', | ||
| SKIPPER = 'skipper', | ||
| TRAEFIK = 'traefik', | ||
| OSM = 'osm' | ||
| } | ||
| ``` | ||
|
|
||
| - Example Configuration: | ||
|
|
||
| ```typescript | ||
| import * as blueprints from '@aws-quickstart/eks-blueprints'; | ||
|
|
||
| const flagger = new blueprints.addons.FlaggerAddOn(); | ||
| `` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| import { HelmAddOn, HelmAddOnUserProps, HelmAddOnProps } from "../helm-addon"; | ||
| import { Construct } from 'constructs'; | ||
| import { Values, ClusterInfo } from "../../spi"; | ||
| import merge from "ts-deepmerge"; | ||
|
|
||
| /** | ||
shapirov103 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * User provided options for the FlaggerAddonProps values. | ||
| */ | ||
| export interface FlaggerAddOnProps extends HelmAddOnUserProps { | ||
|
|
||
| /** | ||
| * Controls if prometheus is installed with the addon or not. | ||
| * default: true | ||
| */ | ||
| installPrometheus?: boolean; | ||
| /** | ||
| * Controls what mesh provider from MeshProviderOptions enums list is used. | ||
| * default: MeshProviderOptions.KUBERNETES | ||
| */ | ||
| meshProvider?: MeshProviderOptions; | ||
| } | ||
|
|
||
| /** | ||
shapirov103 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * All the meshProvider values that can be chosen by the user. | ||
| */ | ||
| export const enum MeshProviderOptions { | ||
|
|
||
| KUBERNETES = 'kubernetes', | ||
| ISTIO = 'istio', | ||
| LINKERD = 'linkerd', | ||
| APPMESH = 'appmesh', | ||
| CONTOUR = 'contour', | ||
| NGINX = 'nginx', | ||
| GLOO = 'gloo', | ||
| SKIPPER = 'skipper', | ||
| TRAEFIK = 'traefik', | ||
| OSM = 'osm' | ||
| } | ||
|
|
||
| /** | ||
shapirov103 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * defaultProps makes the flagger namespace and chart. | ||
| */ | ||
| export const defaultProps: HelmAddOnProps & FlaggerAddOnProps = { | ||
|
|
||
| name: "flagger", | ||
| namespace: "flagger", | ||
| chart: "flagger", | ||
| version: "1.22.0", | ||
| release: "flagger", | ||
| repository: "https://flagger.app", | ||
| values: { | ||
| prometheus: { | ||
| install: true | ||
| }, | ||
| meshProvider: MeshProviderOptions.KUBERNETES | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * This creates and deploys a cluster with the FlaggerAddOnProps values for flagger settings with preset values unless the user specifies their own values. | ||
| */ | ||
| export class FlaggerAddOn extends HelmAddOn { | ||
|
|
||
| readonly options: FlaggerAddOnProps; | ||
|
There was a problem hiding this comment. line break here. |
||
|
|
||
| constructor(props?: FlaggerAddOnProps) { | ||
|
|
||
|
|
||
| super({ ...defaultProps, ...props }); | ||
| this.options = this.props as FlaggerAddOnProps; | ||
| } | ||
|
|
||
| deploy(clusterInfo: ClusterInfo): Promise<Construct> { | ||
|
|
||
|
|
||
| let values: Values = { | ||
| prometheus: { | ||
| install: this.options.installPrometheus ?? defaultProps.installPrometheus | ||
| }, | ||
| meshProvider: this.options.meshProvider ?? defaultProps.meshProvider | ||
| }; | ||
|
|
||
| values = merge(values, this.props.values ?? {}); | ||
| const chart = this.addHelmChart(clusterInfo, values); | ||
|
|
||
| return Promise.resolve(chart); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you want to describe supported configuration options?