synchronize petclinic

.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+{
+  "name": "Spring Petclinic Microservices",
+  // Java Development Container Images https://mcr.microsoft.com/en-us/product/devcontainers/java/tags
+  "image": "mcr.microsoft.com/devcontainers/java:17-bullseye",
+  // Features list https://containers.dev/features
+  "features": {
+    "ghcr.io/devcontainers/features/java:1": {
+      "installMaven": "true",
+      "installGradle": "false"
+    },
+    "ghcr.io/devcontainers/features/azure-cli:1":{}, // Install Azure CLI
+    "ghcr.io/devcontainers/features/docker-in-docker:2":{}, // install docker
+  },
+  "customizations": {
+    // Configure properties specific to VScode
+    "vscode": {
+      "settings": {
+        // VSCode settings https://github.com/redhat-developer/vscode-java/blob/master/README.md
+        "java.server.launchMode": "Standard"
+      },
+      "extensions":[
+        "vscjava.vscode-java-pack",
+        "vscjava.vscode-maven",
+        "github.vscode-github-actions",
+        "github.vscode-pull-request-github",
+        "redhat.vscode-xml",
+        "vmware.vscode-boot-dev-pack",
+        "mhutchie.git-graph"
+      ]
+    },
+  },
+  "forwardPorts": [8080, 8888, 8761]
+}

.gitattributes

@@ -0,0 +1 @@
+*.css linguist-generated=true

.gitignore

@@ -19,3 +19,5 @@ target/
 
 # Branch switching
 generated/
+
+**/.DS_Store

.mvn/wrapper/maven-wrapper.properties

@@ -14,5 +14,6 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.8/apache-maven-3.9.8-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar
+distributionSha256Sum=8351955a9acf2f83c136c4eee0f6db894ab6265fdbe0a94b32a380307dbaa3e1

README.md

