README_kor.md

Terraform-Canvas

Visual Programming을 통한 Terraform 클라우드 인프라 프로비저닝 웹 서비스 프로젝트
Explore the docs »

한국어 · English

Report Issues · Pull Requests

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Configuration
   • Release
3. Contributing
4. License
5. Contact

🔍 About The Project

많은 기업들이 기존 클라우드 및 온프레미스 환경에서 클라우드 네이티브 환경으로의 전환을 위한 IaC 툴로 Terraform을 선택하고 있다. 하지만 Terraform의 높은 진입 장벽 때문에 많은 어려움을 겪고 있다. 그래서 우리는 “Visual Programming을 통한 Terraform 클라우드 인프라 프로비저닝 웹 서비스”를 통해 Terraform의 기술 진입 장벽을 낮추고자 한다. 이를 통해 새롭게 클라우드 네이티브 환경을 도입하고자 하는 스타트업과 SI 팀 그리고 빠르게 IaC 환경을 테스트 및 프로토타이핑하고자 하는 TF 팀에서 활용할 수 있도록 한다.

(back to top)

🗃️ Built With

💡 Infrastructure

💡 Environment (CI/CD, Package tools...)

(back to top)

🚀 Getting Started

⚡ Installation

helm repo add canvas-helm https://terraform-canvas.github.io/canvas-helm/

helm install canvas-helm/terraform-canvas

✏️ Configuration

배포 workflow를 실행시키기 위해서는 Gihub Token이 필요해요.

## Github Repository settings
TOKEN_GITHUB=xxx

🚩 Release

release 과정을 위해서는 다음과 같은 절차가 필요해요

1. /charts/terraform-canvas/Chart.yaml의 version을 수정해주세요.
2. main에서 release branch로의 Pull Request를 생성해주세요.
3. 해당 Pull Request를 merge 해주세요. (이때 release workflow가 동작하게 되고 배포 패키지가 만들어지게 됩니다.)

(back to top)

🔥 Contributing

Contribution을 위해서는 CONTRIBUTION.txt를 참고해주세요.

이슈나 새로운 기능 및 수정에 대한 요청은 다음과 같은 절차를 따라주세요. 🥰

1. 프로젝트 fork
2. 새로운 수정이나, 버그, 기능에 대해 이슈 생성 (오타 수정의 경우 따로 x)
3. dev branch에서 새로운 branch 생성 (git checkout -b feature/Newfeature)
4. 변경 사항 commit (git commit -m 'feat: add new feature')
5. 작업한 branch의 내용을 push (git push origin feature/Newfeature)
6. dev branch로의 병합으로 Pull Request를 열고 해당 Issues에 대한 closes keyword 추가

(back to top)

🔐 License

라이센스 정보는 LICENSE.txt를 참고해주세요.

(back to top)

💬 Contact

김수민

(back to top)