Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daeun084 authored Nov 28, 2024
1 parent 6dd400c commit 3663954
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,55 @@ https://spiny-lake-7e5.notion.site/API-10b37be2e3fa8020a345c0aa4089a0a0?pvs=4

<br><br>


# ๐Ÿ”„ Work Flow
> **1) ๊ฐœ๋ฐœ ๋‹จ๊ณ„**
1. **์ฝ”๋“œ ์ž‘์„ฑ**
- IntelliJ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋ฐฑ์—”๋“œ ์ฝ”๋“œ๋ฅผ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
2. **๋ฒ„์ „ ๊ด€๋ฆฌ**
- Git์„ ํ†ตํ•ด ๋กœ์ปฌ์—์„œ ์ž‘์„ฑ๋œ ์ฝ”๋“œ๋ฅผ GitHub๋กœ ํ‘ธ์‹œํ•ฉ๋‹ˆ๋‹ค.
- `develop` ๋ธŒ๋žœ์น˜์—๋Š” ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฅผ ๊ฑฐ์นœ ํ›„ ๋ณ‘ํ•ฉ๋ฉ๋‹ˆ๋‹ค.

<br>

> **2) CI (Continuous Integration)**
GitHub Actions๋ฅผ ํ™œ์šฉํ•˜์—ฌ `develop` ๋ธŒ๋žœ์น˜์— ์ฝ”๋“œ๊ฐ€ ํ‘ธ์‹œ๋  ๋•Œ CI ์ž‘์—…์ด ์ž๋™์œผ๋กœ ์‹คํ–‰๋ฉ๋‹ˆ๋‹ค. <br>

1. **์ฝ”๋“œ ์ฒดํฌ์•„์›ƒ ๋ฐ ํ™˜๊ฒฝ ์„ค์ •**
- `actions/checkout` ์•ก์…˜์„ ํ†ตํ•ด ์ตœ์‹  ์ฝ”๋“œ๋ฅผ ์ฒดํฌ์•„์›ƒํ•ฉ๋‹ˆ๋‹ค.
- Amazon Corretto JDK 21์„ ์„ค์ •ํ•˜์—ฌ Spring Boot ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์˜ ๋นŒ๋“œ ํ™˜๊ฒฝ์„ ์ค€๋น„ํ•ฉ๋‹ˆ๋‹ค.
2. **ํ•„์š”ํ•œ ๋ฆฌ์†Œ์Šค ํŒŒ์ผ ์ƒ์„ฑ**
- ์„ค์ • ํŒŒ์ผ๊ณผ ํ…์ŠคํŠธ ํŒŒ์ผ์„ ์ƒ์„ฑํ•˜๊ณ , GitHub Secrets๋ฅผ ํ†ตํ•ด ๋ณด์•ˆ ๋ฐ์ดํ„ฐ๋ฅผ ์‚ฝ์ž…ํ•ฉ๋‹ˆ๋‹ค.
3. **์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๋นŒ๋“œ**
- Gradle์„ ์‚ฌ์šฉํ•˜์—ฌ ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ๋นŒ๋“œํ•ฉ๋‹ˆ๋‹ค.
4. **Docker ์ด๋ฏธ์ง€ ์ƒ์„ฑ ๋ฐ Docker Hub ํ‘ธ์‹œ**
- Docker Hub์— ๋กœ๊ทธ์ธํ•˜์—ฌ ์ธ์ฆ์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.
- Docker ์ด๋ฏธ์ง€๋ฅผ ๋นŒ๋“œํ•˜๊ณ , ์ด๋ฅผ Docker Hub ๋ ˆ์ง€์ŠคํŠธ๋ฆฌ์— ํ‘ธ์‹œํ•ฉ๋‹ˆ๋‹ค.

<br>

