Add import support for kinesis firehose delivery stream #2082

ApsOps · 2017-10-27T15:26:35Z

@radeksimko Right now, I've just added import support just for Redshift destination. I want to make sure I'm on the right track.

cloudwatch_logging_options aren't working yet. Looks like it expects *schema.Set and I'm giving map[string]interface{}. How do we handle this?

EDIT: We use "flatteners" to create required *schema.Set for converting *awsservice.Struct to []map[string]interface{}.

TODO:

Add support for elasticsearch and s3 destinations
Add acceptance tests

…gging options

ApsOps · 2017-10-29T09:18:23Z

@radeksimko I'm able to import a firehose stream with this code.
There's something missing in the acceptance test though.

=== RUN   TestAccAWSKinesisFirehoseDeliveryStream_importBasic
--- FAIL: TestAccAWSKinesisFirehoseDeliveryStream_importBasic (210.44s)
	testing.go:434: Step 1 error: 1 error(s) occurred:

		* aws_kinesis_firehose_delivery_stream.test_stream (import id: arn:aws:firehose:us-west-2:264212557801:deliverystream/terraform-kinesis-firehose-basictest-8541682280680129001): 1 error(s) occurred:

		* import aws_kinesis_firehose_delivery_stream.test_stream result: arn:aws:firehose:us-west-2:264212557801:deliverystream/terraform-kinesis-firehose-basictest-8541682280680129001: aws_kinesis_firehose_delivery_stream.test_stream: [WARN] Error reading Kinesis Firehose Delivery Stream: ValidationException: 2 validation errors detected: Value 'arn:aws:firehose:us-west-2:264212557801:deliverystream/terraform-kinesis-firehose-basictest-8541682280680129001' at 'deliveryStreamName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z0-9_.-]+; Value 'arn:aws:firehose:us-west-2:264212557801:deliverystream/terraform-kinesis-firehose-basictest-8541682280680129001' at 'deliveryStreamName' failed to satisfy constraint: Member must have length less than or equal to 64
			status code: 400, request id: 1ff2eb7e-bc87-11e7-a41d-d78f75b56b27
FAIL
FAIL	github.com/terraform-providers/terraform-provider-aws/aws	210.497s

It's putting the id (which is arn I believe) in place of name, even though I'm using a custom Importer instead of the pass-through one.

What am I missing here? 🤔

ApsOps · 2017-11-09T10:31:31Z

@radeksimko Ping 😄

ApsOps · 2017-11-25T12:46:29Z

@radeksimko I just realized that terraform import current works only with id, not name.
So, I've fixed that functionality and it works and acceptance tests pass as well.

Please let me know if something else is needed to get this merged.

EDIT: Not sure why the test is failing. testAccKinesisFirehosePreCheck function is present here.

EDIT2: Test was breaking due to upstream changes in #2055. Fixed now.

ApsOps · 2017-11-25T12:50:07Z

aws/resource_aws_kinesis_firehose_delivery_stream.go

