# ezytf

**Repository Path**: mirrors_GoogleCloudPlatform/ezytf

## Basic Information

- **Project Name**: ezytf
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-15
- **Last Updated**: 2026-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## EzyTF

Effortlessly generate Google Cloud Terraform configurations using Google Sheets as input.<br>
Modular, Customizable and Scalable TF Generation by design.

### Google Sheet

Make a copy of this [Google Sheet](https://docs.google.com/spreadsheets/d/1cvjTM4QiovZVsnrQYRvSAxD6dmru5UZ8384sycsFsRE/edit?usp=sharing), follow details in instruction tab

### Architecture Diagram

ezytf can be deployed in either service or workflow mode.

#### Workflow

```mermaid
flowchart LR
    Sheet("`fa:fa-table Google Sheet`")
    Read("`Read Input <br> fa:fa-code *Cloud Function*`")
    Yaml[("`Intermediate config <br> fa:fa-bucket *Input gcs*`")]
    Generate("`Generate <br> fa:fa-code *Cloud Run Job*`")
    Output[("`Generated Code<br> fa:fa-file-code *ssm repo/fa:fa-bucket gcs*`")]
    Sheet --> |App scripts <br> Trigger| Read --> Yaml  -. cloud workflow <br> trigger.-> Generate --> Output
```

#### Service

```mermaid
flowchart LR
    Sheet("`fa:fa-table Google Sheet`")
    Read("`Read Input`")
    Generate("`Generate`")
    Output[("`Generated Code<br> fa:fa-file-code *ssm repo/fa:fa-bucket gcs*`")]
    Sheet --> |App scripts <br> Trigger| Read
    subgraph service [Cloud Run Service fa:fa-code]
    Read --> Generate
    end
    Generate --> Output
```

### Environment Variables

| Variable           | Description                                                                    | Required |
| ------------------ | ------------------------------------------------------------------------------ | -------- |
| EZTF_SHEET_ID      | google sheet ID                                                                | yes      |
| EZTF_CONFIG_DIR    | local dir of intermediate config, default:ezytf-gen-data/eztf-config           | no       |
| EZTF_OUTPUT_DIR    | local output dir to store output, default:ezytf-gen-data/eztf-output           | no       |
| EZTF_INPUT_CONFIG  | local intermediate config file or gcs stored config file                       | no       |
| EZTF_CONFIG_BUCKET | gcs bucket name to store intermediate config                                   | no       |
| EZTF_OUTPUT_BUCKET | gcs bucket name to store output                                                | no       |
| EZTF_SSM_HOST      | ssm host `https://[INSTANCE_ID]-[PROJECT_NUMBER].[LOCATION].sourcemanager.dev` | no       |
| EZTF_SSM_PROJECT   | ssm project id                                                                 | no       |
| EZTF_MODE          | value:`workflow`/`service` see above diagram for reference                     | no       |

### API Request body Field

provide either spreadsheetId or configContent or ezytfConfigGcsPath

| Variable           | Description                                               | Required |
| ------------------ | --------------------------------------------------------- | -------- |
| spreadsheetId      | google sheet ID                                           | no       |
| ezytfConfigGcsPath | ezytf config stored in gcs format gs://BUCKET/OBJECT_PATH | no       |
| configContent      | config data                                               | no       |
| configType         | yaml/json, default: yaml                                  | no       |
| generateCode       | true/false default: false                                 | no       |
| asyncGenerate      | api response async, true/false default: false             | no       |
| configBucket       | gcs bucket name to store ezytf config                     | no       |
| outputBucket       | gcs bucket name to store code output                      | no       |

### Install Dependencies

```
cd read_input && npm install
cd ../
cd generate && pipenv install
```

### Run Locally

```
export EZTF_SHEET_ID=[EZTF_SHEET_ID]
./generator.sh
```

### Run locally https mode

```
npm start --prefix read_input
curl localhost:8080  -d '{"spreadsheetId":"$EZTF_SHEET_ID", "generateCode":true}' -H "Content-Type: application/json"
curl localhost:8080  -d '{"ezytfConfigGcsPath":"gs://BUCKET/OBJECT_PATH", "generateCode":true}' -H "Content-Type: application/json"
curl localhost:8080  -d '{"configContent":"'$(base64 -w 0 CONFIG_FILE_PATH)'",  "configType": "yaml", "generateCode":true, "asyncGenerate":true}' -H "Content-Type: application/json"
```

### Build Locally

```
docker build -t ezytf:latest . -f Dockerfile
```

### Run Container Locally (as service)

```
PORT=8080 && \
TOKEN=access_token_file && \
gcloud auth print-access-token > $TOKEN &&
ADC=~/.config/gcloud/application_default_credentials.json && \
docker run -p 9090:${PORT} \
-e EZTF_MODE=service \
-e EZTF_SHEET_ID=[EZTF_SHEET_ID] \
-e EZTF_SSM_HOST=[EZTF_SSM_HOST] \
-e GOOGLE_APPLICATION_CREDENTIALS=/tmp/google_adc.json \
-e GOOGLE_CLOUD_PROJECT=[PROJECT_ID] \
-e EZTF_ACCESS_TOKEN_FILE=/tmp/access_token_file \
-v $(pwd)/$TOKEN:/tmp/access_token_file:ro \
-v $ADC:/tmp/google_adc.json:ro \
-v $(pwd)/ezytf-gen-data:/app/ezytf-gen-data \
ezytf:latest
```

### Setup Prerequisite 
```
gcloud beta source-manager instances create $SSM_INSTANCE_ID --region=$SSM_REGION  --project=$PROJECT_ID
```

```
EZTF_SSM_HOST=https://SSM_INSTANCE_ID-PROJECT_NUMBER.SSM_REGION.sourcemanager.dev
```


```
gcloud projects add-iam-policy-binding $PROJECT_ID --member=serviceAccount:$EZTF_SERVICE_ACCOUNT --role='roles/securesourcemanager.instanceRepositoryCreator'
gcloud projects add-iam-policy-binding $PROJECT_ID --member=serviceAccount:$EZTF_SERVICE_ACCOUNT --role='roles/securesourcemanager.repoCreator'
gcloud projects add-iam-policy-binding $PROJECT_ID --member=serviceAccount:$EZTF_SERVICE_ACCOUNT --role='roles/securesourcemanager.repoWriter'
```

### Push Container

```
export ARTIFACT_REGISTRY_PATH=us-docker.pkg.dev/[PROJECT_ID]/[REPO_NAME]/ezytf
docker tag ezytf:latest $ARTIFACT_REGISTRY_PATH/ezytf:latest . -f Dockerfile && \
docker push $ARTIFACT_REGISTRY_PATH/ezytf:latest
```

### Deploy Cloud Run Service (Service mode)

```
gcloud run deploy ezytf --region [REGION] --image=$ARTIFACT_REGISTRY_PATH/ezytf:latest \
--memory 2Gi \
--cpu 1000m \
--min-instances 0 \
--max-instances 2 \
--service-account [EZTF_SERVICE_ACCOUNT] \
--execution-environment gen2 \
--set-env-vars CI=1 \
--set-env-vars EZTF_MODE=service \
--set-env-vars EZTF_SSM_HOST=[EZTF_SSM_HOST]
--no-cpu-throttling
```

### Deploy read_input Cloud Function (Workflow Mode)

```
cd read_input && \
gcloud functions deploy ezytf-read-input \
--gen2 \
--runtime=nodejs20 \
--region [REGION] \
--source=. \
--entry-point=generateTF \
--trigger-http \
--run-service-account=[EZTF_SERVICE_ACCOUNT] \
--set-env-vars EZTF_CONFIG_BUCKET=[EZTF_CONFIG_BUCKET]
```

### Deploy generate Cloud Run Job (Workflow Mode)

```
gcloud run jobs deploy ezytf-generate --region [REGION] --image=$ARTIFACT_REGISTRY_PATH/ezytf:latest \
--memory 2Gi \
--cpu 1000m \
--service-account [EZTF_SERVICE_ACCOUNT] \
--command="sh generator.sh" \
--set-env-vars CI=1 \
--set-env-vars EZTF_MODE=workflow \
--set-env-vars EZTF_SSM_HOST=[EZTF_SSM_HOST]
```