Giters

aws / aws-cdk-rfcs

RFCs for the AWS CDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CDK Operator CLI

Chriscbr opened this issue · comments

commented

Description

A command line tool that allows CDK builders and operators to run commands associated with L2 and L3 constructs from their terminal. This extends the "abstraction" provided by constructs to the space of command line tools.

For example, when you created a CDK construct named "MyBucket" and deployed it to your account, instead of running:

aws s3api get-object --bucket mybucketf68f3ff0-abcdefg --key file.txt

... you could instead run:

cdk-app MyBucket get-object file.txt

Each construct type would be associated with a list of commands, which could have different parameters etc.

Possible features:

  • simple syntax for specifying command arguments and flags
  • option for commands to invoke bash scripts
  • option for commands to execute SSM runbooks
  • commands that allow you to view AWS CDK resources directly in AWS console (opens your browser)
  • commands for user-made constructs
  • convenient "help" screens
  • command that helps you discover vailable constructs, or that lets you view into the construct tree interactively
  • choose constructs by tag or by metadata instead of by name
  • run commands on multiple constructs?
  • interface / extension points allowing the tool used for other CDKs such as cdk8s and cdktf

Roles

Role User
Proposed by @Chriscbr
Author(s) @alias, @alias, @alias
API Bar Raiser @alias
Stakeholders @alias, @alias, @alias

See RFC Process for details

Workflow

  • Tracking issue created (label: status/proposed)
  • API bar raiser assigned (ping us at #aws-cdk-rfcs if needed)
  • Kick off meeting
  • RFC pull request submitted (label: status/review)
  • Community reach out (via Slack and/or Twitter)
  • API signed-off (label api-approved applied to pull request)
  • Final comments period (label: status/final-comments-period)
  • Approved and merged (label: status/approved)
  • Execution plan submitted (label: status/planning)
  • Plan approved and merged (label: status/implementing)
  • Implementation complete (label: status/done)

Author is responsible to progress the RFC according to this checklist, and
apply the relevant labels to this issue so that the RFC table in README gets
updated.