Skip to content
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.

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

New Data Source: ECS Service #3617

Merged
merged 1 commit into from
May 31, 2018
Merged

Conversation

elbuo8
Copy link
Contributor

@elbuo8 elbuo8 commented Mar 5, 2018

Closes #1681

@ghost ghost added the size/L Managed by automation to categorize the size of a PR. label Mar 5, 2018
@elbuo8 elbuo8 force-pushed the datasource-ecs-service branch from 8a93c4f to 76cb602 Compare March 5, 2018 05:48
@ghost ghost added the size/L Managed by automation to categorize the size of a PR. label Mar 5, 2018
@bflad bflad added new-data-source Introduces a new data source. service/ecs Issues and PRs that pertain to the ecs service. labels Mar 5, 2018
@kwyjibos
Copy link

Would be very useful if we could get this reviewed/merged

@n1te1337
Copy link

n1te1337 commented May 20, 2018

Is there any help needed to get this across the line?

Copy link
Contributor

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Hi @elbuo8 👋 Thanks for submitting this and sorry for the delay in getting it reviewed. It was in decent shape. I left feedback below which I'm going to go ahead and handle on merge since its been open so long.

},
"desired_count": {
Type: schema.TypeInt,
Optional: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

This attribute and the two below are not configurable (Optional: true) but rather read only and meant to just be set in the Terraform state (Computed: true). https://www.terraform.io/docs/extend/schemas/schema-behaviors.html

return err
}

for _, service := range desc.Services {
Copy link
Contributor

Choose a reason for hiding this comment

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

We generally prefer to check and immediately return errors for zero returned items or more than one returned item instead of using for loops in singular data sources. e.g.

if len(desc.Services) == 0 {
  return fmt.Errorf("service with name %q in cluster %q not found", serviceName, clusterArn)
}

if len(desc.Services) > 1 {
  return fmt.Errorf("multiple services with name %q found in cluster %q", serviceName, clusterArn)
}

service := desc.Service[0]
d.SetId(aws.StringValue(service.ServiceArn))
// ...

{
Config: testAccCheckAwsEcsServiceDataSourceConfig,
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.aws_ecs_service.default", "service_name", "mongodb"),
Copy link
Contributor

Choose a reason for hiding this comment

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

Nitpick: We can use resource.TestCheckResourceAttrPair() to ensure the resource and data source attributes match as expected.

---
layout: "aws"
page_title: "AWS: aws_ecs_service"
sidebar_current: "docs-aws-datasource-ecs-service"
Copy link
Contributor

Choose a reason for hiding this comment

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

This documentation page is missing a sidebar link in website/aws.erb

cluster_arn = "${aws_ecs_cluster.foo.arn}"
}

resource "aws_ecs_cluster" "foo" {
Copy link
Contributor

Choose a reason for hiding this comment

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

Normally we try to not show an unexpected configuration for newer operators (e.g. the data source directly referencing its resource counterpart) -- in this case its fine to simply just list the example as:

data "aws_ecs_service" "example" {
   cluster_arn  = "${data.aws_ecs_cluster.example.arn}"
   service_name = "example"
 }

@bflad bflad added this to the v1.22.0 milestone May 31, 2018
@bflad
Copy link
Contributor

bflad commented May 31, 2018

🚀

make testacc TEST=./aws TESTARGS='-run=TestAccAWSEcsServiceDataSource_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -run=TestAccAWSEcsServiceDataSource_basic -timeout 120m
=== RUN   TestAccAWSEcsServiceDataSource_basic
--- PASS: TestAccAWSEcsServiceDataSource_basic (34.14s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	34.179s

@bflad bflad merged commit 76cb602 into hashicorp:master May 31, 2018
bflad added a commit that referenced this pull request May 31, 2018
bflad added a commit that referenced this pull request May 31, 2018
@elbuo8 elbuo8 deleted the datasource-ecs-service branch May 31, 2018 17:17
@bflad
Copy link
Contributor

bflad commented Jun 5, 2018

This has been released in version 1.22.0 of the AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

@n1te1337
Copy link

@elbuo8 RE: #1681 I was really excited about this PR hoping it would solve my CI/CD issues but now when I think about it, it creates a different issue.

By using it like so:

data "aws_ecs_service" "main" {
  cluster_name = "mycluster"
  service_name = "voting"
}

resource "aws_ecs_service" "main" {
  name            = "voting"
  task_definition = "${data.aws_ecs_service.main.task_definition}"
  desired_count   = 1
}

You solve the issue where the CI/CD updates the task and terraform is still in sync because the data source will pull the currently active task revision for the service (which is great).

Unfortunately, by doing so you also create a dependency on the service itself because you expect the service to be up and running. This pretty much prohibits the use of the data source for new services, the only way to do it is to create a task and a service manually and only after that change it to use the data source (so you can't really automate it for infrastructure deployments).

Thoughts?

@ghost
Copy link

ghost commented Apr 5, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked and limited conversation to collaborators Apr 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
new-data-source Introduces a new data source. service/ecs Issues and PRs that pertain to the ecs service. size/L Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

data.aws_ecs_service should return running task definition revision
4 participants