flow

README

Flow AWS tooling

Flow is a CLI tooling that helps developing applications on AWS. Is meant to be used only in dev environments and not in production.

NOTE: Flow CLI is under development, and may occasionally make backwards-incompatible changes.

Installation

• homebrew

  brew install flow-lab/tap/flow
  

• latest version from github releases

  curl --fail https://raw.githubusercontent.com/flow-lab/flow/master/bin/get-flow.sh --output get-flow.sh
  chmod +x get-flow.sh
  ./get-flow.sh
  

example usage:

dynamodb

• delete all items from DynamoDB "TestTable" (using scan operation)

  flow dynamodb delete --table-name TestTable

• delete all items from DynamoDB "TestTable" with amount > 100

  flow dynamodb delete --table-name TestTable --filter-expression "amount > :amount" --expression-attribute-values '{":amount":{"N":"100"}}'

• change table capacity for Provisioned capacity mode

  flow dynamodb capacity --table-name TestTable --write 10 --read 10

• describe table

  flow dynamodb describe-table --table-name test

• put item(s) from file

  flow dynamodb put-item --input input.json --table-name TestTable

  where, file input.json contains a list of json objects in dynamodb item format:

  [
      {
        "id": {
          "S": "1"
        },
        "val": {
          "S": "1"
        }
      }
  ]
  

• delete item(s) from file

  flow dynamodb delete-item --input input.json --table-name TestTable

  where, file input.json contains a list of json objects in dynamodb item format:

  [
      {
        "id": {
          "S": "1"
        },
        "val": {
          "S": "1"
        }
      }
  ]
  

• count items using scan operation

  flow dynamodb count-item --table-name TestTable

s3

• purge all items and its versions from the bucket, items with delete markers will also be removed

  flow s3 purge --bucket-name "test-bucket"

ssm

• export all ssm parameters and their values to json file

  flow ssm export

sqs

• send message to the queue

  flow sqs send --queue-name apud --input '{"id":"1","status":"ACTIVE"}' --message-attributes '{"eventType":{"DataType":"String","StringValue":"STATUS_UPDATED"}}'

• receive message from the queue

  flow sqs receive-message --queue-name apud

• purge all messages

  flow sqs purge --queue-name apud

• delete message

  flow sqs delete-message --queue-name test --receipt-handle "31451c88-bd89-4d75-b3dc-252d2ab583d1" --receipt-handle "AQEB5Ox73VW9r+893F2ET+Nuw20ASW2tDol3eQgiptmDUDb2Ombya1amTXco5vuhoSmxnCxY6cpeUJMrzjW2IjBoPTLI/5Fp4QP8GTnYpcqTSWIMYc9eZ/UELmJ5IIfiDjr3eCeJmdU96CiYQ8PaeA+r3x5zJkVmmOGsw1v/OUK+iVJiyrPWBRQaBjuawh34iS4h51NO8Nweu4Ctnf7q18c7dfRWzdljWPAHB7OKAzYYBSU6Q9pxaTFK7sgoC0DJIGswMDYA3yVW7zsDhOWHm4bRWnW8pGbltDSnhpihL2OisaNQn+EL0R0iYFKXF14PRpEaeG8MlkBndz76nf8tlDYvBbtFL9xubmQFJYGrZ5OHorEs4mnuZbmgftTOuejnlLBt"

• describe sqs queue

  flow sqs describe --queue-name apud

apigateway

• exports all API specifications in swagger or oas3 specification and saves to file(s)

  flow apigateway export

kafka (MSK) - Amazon Managed Streaming for Apache Kafka

• list MSK clusters in the account

  flow kafka list-clusters

• describe MSK cluster

  flow kafka describe-cluster --cluster-name "MSK-Dev"

• get bootstrap brokers

  flow kafka get-bootstrap-brokers --cluster-name "MSK-Dev"

• send message to topic

  flow kafka send --cluster-name "MSK-Dev" --topic "topic-name" --message "test"

• pipe messages from source to destination topic

  flow kafka pipe --sbb localhost:9092 --st src-topic --dbb localhost:9092 --dt dst-topic

• create topic

  flow kafka create-topic --cluster-name "MSK-Dev" --topic "topic-name" --num-partitions 1 --replication-factor 1 --retention-ms "-1"

• delete topic

  flow kafka delete-topic --cluster-name "MSK-Dev" --topic "topic-name"

• describe topic

  flow kafka describe-topic --cluster-name "MSK-Dev" --topic "topic-name-0" --topic "topic-name-1"

sts

