✨ 🔧 Configure Cloud Run deployment (#37)

* 🔧 Configure Cloud Run & update doc

Author: jeanphi-baconnais

.env-example

@@ -1,2 +1,3 @@
-# This is an example of env file.
-github.token=<set your token here>
+%dev.github.token=<your-token>
+quarkus.langchain4j.mcp.github.environment.GITHUB_PERSONAL_ACCESS_TOKEN=<your-token>>
+GITHUB_TOKEN=<your-token>>

.gcloudignore

@@ -0,0 +1,7 @@
+.git/
+.gitignore
+.env
+.vscode/
+.dockerignore
+*.md
+.agents/

Dockerfile

@@ -8,7 +8,7 @@ COPY target/quarkus-app/*.jar /deployments/
 COPY target/quarkus-app/app/ /deployments/app/
 COPY target/quarkus-app/quarkus/ /deployments/quarkus/
 
-EXPOSE 8080 8888
-ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
+EXPOSE 8080
+ENV JAVA_OPTS="-Dquarkus.http.port=8081 -Djavelit.port=8080 -Djavelit.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
 ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
 ENTRYPOINT [ "/bin/sh", "-c", "java $JAVA_OPTS -jar $JAVA_APP_JAR" ]

README.md

@@ -39,7 +39,7 @@ An interface made with Javelit is available.
 
 > 🎯 The last resource will be removed after implementing all features and will be replaced by schedules. 
 
-## 📝 Setup 
+## 📝 Local Setup 
 
 - You need a GitHub token you can generate on [this page](https://github.com/settings/tokens).
 - Create a `.env` file based on the `.env-example` file and set the token previously created. 
@@ -63,12 +63,27 @@ Then run the container mapping the ports (8080 for API, 8888 for UI) and mountin
 
 ```bash
 docker run -it --rm \
-  -p 8080:8080 -p 8888:8888 \
+  -p 8080:8081 \
   -v "$(pwd)/.gcloud-conf.json:/etc/gcp/creds.json:ro" \
+  --env-file .env \
   -e GOOGLE_APPLICATION_CREDENTIALS=/etc/gcp/creds.json \
   zoss-dashboard
 ```
 
+## ⛅ Deploy on Cloud Run 
+
+This project can be deployed on [Cloud Run](https://cloud.google.com/run) with this command: 
+
+```bash
+  gcloud run deploy zenika-opensource-statistics \
+   --source . \
+   --region $GOOGLE_CLOUD_LOCATION \
+   --project $GOOGLE_CLOUD_PROJECT_ID \
+   --allow-unauthenticated \
+   --memory 1Gi \
+   --max-instances 1
+```
+
 ## ✨Contribute 
 
 Anyone can contribute to this project. For the moment, please add your question or propose something in [a new issue](https://github.com/zenika-open-source/opensource-statistics/issues).

pom.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>org.acme</groupId>
+  <groupId>zenika.opensource</groupId>
   <artifactId>oss-stats</artifactId>
   <version>1.3.0</version>
   <properties>

src/main/java/zenika/oss/stats/config/GitHubClient.java

@@ -20,7 +20,7 @@
 public interface GitHubClient {
 
     default String prepareToken() {
-        String token = ConfigProvider.getConfig().getValue("github.token", String.class);
+        String token = ConfigProvider.getConfig().getOptionalValue("github.token", String.class).orElse("");
         return "Bearer " + token;
     }
 

src/main/java/zenika/oss/stats/services/GitHubServices.java

@@ -29,6 +29,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
+import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 import java.util.stream.Collectors;
 
@@ -51,15 +52,15 @@ public class GitHubServices {
     String graphQLUrl;
 
     @ConfigProperty(name = "github.token")
-    String githubToken;
+    Optional<String> githubToken;
 
     DynamicGraphQLClient dynamicGraphQLClient;
 
     @PostConstruct
     public void init() {
         dynamicGraphQLClient = DynamicGraphQLClientBuilder.newBuilder()
                 .url(graphQLUrl)
-                .header("Authorization", "Bearer " + githubToken)
+                .header("Authorization", "Bearer " + githubToken.orElse(""))
                 .build();
     }
 

src/main/java/zenika/oss/stats/ui/JavelitDashboard.java

@@ -13,9 +13,15 @@
 
 import java.util.List;
 
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+
+
 @ApplicationScoped
 public class JavelitDashboard {
 
+    @ConfigProperty(name = "javelit.port", defaultValue = "8888")
+    int port;
+
     @Inject
     MembersTab membersTab;
 
@@ -43,6 +49,6 @@ void onStart(@Observes StartupEvent ev) {
             contributionsTab.render(tabs.tab("📊 Contributions"));
             statsTab.render(tabs.tab("📈 Stats"));
 
-        }, 8888).build().start();
+        }, port).build().start();
     }
 }

src/main/resources/application.properties

@@ -1,6 +1,7 @@
 
 quarkus.datasource.db-kind=postgresql
 quarkus.datasource.jdbc.url=jdbc:postgresql:///mydatabase
+quarkus.http.port=8081
 quarkus.datasource.username=quarkus
 quarkus.datasource.password=quarkus
 quarkus.datasource.jdbc.additional-jdbc-properties.cloudSqlInstance=project-id:gcp-region:instance
@@ -15,6 +16,7 @@ organization.name=zenika-open-source
 
 # GitHub API configuration
 %test.github.token=test
+github.token=
 
 quarkus.rest-client.github-api.url=https://api.github.com/
 quarkus.smallrye-graphql-client.github-api.url=https://api.github.com/graphql