Skip to content

Latest commit

 

History

History
108 lines (88 loc) · 4.55 KB

README.md

File metadata and controls

108 lines (88 loc) · 4.55 KB

Table of Contents
  1. About The Project
  2. Getting Started
  3. What is included out-of-the-box
  4. Pictures
  5. Contributing
  6. Roadmap
  7. Frequently Asked Questions
  8. License

About The Project

A template to jumpstart your new greenfield project. If you are a startup or an entrepreneur thinking to start a new project hosted on GCP infrastructure, consider to use Infrastructure Skeleton and save days of development.

This project uses IaC approach and via terraform create application stack in GCP to host your application.

Don't forget to give the project a star!

(back to top)

Getting Started

Prerequisites

(back to top)

Installation

  1. Clone the repo. Replace {myproject} with a name of your new project/app. 
    git clone git@github.com:petrzivny/infrastructure-skeleton.git {myproject}
cd {myproject}/app-stack
  2. Initialize terraform in this directory 
    terraform init
  3. Create a new GCP project (or use existing one). Make sure container, artifactregistry, servicenetworking, secretmanager and logging APIs are enabled.
  4. Setup variable specific for your project. 
    cp terraform.tfvars.dist terraform.tfvars
  5. Check and alter variables and secrets in terraform.tfvars with your favorite IDE.
  6. Provision complete application stack 
    terraform apply

(back to top)

What is included out-of-the-box

(back to top)

Pictures

(back to top)

Contributing

I greatly appreciate all suggestions and contributions. Contributions are what make the open source community such an amazing place to learn, inspire, and create.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  2. Commit your Changes (git commit -m 'Add some AmazingFeature')
  3. Push to the Branch (git push origin feature/AmazingFeature)
  4. Open a Pull Request

(back to top)

Roadmap

  • Add static public IP
  • Add certbot automatic creation
  • Copy all outside images for ingress-nginx to own repo
  • Copy all outside images for certbot to own repo and
  • Remove google_compute_router
  • Add Grafana
  • CI: Add GCP cost estimation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Frequently Asked Questions

License

Distributed under the MIT License. Use it however you want. And if you like it, don't forget to give the project a star at GutHub.

(back to top)