@@ -1,4 +1,4 @@
-# Distributed version of the Spring PetClinic Sample Application built with Spring Cloud 
+# Distributed version of the Spring PetClinic Sample Application built with Spring Cloud and Spring AI
 
 [![Build Status](https://github.com/spring-petclinic/spring-petclinic-microservices/actions/workflows/maven-build.yml/badge.svg)](https://github.com/spring-petclinic/spring-petclinic-microservices/actions/workflows/maven-build.yml)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -7,15 +7,20 @@ This microservices branch was initially derived from [AngularJS version](https:/
 To achieve that goal, we use Spring Cloud Gateway, Spring Cloud Circuit Breaker, Spring Cloud Config, Micrometer Tracing, Resilience4j, Open Telemetry 
 and the Eureka Service Discovery from the [Spring Cloud Netflix](https://github.com/spring-cloud/spring-cloud-netflix) technology stack.
 
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/spring-petclinic/spring-petclinic-microservices)
+
+[![Open in Codeanywhere](https://codeanywhere.com/img/open-in-codeanywhere-btn.svg)](https://app.codeanywhere.com/#https://github.com/spring-petclinic/spring-petclinic-microservices)
+
 ## Starting services locally without Docker
 
-Every microservice is a Spring Boot application and can be started locally using IDE ([Lombok](https://projectlombok.org/) plugin has to be set up) or `../mvnw spring-boot:run` command. Please note that supporting services (Config and Discovery Server) must be started before any other application (Customers, Vets, Visits and API).
+Every microservice is a Spring Boot application and can be started locally using IDE or `../mvnw spring-boot:run` command.
+Please note that supporting services (Config and Discovery Server) must be started before any other application (Customers, Vets, Visits and API).
 Startup of Tracing server, Admin server, Grafana and Prometheus is optional.
 If everything goes well, you can access the following services at given location:
 * Discovery Server - http://localhost:8761
 * Config Server - http://localhost:8888
 * AngularJS frontend (API Gateway) - http://localhost:8080
-* Customers, Vets and Visits Services - random port, check Eureka Dashboard 
+* Customers, Vets, Visits and GenAI Services - random port, check Eureka Dashboard 
 * Tracing Server (Zipkin) - http://localhost:9411/zipkin/ (we use [openzipkin](https://github.com/openzipkin/zipkin/tree/main/zipkin-server))
 * Admin Server (Spring Boot Admin) - http://localhost:9090
 * Grafana Dashboards - http://localhost:3000
@@ -52,7 +57,7 @@ For instance, if you target container images for an Apple M2, you could use the
 ```
 
 Once images are ready, you can start them with a single command
-`docker-compose up` or `podman-compose up`. 
+`docker compose up` or `podman-compose up`. 
 
 Containers startup order is coordinated with the `service_healthy` condition of the Docker Compose [depends-on](https://github.com/compose-spec/compose-spec/blob/main/spec.md#depends_on) expression 
 and the [healthcheck](https://github.com/compose-spec/compose-spec/blob/main/spec.md#healthcheck) of the service containers. 
@@ -79,13 +84,62 @@ Each of the java based applications is started with the `chaos-monkey` profile i
 
 You can then access petclinic here: http://localhost:8080/
 
+## Microservices Overview
+
+This project consists of several microservices:
+- **Customers Service**: Manages customer data.
+- **Vets Service**: Handles information about veterinarians.
+- **Visits Service**: Manages pet visit records.
+- **GenAI Service**: Provides a chatbot interface to the application.
+- **API Gateway**: Routes client requests to the appropriate services.
+- **Config Server**: Centralized configuration management for all services.
+- **Discovery Server**: Eureka-based service registry.
+
+Each service has its own specific role and communicates via REST APIs.
+
+
 ![Spring Petclinic Microservices screenshot](docs/application-screenshot.png)
 
 
 **Architecture diagram of the Spring Petclinic Microservices**
 
 ![Spring Petclinic Microservices architecture](docs/microservices-architecture-diagram.jpg)
 
+## Integrating the Spring AI Chatbot
+
+Spring Petclinic integrates a Chatbot that allows you to interact with the application in a natural language. Here are some examples of what you could ask:
+
+1. Please list the owners that come to the clinic.
+2. Are there any vets that specialize in surgery?
+3. Is there an owner named Betty?
+4. Which owners have dogs?
+5. Add a dog for Betty. Its name is Moopsie.
+6. Create a new owner.
+
+![Screenshot of the chat dialog](docs/spring-ai.png)
+
+This `spring-petlinic-genai-service` microservice currently supports **OpenAI** (default) or **Azure's OpenAI** as the LLM provider.
+In order to start the microservice, perform the following steps:
+
+1. Decide which provider you want to use. By default, the `spring-ai-openai-spring-boot-starter` dependency is enabled. 
+   You can change it to `spring-ai-azure-openai-spring-boot-starter`in the `pom.xml`.
+2. Create an OpenAI API key or a Azure OpenAI resource in your Azure Portal.
+   Refer to the [OpenAI's quickstart](https://platform.openai.com/docs/quickstart) or [Azure's documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/) for further information on how to obtain these.
+   You only need to populate the provider you're using - either openai, or azure-openai.
+   If you don't have your own OpenAI API key, don't worry!
+   You can temporarily use the `demo` key, which OpenAI provides free of charge for demonstration purposes.
+   This `demo` key has a quota, is limited to the `gpt-4o-mini` model, and is intended solely for demonstration use.
+   With your own OpenAI account, you can test the `gpt-4o` model by modifying the `deployment-name` property of the `application.yml` file.
+3. Export your API keys and endpoint as environment variables:
+    * either OpenAI:
+    ```bash
+    export OPENAI_API_KEY="your_api_key_here"
+    ```
+    * or Azure OpenAI:
+    ```bash
+    export AZURE_OPENAI_ENDPOINT="https://your_resource.openai.azure.com"
+    export AZURE_OPENAI_KEY="your_api_key_here"
+    ```
 
 ## In case you find a bug/suggested improvement for Spring Petclinic Microservices
 
@@ -207,6 +261,17 @@ Be sure to turn on "Use containerd for pulling and storing images" in the Docker
 The `scripts/pushImages.sh` and `scripts/tagImages.sh` shell scripts could also be used once you build your image with the `buildDocker` maven profile.
 The `scripts/tagImages.sh` requires to declare the `VERSION` env variable.
 
+## Compiling the CSS
+
+There is a `petclinic.css` in `spring-petclinic-api-gateway/src/main/resources/static/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` of the `spring-petclinic-api-gateway`module.
+```bash
+cd spring-petclinic-api-gateway
+mvn generate-resources -P css
+```
+
 ## Interesting Spring Petclinic forks
 
 The Spring Petclinic `main` branch in the main [spring-projects](https://github.com/spring-projects/spring-petclinic)
@@ -228,7 +293,11 @@ For pull requests, editor preferences are available in the [editor config](.edit
 [Configuration repository]: https://github.com/spring-petclinic/spring-petclinic-microservices-config
 [Spring Boot Actuator Production Ready Metrics]: https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-metrics.html
 
-# InspectIT related Stuff
+## Supported by
+
+[![JetBrains logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
+
+# InspectIT related stuff
 
 ## Soap Service Testing
 For more information about testing the custom soap service and client, please refer to the [README](spring-petclinic-soap-service/README.md) in the soap folder.

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   config-server:
     image: inspectit/spring-petclinic-config-server:${INSPECTIT_PETCLINIC_VERSION}
@@ -79,6 +77,25 @@ services:
     ports:
      - 8083:8083
 
+  genai-service:
+    image: springcommunity/spring-petclinic-genai-service
+    container_name: genai-service
+    environment:
+      - OPENAI_API_KEY=${OPENAI_API_KEY}
+      - AZURE_OPENAI_KEY=${AZURE_OPENAI_KEY}
+      - AZURE_OPENAI_ENDPOINT=${AZURE_OPENAI_ENDPOINT}
+    deploy:
+      resources:
+        limits:
+          memory: 512M
+    depends_on:
+      config-server:
+        condition: service_healthy
+      discovery-server:
+        condition: service_healthy
+    ports:
+      - 8084:8084
+
   soap-service:
     image: inspectit/spring-petclinic-soap-service:${INSPECTIT_PETCLINIC_VERSION}
     container_name: soap-service
@@ -92,7 +109,7 @@ services:
       discovery-server:
         condition: service_healthy
     ports:
-     - 8877:8877
+      - 8877:8877
 
   soap-client:
     image: inspectit/spring-petclinic-soap-client:${INSPECTIT_PETCLINIC_VERSION}
@@ -132,7 +149,8 @@ services:
         limits:
           memory: 512M
     environment:
-    - JAVA_OPTS=-XX:+UnlockExperimentalVMOptions -Djava.security.egd=file:/dev/./urandom
+    # Waiting for https://github.com/openzipkin/zipkin/issues/3786
+    - JAVA_OPTS=-XX:UseSVE=0
     ports:
      - 9411:9411
 
@@ -161,7 +179,7 @@ services:
         limits:
           memory: 256M
     ports:
-    - 3000:3000
+    - 3030:3030
 
   prometheus-server:
     build: ./docker/prometheus

docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM eclipse-temurin:17 as builder
+FROM eclipse-temurin:17 AS builder
 WORKDIR application
 ARG ARTIFACT_NAME
 COPY ${ARTIFACT_NAME}.jar application.jar
@@ -11,7 +11,7 @@ WORKDIR application
 ARG EXPOSED_PORT
 EXPOSE ${EXPOSED_PORT}
 
-ENV SPRING_PROFILES_ACTIVE docker
+ENV SPRING_PROFILES_ACTIVE=docker
 
 COPY --from=builder application/dependencies/ ./