Aws-sleek-transformer NPM

Addons Transformer CLI for Amazon EKS

Introduction

Sleek Marketplace validator is solution provide pre-launch validations of the partner software on compatibility with Sleek guidelines, covering static and dynamic (deployment/runtime) aspects.

Pre-requisites

To implement this solution, you need the following prerequisites:

The AWS Command Line Interface (AWS CLI) installed. The AWS CLI is a unified tool to manage your AWS services.
AWS CLI default profile should be configured to access your AWS Account.
Node version 18.12.1 or later.
NPM version 8.19.2 or later.
Helm CLI to interact with helm charts.

Features

This npm module does the following features:

Helm chart validation

It grabs the following form the command line parameters or an input file the chart URL, pull it and performs static validations:

Finding occurrences of unsupported .Capabilities
Templates creating helm.sh/hook
Use of .Release.Service
Use of helm lookup function (TODO)
Dependencies external to the main chart
Errors running helm lint see lint command bellow )
Errors running helm template... (see template command bellow )

If the chart is not in a public registry, login on it in advance is necessary, for example, for login on ECR:

export AWS_ACCOUNT=<Registry account> 
export AWS_REGION=<Registry region>
export CHART_NAME=<Helm chart name>
export ECR_HELM_REPOSITORY=${AWS_ACCOUNT}.dkr.ecr.${AWS_REGION}.amazonaws.com/${CHART_NAME}
aws ecr get-login-password --region  eu-west-1 | helm registry login --username AWS --password-stdin ${ECR_HELM_REPOSITORY%%/*}

Helm lint command

helm lint --strict --with-subcharts $CHART_LOCATION

Helm template command

helm template $CHART_NAME $CHART_LOCATION
 --set k8version=$KUBERNETES_VERSION
 --kube-version $KUBERNETES_VERSION
 --namespace $ADDON_NAMESPACE
 --include-crds
 --no-hooks

Request submission for onboarding the add-on to the program

It creates a GitHub issue in the onboarding repository for starting the process. As input, it takes the path to a yaml template that should contain the vendor, product and the add-on required information. The json-schema for its creation can be found in this repo schema and an example in the doc/examples directory.

For validation the template, it supports the flag --dry-run that prevents the issue creation.

As it will run locally aws-sleek-transformer validate passing the file as input, it needs to be able to download the chart.

Installation

$ npm install -g aws-sleek-transformer
$ aws-sleek-transformer COMMAND
running command...
$ aws-sleek-transformer (--version)
aws-sleek-transformer/0.0.3 darwin-arm64 node-v20.8.0
$ aws-sleek-transformer --help [COMMAND]
USAGE
  $ aws-sleek-transformer COMMAND
...

Commands

`aws-sleek-transformer create-issue FILE`

Creates a Github Issue based in the input file

USAGE
  $ aws-sleek-transformer create-issue FILE [-d] [--file <value>]

ARGUMENTS
  FILE  Path to add-on input file

FLAGS
  -d, --dryRun        Runs all checks without creating the issue
      --file=<value>  Path to add-on input file

DESCRIPTION
  Creates a Github Issue based in the input file


  This creates a Github Issue on the Sleek repository.

  It will validate the input file to match the schema


EXAMPLES
  $ aws-sleek-transformer create-issue filename

See code: src/commands/create-issue.ts

`aws-sleek-transformer submit`

Submit the addon to the AWS marketplace

USAGE
  $ aws-sleek-transformer submit

DESCRIPTION
  Submit the addon to the AWS marketplace


  Sends the selected addon, version to the marketplace for final submission and upload it to Project Sleek.

  It reads from the addons stored in the config: ~/.sleek/config.json and presents them as options to the user to
  submit.

  The CLI requires the configure command to be run before hand to ensure there are correct configurations for each of
  the addons.

  This command requires the following:
  * Addon Name - as used in the configure command
  * Addon Version - as used in the configure command

  If no flags are provided, the CLI will launch an interactive menu which let's you select which addon to submit to
  the marketplace.


EXAMPLES
  $ aws-sleek-transformer submit

See code: src/commands/submit.ts

`aws-sleek-transformer validate [HELMURL]`

Validates the addon after pulling it from the helm repository.

USAGE
  $ aws-sleek-transformer validate [HELMURL] [-r <value> | [-f <value> | --helmUrl <value>] | ] [-p <value> | 
    | ] [-v <value> | ] [--addonName <value>] [-n <value>] [--k8sVersions <value>] [--skipHooks] [--skipReleaseService]

ARGUMENTS
  HELMURL  Fully qualified Helm URL of the addon

FLAGS
  -f, --file=<value>            Path to add-on input file
  -n, --addonNamespace=<value>  Add-on namespace
  -p, --protocol=<value>        Protocol of the helm hosting to use
  -r, --helmRepo=<value>        Helm repo of the addon
  -v, --version=<value>         Version of the addon to validate
      --addonName=<value>       Name of the addon
      --helmUrl=<value>         Fully qualified URL of the Repo
      --k8sVersions=<value>     Comma separated list of supported kubernetes versions
      --skipHooks               Skip helm hooks validation
      --skipReleaseService      Skip .Release.Service occurrences

DESCRIPTION
  Validates the addon after pulling it from the helm repository.


  This performs pre-launch validations of the partner software on compatibility with Sleek guidelines, covering static
  and dynamic (deployment/runtime) aspects.

  Runs the static analysis to find occurrences of:
  * .Capabilities
  * helm.sh/hook
  * external helm dependencies

  It will perform a static validation on the device and then give you the option to submit it to the marketplace for
  runtime and further validation before it can be included in the EKS Console marketplace.

  The command can accept two different formats of inputs:
  * Fully qualified Helm URL to download
  * Deconstructed URL that requires Protocol, Repo, and Version to pull


EXAMPLES
  $ aws-sleek-transformer validate

See code: src/commands/validate.ts

create-issue

aws-sleek-transformer create-issue FILE

Creates a Github Issue based in the input file

USAGE
  $ aws-sleek-transformer create-issue FILE [-d] [--file <value>]

ARGUMENTS
  FILE  Path to add-on input file

FLAGS
  -d, --dryRun        Runs all checks without creating the issue
      --file=<value>  Path to add-on input file

DESCRIPTION
  Creates a Github Issue based in the input file


  This creates a Github Issue on the Sleek repository.

  It will validate the input file to match the schema


EXAMPLES
  $ aws-sleek-transformer create-issue filename

See code: src/commands/create-issue.ts

oclif

@aws-sdk/client-sts @inquirer/prompts @inquirer/select @oclif/core @oclif/plugin-help @octokit/core @types/ajv @types/js-yaml ajv js-yaml json-schema oclif shx

3 months ago

3 months ago

4 months ago

5 months ago