Patrick.Sy/spring-petclinic
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-petclinic.git synced 2025-12-27 10:57:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
mklee 2025-12-15 06:48:41 +00:00
parent a486adf6ca
commit 874c9d02a7
1 changed files with 79 additions and 139 deletions
Download patch file Download diff file Expand all files Collapse all files

218
README.md
View file

@ -1,172 +1,112 @@
# Spring PetClinic Sample Application [![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml)[![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml)
# 🐾 Spring Petclinic Multi-Cloud GitOps (AWS EKS / GCP GKE)
[![Build Status](https://github.com/costRider/spring-petclinic/actions/workflows/ci-petclinic-eks.yaml/badge.svg)](https://github.com/costRider/spring-petclinic/actions/workflows/ci-petclinic-eks.yaml)
[![Build Status](https://github.com/costRider/spring-petclinic/actions/workflows/ci-petclinic-gke.yaml/badge.svg)](https://github.com/costRider/spring-petclinic/actions/workflows/ci-petclinic-gke.yaml)
---
본 프로젝트는 **Spring Petclinic 애플리케이션**을 대상으로
**AWS(EKS)** 와 **GCP(GKE)** 두 CSP 환경에 동일한 서비스를 배포하고,
**GitHub Actions + ArgoCD 기반 GitOps 방식**으로 CI/CD를 구성한 멀티클라우드 예제입니다.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/spring-projects/spring-petclinic) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=7517918)
각 CSP별로:
- 컨테이너 레지스트리
- Kubernetes 매니페스트
- Secret / 인증 방식
- CI 파이프라인
## Understanding the Spring Petclinic application with a few diagrams
을 명확히 분리하여 운영하며, 실제 서비스 접속 및 **DB write 동작까지 검증 완료**된 상태입니다.
See the presentation here:
[Spring Petclinic Sample Application (legacy slides)](https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application?slide=20)
---
> **Note:** These slides refer to a legacy, pre–Spring Boot version of Petclinic and may not reflect the current Spring Boot–based implementation.
> For up-to-date information, please refer to this repository and its documentation.
## 1. 전체 아키텍처 개요
## Run Petclinic locally
Spring Petclinic is a [Spring Boot](https://spring.io/guides/gs/spring-boot) application built using [Maven](https://spring.io/guides/gs/maven/) or [Gradle](https://spring.io/guides/gs/gradle/).
Java 25 or later is required for the build, but the application can run with Java 17 or newer:
```bash
git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic
./mvnw package
java -jar target/*.jar
```
GitHub Repository (spring-petclinic)
├─ GitHub Actions (CI)
│ ├─ 공통: Maven Build & Test
│ ├─ AWS CI: ECR 이미지 Push
│ └─ GCP CI: GAR 이미지 Push
│
├─ Container Registry
│ ├─ AWS: Amazon ECR
│ └─ GCP: Artifact Registry
│
├─ ArgoCD (CD)
│ ├─ AWS EKS Cluster
│ └─ GCP GKE Cluster
│
└─ Kubernetes
├─ k8s/aws (EKS 전용 매니페스트)
└─ k8s/gcp (GKE 전용 매니페스트)
```
(On Windows, or if your shell doesn't expand the glob, you might need to specify the JAR file name explicitly on the command line at the end there.)
---
You can then access the Petclinic at <http://localhost:8080/>.
## 2. Repository 구조
<img width="1042" alt="petclinic-screenshot" src="https://cloud.githubusercontent.com/assets/838318/19727082/2aee6d6c-9b8e-11e6-81fe-e889a5ddfded.png">
```
.github/workflows
├─ ci-petclinic-eks.yaml
└─ ci-petclinic-gke.yaml
Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this, it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this):
```bash
./mvnw spring-boot:run
k8s/
├─ aws/
└─ gcp/
```
> NOTE: If you prefer to use Gradle, you can build the app using `./gradlew build` and look for the jar file in `build/libs`.
---
## Building a Container
## 3. GitHub Actions (CI)
There is no `Dockerfile` in this project. You can build a container image (if you have a docker daemon) using the Spring Boot build plugin:
### 공통
- Maven Build & Test
- Docker Image Build
- Commit SHA 기반 이미지 태그
```bash
./mvnw spring-boot:build-image
```
### AWS (EKS)
- 인증: GitHub OIDC → AWS IAM Role
- Registry: Amazon ECR
## In case you find a bug/suggested improvement for Spring Petclinic
### GCP (GKE)
- 인증: GitHub OIDC → GCP Workload Identity Federation
- Registry: Artifact Registry
Our issue tracker is available [here](https://github.com/spring-projects/spring-petclinic/issues).
---
## Database configuration
## 4. Kubernetes 매니페스트
In its default configuration, Petclinic uses an in-memory database (H2) which
gets populated at startup with data. The h2 console is exposed at `http://localhost:8080/h2-console`,
and it is possible to inspect the content of the database using the `jdbc:h2:mem:<uuid>` URL. The UUID is printed at startup to the console.
- AWS: `k8s/aws`
- GCP: `k8s/gcp`
A similar setup is provided for MySQL and PostgreSQL if a persistent database configuration is needed. Note that whenever the database type changes, the app needs to run with a different profile: `spring.profiles.active=mysql` for MySQL or `spring.profiles.active=postgres` for PostgreSQL. See the [Spring Boot documentation](https://docs.spring.io/spring-boot/how-to/properties-and-configuration.html#howto.properties-and-configuration.set-active-spring-profiles) for more detail on how to set the active profile.
CSP별 Ingress, Registry, Secret 차이로 매니페스트 분리
You can start MySQL or PostgreSQL locally with whatever installer works for your OS or use docker:
---
```bash
docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.2
```
## 5. Secret / DB
or
- AWS: Secrets Manager + RDS (PostgreSQL)
- GCP: Secret Manager + Cloud SQL (PostgreSQL)
- External Secrets Operator 사용
```bash
docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.0
```
---
Further documentation is provided for [MySQL](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources/db/mysql/petclinic_db_setup_mysql.txt)
and [PostgreSQL](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources/db/postgres/petclinic_db_setup_postgres.txt).
## 6. ArgoCD
Instead of vanilla `docker` you can also use the provided `docker-compose.yml` file to start the database containers. Each one has a service named after the Spring profile:
- AWS / GCP 각각 독립 ArgoCD
- GitHub Repo를 Source of Truth로 사용
- Git 변경 시 자동 배포
```bash
docker compose up mysql
```
---
or
## 7. 검증 완료 항목
```bash
docker compose up postgres
```
- CI 이미지 빌드 및 Push
- ArgoCD Sync
- 서비스 접속
- DB Read / Write 정상 동작
## Test Applications
---
At development time we recommend you use the test applications set up as `main()` methods in `PetClinicIntegrationTests` (using the default H2 database and also adding Spring Boot Devtools), `MySqlTestApplication` and `PostgresIntegrationTests`. These are set up so that you can run the apps in your IDE to get fast feedback and also run the same classes as integration tests against the respective database. The MySql integration tests use Testcontainers to start the database in a Docker container, and the Postgres tests use Docker Compose to do the same thing.
## 8. 정리
## Compiling the CSS
There is a `petclinic.css` in `src/main/resources/static/resources/css`. It was generated from the `petclinic.scss` source, combined with the [Bootstrap](https://getbootstrap.com/) library. If you make changes to the `scss`, or upgrade Bootstrap, you will need to re-compile the CSS resources using the Maven profile "css", i.e. `./mvnw package -P css`. There is no build profile for Gradle to compile the CSS.
## Working with Petclinic in your IDE
### Prerequisites
The following items should be installed in your system:
- Java 25 or newer (full JDK, not a JRE)
- [Git command line tool](https://help.github.com/articles/set-up-git)
- Your preferred IDE
- Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon in `Help -> About` dialog. If m2e is
not there, follow the install process [here](https://www.eclipse.org/m2e/)
- [Spring Tools Suite](https://spring.io/tools) (STS)
- [IntelliJ IDEA](https://www.jetbrains.com/idea/)
- [VS Code](https://code.visualstudio.com)
### Steps
1. On the command line run:
```bash
git clone https://github.com/spring-projects/spring-petclinic.git
```
1. Inside Eclipse or STS:
Open the project via `File -> Import -> Maven -> Existing Maven project`, then select the root directory of the cloned repo.
Then either build on the command line `./mvnw generate-resources` or use the Eclipse launcher (right-click on project and `Run As -> Maven install`) to generate the CSS. Run the application's main method by right-clicking on it and choosing `Run As -> Java Application`.
1. Inside IntelliJ IDEA:
In the main menu, choose `File -> Open` and select the Petclinic [pom.xml](pom.xml). Click on the `Open` button.
- CSS files are generated from the Maven build. You can build them on the command line `./mvnw generate-resources` or right-click on the `spring-petclinic` project then `Maven -> Generates sources and Update Folders`.
- A run configuration named `PetClinicApplication` should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right-clicking on the `PetClinicApplication` main class and choosing `Run 'PetClinicApplication'`.
1. Navigate to the Petclinic
Visit [http://localhost:8080](http://localhost:8080) in your browser.
## Looking for something in particular?
|Spring Boot Configuration | Class or Java property files |
|--------------------------|---|
|The Main Class | [PetClinicApplication](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java/org/springframework/samples/petclinic/PetClinicApplication.java) |
|Properties Files | [application.properties](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources) |
|Caching | [CacheConfiguration](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/java/org/springframework/samples/petclinic/system/CacheConfiguration.java) |
## Interesting Spring Petclinic branches and forks
The Spring Petclinic "main" branch in the [spring-projects](https://github.com/spring-projects/spring-petclinic)
GitHub org is the "canonical" implementation based on Spring Boot and Thymeleaf. There are
[quite a few forks](https://spring-petclinic.github.io/docs/forks.html) in the GitHub org
[spring-petclinic](https://github.com/spring-petclinic). If you are interested in using a different technology stack to implement the Pet Clinic, please join the community there.
## Interaction with other open-source projects
One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days.
Here is a list of them:
| Name | Issue |
|------|-------|
| Spring JDBC: simplify usage of NamedParameterJdbcTemplate | [SPR-10256](https://github.com/spring-projects/spring-framework/issues/14889) and [SPR-10257](https://github.com/spring-projects/spring-framework/issues/14890) |
| Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility |[HV-790](https://hibernate.atlassian.net/browse/HV-790) and [HV-792](https://hibernate.atlassian.net/browse/HV-792) |
| Spring Data: provide more flexibility when working with JPQL queries | [DATAJPA-292](https://github.com/spring-projects/spring-data-jpa/issues/704) |
## Contributing
The [issue tracker](https://github.com/spring-projects/spring-petclinic/issues) is the preferred channel for bug reports, feature requests and submitting pull requests.
For pull requests, editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org>. All commits must include a __Signed-off-by__ trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin.
For additional details, please refer to the blog post [Hello DCO, Goodbye CLA: Simplifying Contributions to Spring](https://spring.io/blog/2025/01/06/hello-dco-goodbye-cla-simplifying-contributions-to-spring).
## License
The Spring PetClinic sample application is released under version 2.0 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0).
본 프로젝트는 멀티클라우드 환경에서 GitOps 기반 CI/CD와
운영 분리를 어떻게 설계할 수 있는지를 보여주는 예제입니다.