added helper scripts to get started

[edennuriel]

setup dependencies and create your host projects

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the developer onboarding experience by introducing a suite of helper scripts designed to streamline both local development environment setup and Google Cloud Platform project provisioning. It automates the installation of critical tools and the creation of foundational GCP infrastructure across development, UAT, and production stages, ensuring consistency and reducing manual configuration effort.

Highlights

• Development Environment Setup Script: Introduced a comprehensive setup_dev_env.sh script that automates the installation and configuration of essential development tools like Git, Make, jq, Python 3, unzip, Terraform, GitHub CLI, uv, and Google Cloud SDK. It includes special handling for Nix/IDX environments to ensure declarative dependency management.
• GCP Project Provisioning Script: Added a create_project.sh script that leverages Terraform to provision Google Cloud Platform projects. This script guides the user through validating input, checking for existing projects, retrieving billing and organization details, and applying Terraform configurations to create 'dev', 'uat', and 'prod' environments.
• Terraform Configuration for GCP Projects: Provided Terraform (main.tf, variables.tf) to define the infrastructure for three distinct GCP environments (dev, uat, prod). This includes creating Google Cloud projects, enabling necessary APIs (Compute, Service Management, Resource Manager, Billing, IAM), and setting up default VPC networks and subnets with private IP access.
• Automated Google Cloud SDK Configuration: Integrated gcloud authentication and project configuration into the setup scripts, ensuring that the user's Google Cloud environment is correctly set up and that project IDs are persisted, including optionally updating the .idx/dev.nix file for IDX users.

Changelog

• .idx/dev.nix
  • Added a new Nix configuration file to define the development environment's dependencies, including various packages like jq, uv, gh, terraform, google-cloud-sdk, go, python311, and nodejs_20.
  • Configured the PROJECT_ID environment variable within the Nix environment.
• setup/create_project.sh
  • Added a new bash script to automate the creation of GCP projects.
  • Implemented input validation for the project base name.
  • Included logic to check for and warn about existing GCP projects.
  • Automated the retrieval of GCP billing account and organization IDs.
  • Integrated Terraform execution for project creation, planning, and application.
  • Added functionality to extract created project IDs and update a local .env file.
• setup/project/main.tf
  • Added a new Terraform configuration file to define GCP infrastructure.
  • Defined local variables for environments (dev, uat, prod) and required APIs.
  • Configured the creation of unique Google Cloud projects for each environment using random_id.
  • Enabled a set of essential Google Cloud APIs for each created project.
  • Provisioned default VPC networks with auto-create subnets disabled for each project.
  • Created default subnets within the VPCs, specifying IP CIDR ranges and enabling private IP Google access.
  • Defined outputs for the dev, uat, and prod project IDs.
• setup/project/terraform.tfstate
  • Added a new Terraform state file, capturing the state of the managed GCP infrastructure.
• setup/project/terraform.tfstate.backup
  • Added a new Terraform state backup file, storing a previous state of the managed GCP infrastructure.
• setup/project/variables.tf
  • Added a new Terraform variables file to define input parameters for the GCP project creation.
  • Declared variables for project_base_name, billing_account, org_id, and region with descriptions and a default value for region.
• setup/setup_dev_env.sh
  • Added a new bash script to check for and install development dependencies.
  • Implemented helper functions for colored output (info, warn, success, error, prompt).
  • Included specific logic to configure Nix/IDX environments by checking and adding missing packages to .idx/dev.nix.
  • Provided standard installation routines for non-IDX environments, supporting macOS (Homebrew) and Linux (apt, dnf, yum).
  • Automated the installation of Git, Make, jq, Python 3, unzip, Terraform, GitHub CLI, uv, and Google Cloud SDK.
  • Configured gcloud authentication, default project, and Application Default Credentials (ADC) quota project.
  • Added aliases for terraform (tf) and less (more).

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a set of helper scripts and Terraform configurations to automate the setup of development environments and the creation of GCP projects for dev, uat, and prod. The changes are a good step towards simplifying the onboarding process.

My review includes several important points:

• Critical: Terraform state files have been included in the commit. These should be removed and added to .gitignore to prevent security risks and collaboration issues.
• High: The Terraform configuration uses the same network CIDR for all environments, which will cause IP conflicts. This should be parameterized.
• Medium: A few improvements to the shell scripts to fix ineffective aliases and avoid configuration issues in IDX environments.

Overall, the scripts are well-structured, but the issues with Terraform state and networking need to be addressed before merging.

[gemini-code-assist]

Terraform state files (.tfstate) should not be committed to version control. They can contain sensitive information about your infrastructure and are specific to a particular run. Committing them can lead to security risks and merge conflicts. Please remove this file from the repository and add *.tfstate and *.tfstate.backup to your .gitignore file. For collaboration, it is highly recommended to use a remote backend for storing Terraform state, such as a Google Cloud Storage bucket.

[gemini-code-assist]

Terraform state backup files (.tfstate.backup) should not be committed to version control. They can contain sensitive information and are not meant to be shared via Git. Please remove this file and ensure *.tfstate* is in your .gitignore.

[gemini-code-assist]

The ip_cidr_range is hardcoded to "10.0.0.0/20" for all environments (dev, uat, prod). This creates overlapping IP address spaces, which will prevent you from peering these VPCs in the future. Each environment should have a unique CIDR range.

I suggest defining a map of CIDR ranges in your locals block and referencing it here. For example:

locals {
  // ...
  subnet_cidrs = {
    dev  = "10.10.0.0/20"
    uat  = "10.20.0.0/20"
    prod = "10.30.0.0/20"
  }
}

  ip_cidr_range            = local.subnet_cidrs[each.key]

[gemini-code-assist]

This hardcoded PROJECT_ID can be misleading and causes issues with the setup_dev_env.sh script. The setup script is designed to add the correct PROJECT_ID to this file, but its current implementation will add a duplicate entry instead of replacing this one if the value differs.

I recommend removing this line. The setup script will then correctly add the user's configured project ID to the env block on the first run.

[gemini-code-assist]

These alias commands will not have any effect in the user's shell after the script finishes executing, as they are defined in a subshell that is destroyed when the script exits.

To make these aliases available to the user, you should instruct them to add them to their shell's startup file (e.g., ~/.bashrc, ~/.zshrc). I recommend removing these lines from the script.