Skip to content

chore: disable --use-task-role by default #5602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Jan 10, 2024
Merged

chore: disable --use-task-role by default #5602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions internal/pkg/cli/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,16 @@ func (e *errTaskRoleRetrievalFailed) Error() string {
}

func (e *errTaskRoleRetrievalFailed) RecommendActions() string {
return fmt.Sprintf(`TaskRole retrieval failed. If your containers don't require the TaskRole for local testing, you can use %s to disable this feature.
If you require the TaskRole, you can manually add permissions for your account to assume TaskRole by adding the following YAML override to your service:
return fmt.Sprintf(`TaskRole retrieval failed. If you require the TaskRole, you can try these methods to enable it:
1. Enable exec in the service manifest:
%s
For more information on YAML overrides see %s`,
color.HighlightCode(`copilot run local --use-task-role=false`),

2. Add permissions for your account to assume TaskRole by adding the following YAML override to your service:
%s

For more information on YAML overrides see %s
`,
color.HighlightCodeBlock(`exec: true # Enable running commands in your container.`),
color.HighlightCodeBlock(`- op: add
path: /Resources/TaskRole/Properties/AssumeRolePolicyDocument/Statement/-
value:
Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/cli/run_local.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1243,7 +1243,7 @@ func BuildRunLocalCmd() *cobra.Command {
cmd.Flags().StringVarP(&vars.envName, envFlag, envFlagShort, "", envFlagDescription)
cmd.Flags().StringVarP(&vars.appName, appFlag, appFlagShort, tryReadingAppName(), appFlagDescription)
cmd.Flags().BoolVar(&vars.watch, watchFlag, false, watchFlagDescription)
cmd.Flags().BoolVar(&vars.useTaskRole, useTaskRoleFlag, true, useTaskRoleFlagDescription)
cmd.Flags().BoolVar(&vars.useTaskRole, useTaskRoleFlag, false, useTaskRoleFlagDescription)
cmd.Flags().Var(&vars.portOverrides, portOverrideFlag, portOverridesFlagDescription)
cmd.Flags().StringToStringVar(&vars.envOverrides, envVarOverrideFlag, nil, envVarOverrideFlagDescription)
cmd.Flags().BoolVar(&vars.proxy, proxyFlag, false, proxyFlagDescription)
Expand Down
4 changes: 1 addition & 3 deletions site/content/blogs/release-v133.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,9 @@ Copilot v1.33 brings big enhancements to help you develop more flexibly and effi

## Use ECS Task Role for `copilot run local`

`copilot run local` now has a flag `--use-task-role` which is enabled by default. When enabled, Copilot will retrieve the IAM permissions from your deployed service and inject them into the containers created by `run local`.
`copilot run local` now has a flag `--use-task-role`. When enabled, Copilot will retrieve the IAM permissions from your deployed service and inject them into the containers created by `run local`.
Copy link
Contributor

@KollaAdithya KollaAdithya Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to explicitly mention that the flag is disabled by default?

Copy link
Contributor Author

@CaptainCarpensir CaptainCarpensir Jan 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, disabled by default is definitely the norm for flags in any program.

This means that your containers will have the same permissions that they do on the cloud, enabling you to test more accurately.

If you don't want to use the `TaskRole` permissions, or if Copilot fails to retrieve them, you can disable this feature by setting `--use-task-role=false`.

## Container dependencies support for `copilot run local`

`copilot run local` now respects the [`depends_on`](../docs/manifest/lb-web-service.md#image-depends-on) specified in the service manifest.
Expand Down