Display secret names as environment variables

[efekarakus]

Ask

Currently, if a user runs svc show, under "Variables" we only display environment variables:

$ copilot svc show
....
Variables

  Name                      Environment         Value
  ECS_CLI_APP_NAME          test                api
  ECS_CLI_ENVIRONMENT_NAME  test                test
  ECS_CLI_LB_DNS            test                XXXX
  ECS_CLI_PROJECT_NAME      test                ecs-kudos
  MY_DYNAMODB_TABLE_NAME    test                ecs-kudos-test-api
  MY_QUEUE_URL              test                https://sqs.us-west-2.amazonaws.com/XXXX/SampleQueue

Since secrets are also injected as environment variables we should also display them under variables:

$ copilot svc show
....
Variables

  Name                      Environment         Value                      Is a secret?
  ...                                                                      no
  MY_DB_PASSWD              test                ssm/<parameter name>       yes
  OTHER_DB_PASSWD           test                secretsmanager/<ARN>       yes

Why?

I want to see all the available environment variable names (including secrets) when I run "svc show".

I'm not particularly attached to the UX above, so feel free to propose something else.

[kohidave]

Should we stick with the manifest style of grouping it under a different header? Secrets or something?

[efekarakus]

Sure that sounds good. It would make it easier to display too.

Secrets
  Name                      Environment         Value from                     
  MY_DB_PASSWD              test                ssm/<parameter name>       
  OTHER_DB_PASSWD           test                <ARN>       

[efekarakus]

To achieve this functionality:

Spec

Each checklist requires both a code change, its own unit test, and optionally split into separate PRs.

• Add new method Secrets to TaskDefinition
  Should be very similar to EnvironmentVariables method:
  

  copilot-cli/internal/pkg/aws/ecs/ecs.go

  Lines 344 to 351 in ce04bfb

  	// EnvironmentVariables returns environment variables of the task definition.
  	func (t *TaskDefinition) EnvironmentVariables() map[string]string {
  	envs := make(map[string]string)
  	for _, env := range t.ContainerDefinitions[0].Environment {
  	envs[aws.StringValue(env.Name)] = aws.StringValue(env.Value)
  	}
  	return envs
  	}

• Add new method Secrets to Service
  Should be very similar to the EnvVars method:
  

  copilot-cli/internal/pkg/describe/service.go

  Lines 104 to 114 in f25113a

  	// EnvVars returns the environment variables of the task definition.
  	func (d *ServiceDescriber) EnvVars() (map[string]string, error) {
  	taskDefName := fmt.Sprintf("%s-%s-%s", d.app, d.env, d.service)
  	taskDefinition, err := d.ecsClient.TaskDefinition(taskDefName)
  	if err != nil {
  	return nil, err
  	}
  	envVars := taskDefinition.EnvironmentVariables()
  	return envVars, nil
  	}

• Add new type Secret similar to EnvVar, modify backendSvcDesc and webSvcDesc to use secrets
  

  copilot-cli/internal/pkg/describe/backend_service.go

  Lines 169 to 196 in d70f8cc

  	func (w *backendSvcDesc) HumanString() string {
  	var b bytes.Buffer
  	writer := tabwriter.NewWriter(&b, minCellWidth, tabWidth, cellPaddingWidth, paddingChar, noAdditionalFormatting)
  	fmt.Fprint(writer, color.Bold.Sprint("About\n\n"))
  	writer.Flush()
  	fmt.Fprintf(writer, " %s\t%s\n", "Application", w.App)
  	fmt.Fprintf(writer, " %s\t%s\n", "Name", w.Service)
  	fmt.Fprintf(writer, " %s\t%s\n", "Type", w.Type)
  	fmt.Fprint(writer, color.Bold.Sprint("\nConfigurations\n\n"))
  	writer.Flush()
  	w.Configurations.humanString(writer)
  	fmt.Fprint(writer, color.Bold.Sprint("\nService Discovery\n\n"))
  	writer.Flush()
  	w.ServiceDiscovery.humanString(writer)
  	fmt.Fprint(writer, color.Bold.Sprint("\nVariables\n\n"))
  	writer.Flush()
  	w.Variables.humanString(writer)
  	if len(w.Resources) != 0 {
  	fmt.Fprint(writer, color.Bold.Sprint("\nResources\n"))
  	writer.Flush()
  	// Go maps don't have a guaranteed order.
  	// Show the resources by the order of environments displayed under Configurations for a consistent view.
  	w.Resources.humanStringByEnv(writer, w.Configurations)
  	}
  	writer.Flush()
  	return b.String()
  	}

• Populate the []Secret slice in Describe methods:
  

  copilot-cli/internal/pkg/describe/backend_service.go

  Lines 89 to 118 in d70f8cc

  	var configs []*ServiceConfig
  	var services []*ServiceDiscovery
  	var envVars []*EnvVars
  	for _, env := range environments {
  	err := d.initServiceDescriber(env)
  	if err != nil {
  	return nil, err
  	}
  	svcParams, err := d.svcDescriber[env].Params()
  	if err != nil {
  	return nil, fmt.Errorf("retrieve service deployment configuration: %w", err)
  	}
  	services = appendServiceDiscovery(services, serviceDiscovery{
  	Service: d.svc,
  	Port: svcParams[stack.LBWebServiceContainerPortParamKey],
  	App: d.app,
  	}, env)
  	configs = append(configs, &ServiceConfig{
  	Environment: env,
  	Port: svcParams[stack.LBWebServiceContainerPortParamKey],
  	Tasks: svcParams[stack.WorkloadTaskCountParamKey],
  	CPU: svcParams[stack.WorkloadTaskCPUParamKey],
  	Memory: svcParams[stack.WorkloadTaskMemoryParamKey],
  	})
  	backendSvcEnvVars, err := d.svcDescriber[env].EnvVars()
  	if err != nil {
  	return nil, fmt.Errorf("retrieve environment variables: %w", err)
  	}
  	envVars = append(envVars, flattenEnvVars(env, backendSvcEnvVars)...)
  	}

[bvtujo]

This is addressed by the linked PR above (#1704)