+ State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+ resARN, err := arn.Parse(d.Id())
+ if err != nil {
+ return []*schema.ResourceData{}, err


@radeksimko Is this okay or should it be return nil, err instead?

It likely doesn't matter if a non-nil error is returned - so returning nil here is nicer.

jen20

A couple of minior changes and comments - other than that this looks good to me! If you could squash this down to one commit, I'll go ahead and merge it.

jen20 · 2017-12-20T17:27:21Z

aws/import_aws_kinesis_firehose_delivery_stream_test.go

+import (
+ "testing"
+
+ "fmt"


goimports needs running here

jen20 · 2017-12-20T17:27:49Z

aws/resource_aws_kinesis_firehose_delivery_stream.go

@@ -6,9 +6,12 @@ import (
 "strings"
 "time"

+ "bytes"


Same here re goimports

jen20 · 2017-12-20T17:31:21Z

aws/resource_aws_kinesis_firehose_delivery_stream.go

+ State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+ resARN, err := arn.Parse(d.Id())
+ if err != nil {
+ return []*schema.ResourceData{}, err


It likely doesn't matter if a non-nil error is returned - so returning nil here is nicer.

ApsOps · 2017-12-20T18:27:12Z

@jen20 Done changes as per the review. The "squash and merge" button should combine the commits as one before adding to master.
Please let me know if I should squash manually.

dennisatspaceape · 2017-12-25T18:18:53Z

I was trying to add support for S3 Backup (#2699) when I found that this modification doesn't handle S3 basic vs extended configuration correctly.

Essentially when you create a Kinesis Delivery Stream with an S3 destination:

aws firehose create-delivery-stream --delivery-stream-name Test --extended-s3-destination-configuration '{"RoleARN":"arn:aws:iam::XXXXX:role/KinesisFirehoseTest","BucketARN":"arn:aws:s3:::terraform-test-kinesis"}'

and describe the Delivery Stream:

{
    "DeliveryStreamDescription": {
        "DeliveryStreamName": "Test",
        "DeliveryStreamARN": "arn:aws:firehose:us-east-1:XXXXX:deliverystream/Test",
        "DeliveryStreamStatus": "ACTIVE",
        "DeliveryStreamType": "DirectPut",
        "VersionId": "1",
        "CreateTimestamp": 1514224146.811,
        "Destinations": [
            {
                "DestinationId": "destinationId-000000000001",
                "S3DestinationDescription": {
                    "RoleARN": "arn:aws:iam::XXXXX:role/KinesisFirehoseTest",
                    "BucketARN": "arn:aws:s3:::terraform-test-kinesis",
                    "BufferingHints": {
                        "SizeInMBs": 5,
                        "IntervalInSeconds": 300
                    },
                    "CompressionFormat": "UNCOMPRESSED",
                    "EncryptionConfiguration": {
                        "NoEncryptionConfig": "NoEncryption"
                    },
                    "CloudWatchLoggingOptions": {
                        "Enabled": false
                    }
                },
                "ExtendedS3DestinationDescription": {
                    "RoleARN": "arn:aws:iam::XXXXX:role/KinesisFirehoseTest",
                    "BucketARN": "arn:aws:s3:::terraform-test-kinesis",
                    "BufferingHints": {
                        "SizeInMBs": 5,
                        "IntervalInSeconds": 300
                    },
                    "CompressionFormat": "UNCOMPRESSED",
                    "EncryptionConfiguration": {
                        "NoEncryptionConfig": "NoEncryption"
                    },
                    "CloudWatchLoggingOptions": {
                        "Enabled": false
                    },
                    "S3BackupMode": "Disabled"
                }
            }
        ],
        "HasMoreDestinations": false
    }
}

AWS returns configuration for both S3DestinationDescription (Basic) and ExtendedS3DestinationDescription (Extended), it looks like they cloned the settings from the extended section to the basic one. I've also checked that when you create with basic-only configuration (deprecated) AWS also creates the extended config equivalent.

The issue comes when creating the resource state at https:/terraform-providers/terraform-provider-aws/blob/master/aws/resource_aws_kinesis_firehose_delivery_stream.go#L272 as S3DestinationDescription is always populated (even when created with extended configuration) the destination is forced to "s3" (basic) and the state doesn't reflect everything associated with the resource and prevents the use of functionality offered by the extended configuration (Lambda Processing, S3 Backup etc...). Subsequently, terraform plan and apply destroys and recreates the delivery stream incorrectly.

I was looking to create a patch for this but it's not clear to me how to choose the destination correctly as there's nothing in the description of the Delivery Stream which would denote whether it was created with basic or extended configuration. Part of me would suggest converting everything to extended configuration given basic is deprecated but my experience of terraform is less than 8 hours so not sure if that's the best approach :)

ApsOps · 2017-12-26T05:15:13Z

@dennisatspaceape Ah, I missed that. So that basically means if I create a stream via aws cli, and I forget if I used basic or extended, there's no way to find out?

dennisatspaceape · 2017-12-26T23:24:43Z

@ApsOps I used the AWS CLI purely to see the metadata behind the Delivery Stream. If you create a Delivery Stream with extend_s3 configuration in terraform and then run plan without any changes terraform will flag that the destination should be changed from "extend_s3" to "s3" which is incorrect. Even if you apply the change, terraform will always see the Delivery Stream as created with basic configuration and always flag that a change is required.

Looking at the AWS metadata behind the Delivery Stream I don't believe it's possible to know if the creation was done with basic or extended configuration. If you create a basic S3 delivery stream (deprecated) AWS will also initialize the applicable extended configuration properties and vice versa.

ApsOps · 2017-12-27T05:28:46Z

@radeksimko @jen20 Do you have any ideas on how we can check if a stream was created with s3 or extended_s3 config, since AWS describe delivery stream output is same for both?

Or should we also make s3 destination as deprecated and ask users to create/migrate to extended_s3?

dennisatspaceape · 2018-01-09T21:03:59Z

@radeksimko @jen20 Any chance of some feedback on this?

bflad · 2018-01-12T15:17:13Z

(Sorry I don't have feedback from the post-merge discussion as I'm just going through and post-release commenting, but my suggestion would be to ensure each bug captured in an issue somewhere rather than this PR for quick resolution. We are planning a 1.7.1 bugfix release.)

The functionality of this PR (which given by the post-merge comments above might not be 100%) has been released in terraform-provider-aws version 1.7.0. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

CHANGELOG: Fix link to 1.7.0 released #2082

ApsOps · 2018-01-12T19:11:20Z

@dennisatspaceape Sorry for the trouble. I've fixed the broken functionality in #2970. It would be great if you could test and confirm that it works for you. 🙂

@bflad Please see if #2970 could be merged soon since this is broken right now.

ghost · 2020-04-08T17:45:44Z

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!

ApsOps added 4 commits October 27, 2017 20:51

Add import support for kinesis firehose delivery stream

6aedccd

Add flatteners for kinesis firehose delivery stream and cloudwatch lo…

aecbafe

…gging options

Add support for elasticsearch and extended_s3 delivery streams

8129306

Set cloudwatch logging options only if logging is enabled

75f0593

radeksimko added the enhancement Requests to existing resources that expand the functionality or scope. label Oct 28, 2017

ApsOps added 2 commits October 29, 2017 14:38

Fix processors flattener and handle nil values

4b5f90b

Add acceptance test: not working yet

8ed9a38

radeksimko added the size/L Managed by automation to categorize the size of a PR. label Nov 15, 2017

ApsOps commented Nov 25, 2017

View reviewed changes

ApsOps changed the title ~~WIP: Add import support for kinesis firehose delivery stream~~ Add import support for kinesis firehose delivery stream Nov 25, 2017

Acc test passes: import works only with resource id, not name

d5c2d6d

ApsOps force-pushed the import-kinesis-firehose branch from 2d1caa9 to d5c2d6d Compare November 25, 2017 19:42

Fix test case breaking due to upstream changes

ff4eeb2

jen20 suggested changes Dec 20, 2017

View reviewed changes

ApsOps added 2 commits December 20, 2017 23:49

Run goimports

9d5f005

Return nil in case of an error

33821ba

jen20 merged commit 9c46cc6 into hashicorp:master Dec 20, 2017

ApsOps deleted the import-kinesis-firehose branch December 20, 2017 18:50

bflad mentioned this pull request Dec 21, 2017

Feature Request: import support for aws_kinesis_firehose_delivery_stream #481

Closed

bflad added this to the v1.7.0 milestone Jan 12, 2018

bflad added a commit that referenced this pull request Jan 12, 2018

CHANGELOG: Fix link to 1.7.0 released #2082

eb23e37

bflad added a commit that referenced this pull request Jan 12, 2018

Merge pull request #2966 from terraform-providers/d-fix-1.7.0-entry

8f9c10d

CHANGELOG: Fix link to 1.7.0 released #2082

ApsOps mentioned this pull request Jan 12, 2018

resource/aws_kinesis_firehose_delivery_stream: Fix for s3 destinations #2970

Merged

pecigonzalo mentioned this pull request Jan 15, 2018

Issues with aws_kinesis_firehose_delivery_stream - externded_s3 state #2997

Closed

ghost locked and limited conversation to collaborators Apr 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add import support for kinesis firehose delivery stream #2082

Add import support for kinesis firehose delivery stream #2082

ApsOps commented Oct 27, 2017 •

edited

Loading

ApsOps commented Oct 29, 2017

ApsOps commented Nov 9, 2017

ApsOps commented Nov 25, 2017 •

edited

Loading

ApsOps Nov 25, 2017

jen20 Dec 20, 2017

jen20 left a comment

jen20 Dec 20, 2017

jen20 Dec 20, 2017

jen20 Dec 20, 2017

ApsOps commented Dec 20, 2017

dennisatspaceape commented Dec 25, 2017

ApsOps commented Dec 26, 2017

dennisatspaceape commented Dec 26, 2017

ApsOps commented Dec 27, 2017

dennisatspaceape commented Jan 9, 2018

bflad commented Jan 12, 2018

ApsOps commented Jan 12, 2018

ghost commented Apr 8, 2020

Add import support for kinesis firehose delivery stream #2082

Add import support for kinesis firehose delivery stream #2082

Conversation

ApsOps commented Oct 27, 2017 • edited Loading

ApsOps commented Oct 29, 2017

ApsOps commented Nov 9, 2017

ApsOps commented Nov 25, 2017 • edited Loading

ApsOps Nov 25, 2017

Choose a reason for hiding this comment

jen20 Dec 20, 2017

Choose a reason for hiding this comment

jen20 left a comment

Choose a reason for hiding this comment

jen20 Dec 20, 2017

Choose a reason for hiding this comment

jen20 Dec 20, 2017

Choose a reason for hiding this comment

jen20 Dec 20, 2017

Choose a reason for hiding this comment

ApsOps commented Dec 20, 2017

dennisatspaceape commented Dec 25, 2017

ApsOps commented Dec 26, 2017

dennisatspaceape commented Dec 26, 2017

ApsOps commented Dec 27, 2017

dennisatspaceape commented Jan 9, 2018

bflad commented Jan 12, 2018

ApsOps commented Jan 12, 2018

ghost commented Apr 8, 2020

ApsOps commented Oct 27, 2017 •

edited

Loading

ApsOps commented Nov 25, 2017 •

edited

Loading