> **3) CD (Continuous Deployment)**
CD ์ž‘์—…์€ GitHub Actions์™€ `deploy.sh` ์Šคํฌ๋ฆฝํŠธ๋ฅผ ํ™œ์šฉํ•˜์—ฌ Docker ์ด๋ฏธ์ง€๋ฅผ Amazon EC2 ์ธ์Šคํ„ด์Šค์— ๋ฐฐํฌํ•˜๊ณ , **Blue-Green ๋ฐฐํฌ ์ „๋žต**์„ ํ†ตํ•ด **๋ฌด์ค‘๋‹จ ๋ฐฐํฌ**๋ฅผ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. <br>

1. **๋„์ปค ์ด๋ฏธ์ง€ ๋ฐฐํฌ**
- CI์—์„œ ์ƒ์„ฑ๋œ ์ตœ์‹  Docker ์ด๋ฏธ์ง€๋ฅผ EC2 ์ธ์Šคํ„ด์Šค์—์„œ ๋‹ค์šด๋กœ๋“œํ•˜์—ฌ ๋ฐฐํฌ ์ค€๋น„๋ฅผ ํ•ฉ๋‹ˆ๋‹ค.
2. **Green ํ™˜๊ฒฝ ์ปจํ…Œ์ด๋„ˆ ์‹คํ–‰**
- ์ƒˆ๋กœ์šด ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์ปจํ…Œ์ด๋„ˆ๋ฅผ ์‹คํ–‰ํ•ฉ๋‹ˆ๋‹ค. ์‹คํ–‰ ๊ฐ€๋Šฅํ•œ ํฌํŠธ๋ฅผ ์ž๋™์œผ๋กœ ํ• ๋‹นํ•˜๋ฉฐ, ๊ธฐ์กด ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜(Blue ํ™˜๊ฒฝ)๊ณผ ๋…๋ฆฝ์ ์œผ๋กœ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค.
3. **Health Check**
- ์ƒˆ๋กœ์šด ์ปจํ…Œ์ด๋„ˆ์˜ ์ƒํƒœ๋ฅผ ํ™•์ธํ•˜์—ฌ ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜์ด ์ •์ƒ์ ์œผ๋กœ ์‹คํ–‰ ์ค‘์ธ์ง€ ๊ฒ€์ฆํ•ฉ๋‹ˆ๋‹ค. ๋ฐฐํฌ ์‹คํŒจ ์‹œ ๊ธฐ์กด ํ™˜๊ฒฝ์— ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š๊ณ  ์ž‘์—…์„ ์ค‘๋‹จํ•ฉ๋‹ˆ๋‹ค.
4. **Nginx๋ฅผ ํ†ตํ•œ ํŠธ๋ž˜ํ”ฝ ์Šค์œ„์นญ**
- Nginx ์„ค์ •์„ ์—…๋ฐ์ดํŠธํ•˜์—ฌ ํŠธ๋ž˜ํ”ฝ์„ Green ํ™˜๊ฒฝ์œผ๋กœ ์ „ํ™˜ํ•ฉ๋‹ˆ๋‹ค. ์‹ค์‹œ๊ฐ„ ํŠธ๋ž˜ํ”ฝ ์Šค์œ„์นญ์œผ๋กœ ์‚ฌ์šฉ์ž ์š”์ฒญ์— ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
5. **Blue ํ™˜๊ฒฝ ์ข…๋ฃŒ**
- Green ํ™˜๊ฒฝ ๋ฐฐํฌ๊ฐ€ ์„ฑ๊ณตํ•˜๋ฉด ๊ธฐ์กด Blue ํ™˜๊ฒฝ ์ปจํ…Œ์ด๋„ˆ๋ฅผ ์•ˆ์ „ํ•˜๊ฒŒ ์ข…๋ฃŒํ•˜์—ฌ ๋ฆฌ์†Œ์Šค๋ฅผ ์ •๋ฆฌํ•ฉ๋‹ˆ๋‹ค.


<br><br>



## ๐Ÿ“ Directory

```
Expand Down

0 comments on commit 3663954

Please sign in to comment.