• assume my-role in 111111111111 account and generate intellij friendly env variables

  flow sts assume-role --role-arn "arn:aws:iam::111111111111:role/service-role/my-role" --serial-number "arn:aws:iam::123456789:mfa/terraform" --token-code "123456" output:

  AWS_REGION=eu-west-1
  AWS_ACCESS_KEY_ID=A..B
  AWS_SECRET_ACCESS_KEY=1..F
  AWS_SESSION_TOKEN=F..g
  

• get session token

  flow sts get-session-token --serial-number "arn:aws:iam::123456789:mfa/terraform" --token-code "123456" output:

  AWS_REGION=eu-west-1
  AWS_ACCESS_KEY_ID=A..B
  AWS_SECRET_ACCESS_KEY=1..F
  AWS_SESSION_TOKEN=F..g
  

• unset envs

  flow sts clean output:

  unset AWS_REGION
  unset AWS_ACCESS_KEY_ID
  unset AWS_SECRET_ACCESS_KEY
  unset AWS_SESSION_TOKEN
  

cloudtrail

• find all cloud trail events containing "unauthorized" or "forbidden" between 2020-03-12T17:00:00Z and 2020-03-12T20:00:00Z

  flow cloudtrail find --contains "unauthorized" --contains "forbidden" --start-time="2020-03-12T17:00:00Z" --end-time="2020-03-12T20:00:00Z"

kubernetes eks

• open EKS Kubernetes dashboard and start kubectl proxy

  flow eks dashboard --cluster cluster-0 output:

  token: e..g
  
  running command: /usr/local/bin/aws eks update-kubeconfig --name cluster-0
  running command: /usr/local/bin/kubectl proxy
  open in browser(use token from above):  http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/#!/login
  

pubsub

This commands are designed to use with Flow Pub/Sub emulator running on Kubernetes.

• create topic

  flow pubsub create-topic -t user

• create subscription

  flow pubsub create-subscription -t user --sub user

• publish file content with attributes

  cat message.json | flow pubsub publish -t user -attr "{\"event-type\":\"user-created\"}"

base64

• encode base64

  flow base64 encode --input "hello"

• encode base64 file

  flow base64 encode --file input.json

• decode base64

  flow base64 decode --input "aGVsbG8="

test

• load test http endpoint that runs for 180 seconds with 100 requests per second and will hit 2 urls

  flow test http \
   --url "https://test1.com \
   --url "https://test2.com \
   --frequency 100 \
   --duration "180s" \
   --authorization "Bearer TOKEN"
  

github

• get tag for GitHub SHA

  flow github get-tag --owner flow-lab --repo auxospore --sha d3d8a8803f6ecb4b091667ba61b9945da7af3cf2
  

help:

NAME:
   Flow - Development CLI

USAGE:
   flow [global options] command [command options] [arguments...]

VERSION:
   dev

DESCRIPTION:
   flow cli. Commit none, build at unknown

AUTHOR:
   Krzysztof Grodzicki <krzysztof@flowlab.no>

COMMANDS:
   dynamodb        AWS DynamoDB
   sqs             AWS SQS
   sns             AWS SNS
   cloudwatch      AWS CloudWatch
   cloudwatchlogs  AWS CloudWatch Logs
   ssm             AWS SSM
   secretsmanager  AWS SecretsManager
   kinesis         AWS Kinesis
   base64          encoding/decoding base64
   s3              AWS S3
   apigateway      AWS API Gateway
   test            HTTP load testing commands
   kafka           AWS MSK
   sts             AWS STS
   pubsub          GCP Pub/Sub for testing locally with emulator
   help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)

or

flow dynamodb --help
NAME:
   development tooling for AWS dynamodb -

USAGE:
   development tooling for AWS dynamodb command [command options] [arguments...]

COMMANDS:
     purge     fast purge dynamodb using scan operation
     capacity  update read and write capacity

OPTIONS:
   --help, -h  show help

authentication

AWS

Flow will be configured and will authenticate using the same methods defined by aws-cli.

Currently, it supports authentication with:

• A EnvProvider which retrieves credentials from the environment variables of the running process. Environment credentials never expire. Environment variables used:

  • Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY

  • Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY

• A SharedCredentialsProvider which retrieves credentials from the current user's home directory, and keeps track if those credentials are expired.

  Profile ini file example: $HOME/.aws/credentials

• A AssumeRoleTokenProvider with enabled SharedConfigState which uses MFA prompting for token code on stdin. Go to session doc for more details.

GCP

For Google Cloud Platform (GCP) commands set the PUBSUB_EMULATOR_HOST environment variable. Set also the PUBSUB_PROJECT_ID environment variable for the project you want to use for the emulator. For example:

export PUBSUB_EMULATOR_HOST=localhost:8432
export PUBSUB_PROJECT_ID=my-project-id