<!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
-->

# Overview

This directory holds terraform code to provision resources that
[org.apache.beam.testinfra.pipelines.ReadDataflowApiWriteBigQuery](../../../src/main/java/org/apache/beam/testinfra/pipelines/ReadDataflowApiWriteBigQuery.java)
reads from and writes to.

# List of all provision GCP resources

The following lists all provisioned resources and their rationale
categorized by GCP service.

| resource                    | reason                                                |
|-----------------------------|-------------------------------------------------------|
| Eventarc Workflow           | Intended for listening to Dataflow Status Changes     |
| Pub/Sub topic               | Required for Eventarc Workflow                        |
| Pub/Sub subscription        | Intended as a source; subscribes to Eventarc Workflow |
| Google Cloud Storage Bucket | Intended for temporary storage                        |
| BigQuery Datasets           | Intended as sink                                      |

# Usage

Follow terraform workflow convention to apply this module. It assumes the
working directory is at
[.test-infra/pipelines](../../..)

## Terraform Init

This module uses a Google Cloud Storage bucket backend.

Initialize the terraform workspace for the `apache-beam-testing` project:

```
DIR=infrastructure/03.io/dataflow-to-bigquery
terraform -chdir=$DIR init -backend-config=apache-beam-testing.tfbackend
```

or for your own Google Cloud project:

```
DIR=infrastructure/03.io/dataflow-to-bigquery
terraform init -backend-config=path/to/your/backend-config-file.tfbackend
```

where your `backend-config-file.tfbackend` contains:

```
bucket = <Google Cloud Storage Bucket Name>
```

## Terraform Apply

Notice the `-var-file` flag referencing [common.tfvars](common.tfvars) that
provides opinionated variable defaults.

For `apache-beam-testing`:

```
DIR=infrastructure/03.io/dataflow-to-bigquery
terraform -chdir=$DIR apply -var-file=common.tfvars -var-file=apache-beam-testing.tfvars
```

or for your own Google Cloud project:

```
DIR=infrastructure/03.io/dataflow-to-bigquery
terraform -chdir=$DIR apply -var-file=common.tfvars
```
