Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@keptn/keptn-cp-ssp-addon

Package Overview
Dependencies
Maintainers
6
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@keptn/keptn-cp-ssp-addon

Keptn Control Plane Addon for AWS SSP CDK Platform

  • 0.3.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
6
Weekly downloads
 
Created
Source

Keptn Control Plane Add-On for the Amazon Shared Services Platform

main

The Keptn Add-On for the Amazon Shared Services Platform enables platform administrators to install a keptn Control Plane (by default in version 0.11.4) during the bootstrapping process of an EKS cluster.

Therefore, this Add-On installs the Keptn Helm Chart and configures Keptn to use an API-Token and Bridge Password with credentials specified by variables or a Amazon Secrets Manager Secret.

AWS Secret Manager Secrets

If you plan to use Secret Manager Secrets, you need to create a secret first.

Therefore:

  • Open your AWS Console
  • Search for "Secrets Manager"
  • Create a new secret ("Store a new secret")
    • Secret Type: "Other type of secret"
    • Key/value pairs
      • API_TOKEN=""
      • BRIDGE_PASSWORD=""
  • Remember the name you assigned to the secret

Usage

The Add-On can be used by either specifying the name of a Secrets Manager secret or the API Token and Bridge password.

You can find informations how to get started with SSP Projects here.

Example Configuration (secrets in Secrets Manager):

import 'source-map-support/register';
import * as cdk from '@aws-cdk/core'
import * as keptncp from '@keptn/keptn-cp-ssp-addon'
import * as ssp from '@aws-quickstart/ssp-amazon-eks'

const app = new cdk.App();

const KeptnControlPlane = new keptncp.KeptnControlPlaneAddOn({
    ssmSecretName: 'keptn-secrets'
})


const addOns: Array<ssp.ClusterAddOn> = [
    KeptnControlPlane,
];

const account = '<aws-account-id>';
const region = '<aws-region>';
const props = { env: { account, region } };
new ssp.EksBlueprint(app, { id: '<aws-eks-cluster-name>', addOns}, props);

Example Configuration (secrets in code):

import 'source-map-support/register';
import * as cdk from '@aws-cdk/core'
import * as keptncp from '@keptn/keptn-cp-ssp-addon'
import * as ssp from '@aws-quickstart/ssp-amazon-eks'

const app = new cdk.App();

const KeptnControlPlane = new keptncp.KeptnControlPlaneAddOn({
    apiToken: '<your-api-token>',
    bridgePassword: '<your-bridge-password>'
})


const addOns: Array<ssp.ClusterAddOn> = [
    KeptnControlPlane,
];

const account = '<aws-account-id>';
const region = '<aws-region>';
const props = { env: { account, region } };
new ssp.EksBlueprint(app, { id: '<aws-eks-cluster-name>', addOns}, props);

Add-On Options

NameTypeDefaultDescription
ssmSecretNamestringThe AWS Secrets Manager Secret which is containing the Keptn bridge password and API Token (keys: API_TOKEN, BRIDGE_PASSWORD)
apiTokenstringKeptn API Token is used to connect to the Keptn API, not needed if a ssmSecretName is specified
bridgePasswordstringKeptn Bridge Password is used to login to the Keptn bridge, not needed if a ssmSecretName is specified
namespacestringkeptnNamespace where the keptn Control Plane will be deployed
helmrepostringhttps://storage.googleapis.com/keptn-installerHelm Repository which will be used for installing Keptn
versionstring0.11.4The Version of Keptn which should get installed
enableLoadbalancerbooleanfalseExpose Keptn's Bridge and API Gateway service as type Loadbalancer instead of ClusterIP
enableIngressbooleanfalseCreate an Ingress object to Expose Keptn's Bridge and API Gateway
ingressHostnamestringThe Hostname for the Ingress object
ingressAnnotationsobjectAdd additional Ingress Annotations like the ingress class
ingressSecretNamestringConfigure an ingress secretName

Extended Examples

Example Configuration (create Ingress):

import 'source-map-support/register';
import * as cdk from '@aws-cdk/core'
import * as keptncp from '@keptn/keptn-cp-ssp-addon'
import * as ssp from '@aws-quickstart/ssp-amazon-eks'

const app = new cdk.App();

const KeptnControlPlane = new keptncp.KeptnControlPlaneAddOn({
    ssmSecretName: 'keptn-secrets',
    enableIngress: true,
    ingressHostname: 'mykeptn.yourdomain.com',
    ingressAnnotations: {
        "kubernetes.io/ingress.class": "nginx"
    },
    ingressSecretName: 'mytlssecret'
})


const addOns: Array<ssp.ClusterAddOn> = [
    KeptnControlPlane,
];

const account = '<aws-account-id>';
const region = '<aws-region>';
const props = { env: { account, region } };
new ssp.EksBlueprint(app, { id: '<aws-eks-cluster-name>', addOns}, props);

Example Configuration (expose Bridge via Loadbalancer):

import 'source-map-support/register';
import * as cdk from '@aws-cdk/core'
import * as keptncp from '@keptn/keptn-cp-ssp-addon'
import * as ssp from '@aws-quickstart/ssp-amazon-eks'

const app = new cdk.App();

const KeptnControlPlane = new keptncp.KeptnControlPlaneAddOn({
    ssmSecretName: 'keptn-secrets',
    enableLoadbalancer: true
})


const addOns: Array<ssp.ClusterAddOn> = [
    KeptnControlPlane,
];

const account = '<aws-account-id>';
const region = '<aws-region>';
const props = { env: { account, region } };
new ssp.EksBlueprint(app, { id: '<aws-eks-cluster-name>', addOns}, props);

Enhancements / Bugs

You are welcome to use issues to report bugs or request enhancements.

FAQs

Package last updated on 10 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc