From f661b9da8156028073d4848eb2f538755da3ce04 Mon Sep 17 00:00:00 2001 From: Andrei Vsiakikh Date: Fri, 10 May 2024 12:06:54 +1200 Subject: [PATCH] Readme update --- README.md | 21 +++++++++++++++++++++ cmd/runFargate.go | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 880db55..f12cddd 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,27 @@ So that `--cluster` can be set by `ECS_CLUSTER` environmental variable, or `--ta Also, `ecs-tool` exit code is the same as the container exit code. +### runFargate + +The runFargate function is a command that is integrated into the ecs-tool utility. This tool simplifies running commands on an AWS ECS (Elastic Container Service) cluster with Fargate. + +That normany use subnet with 'private' 'Tier' tag but if there is zero proivate subnets that will use 'public' + +``` +ecs-tool runFargate -e "preview" -- env +``` + +### EXEC + +ecs-tool exec Executes a specified command in a running container on an ECS Fargate cluster and get the output. +That function use existing container, so it's faster than runFargate +This command also could connect to fargate existing task: + +``` +ecs-tool exec -e "preview" /bin/sh +``` + + ### SSH 'SSH' access availabe to developers using `ecs-tool ssh` diff --git a/cmd/runFargate.go b/cmd/runFargate.go index b47fd18..36676ba 100644 --- a/cmd/runFargate.go +++ b/cmd/runFargate.go @@ -14,7 +14,7 @@ var runFargateCmd = &cobra.Command{ Short: "Runs a command in Fargate mode", Long: `Runs the specified command on an ECS cluster, optionally catching its output. -This command is specifically tailored for future Fargate-specific functionality but currently duplicates the 'run' command.`, +This command is specifically tailored for future Fargate-specific functionality.`, Args: cobra.MinimumNArgs(1), Run: func(cmd *cobra.Command, args []string) { viper.SetDefault("run.launch_type", "FARGATE")