Merge pull request #49 from dwasinge/master

Hide GitLab Details from Clients

Author: dwasinge

README.md

@@ -1,66 +1,126 @@
 ![Container Build](https://github.com/rht-labs/open-management-portal-git-api/workflows/Container%20Build/badge.svg)
 
-# open-management-portal-git-api project
+# Open Management Portal - Git API
 
-This project uses Quarkus, the Supersonic Subatomic Java Framework.
-If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
+The Git API for the Open Management Portal.
 
-## Running the application
+This API uses GitLab as a repository to store OMP resources.
 
-Prior to running the app, you need to create a **Personal Access Token** linked to your GitLab account.
+## JSON REST APIs
+
+The JSON REST APIs consist of the following resources:
+
+* Config
+* Engagements
+* Version
+
+### Config Resource
+
+The config resource exposes an API that allows clients to retrieve a configured `Config` file from GitLab.
 
-You could edit your bash profile and make your Quarkus quacky by adding this neat emoji alias, then all you need to fire up your  app is run 🦆
 ```
-echo "alias 🦆='./mvnw quarkus:dev -Dquarkus.http.port=8080'" >> ~/.zshrc
-source ~/.zshrc
+GET  /api/v1/config
+```
 
-🦆
+### Engagement Resource
+
+The engagement resource exposes an API that allows clients to create or update and engagement resource in GitLab.
+
+```
+POST /api/v1/engagements
 ```
 
-### Running with a profile 
+This endpoint will create the expected group/project structure in GitLab.  Then, will update the `engagement.json` file if it already exists or create it if it does not.
+
+### Version Resource
+
+The version resource exposes an API that allows a client to determine which version of the application is deployed.
 
-You can run your application using Quarkus profiles using:
 ```
-export CONFIG_REPOSITORY_ID =<Git Repo id where the config files are>
-export GITLAB_API_URL=<The base url of your git api. ie https://gitlab.com>
-export GITLAB_PERSONAL_ACCESS_TOKEN=<GitLab Personal Access Token>
-export OMP_LOGGING=DEBUG
-export RESIDENCIES_PARENT_REPOSITORIES_ID=<Parent project id where repos will be saved>
-export TEMPLATE_REPOSITORY_ID=<Repo where template live>
-export QUARKUS_PROFILE=<Quarkus profile>
-./mvnw clean package
-java -jar target/open-management-portal-git-api-*-runner.jar
+GET  /api/v1/version
 ```
 
-## Packaging and running the application
+## Configuration
+
+The preferred place to store non-sensitive data is in the application.properties.
 
-The application is packageable using `./mvnw package`.
-It produces the executable `open-management-portal-git-api-1.0.0-SNAPSHOT-runner.jar` file in `/target` directory.
-Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/lib` directory.
+Sensitive fields like the gitlab token and cluster credentials should be stored in a OpenShift secret at a minimum. Other environment specific information should be stored in environmental variables such as repository id for engagements and repository id for the config.
 
-The application is now runnable using `java -jar target/open-management-portal-git-api-1.0.0-SNAPSHOT-runner.jar`.
+Deployment template will read from the above secret and inject following env variables. These are controlled from application.properties, so if a different env name is needed, change in the application properties file and the deployment template.
 
-## Creating a native executable
+### Logging
 
-You can create a native executable using: `./mvnw package -Pnative`.
+| Name | Example Value | Required |
+|------|---------------|----------|
+| OMP_LOGGING | DEBUG | False |
 
-Or you can use Podman to build the native executable using: `./mvnw package -Pnative -Dquarkus.native.container-runtime=podman`.
+### GitLab
 
-You can then execute your binary: `./target/open-management-portal-git-api-1.0.0-SNAPSHOT-runner`
+| Name | Example Value | Required |
+|------|---------------|----------|
+| GITLAB_API_URL | https://acmegit.com | True |
+| DEPLOY_KEY | 0 | True |
 
-If you want to learn more about building native executables, please consult https://quarkus.io/guides/building-native-image-guide .
+### Config Resource 
 
+| Name | Example Value | Required |
+|------|---------------|----------|
+| CONFIG_REPOSITORY_ID | 1 | True |
+| CONFIG_FILE | my-config.yml | True |
 
-## Configuration
+### Engagements Resource
 
-The preferred place to store non-sensitive data is in the application.properties.
+| Name | Example Value | Required |
+|------|---------------|----------|
+| ENGAGEMENTS_REPOSITORY_ID | 2 | True |
 
-Sensitive fields like the gitlab token and cluster credentials should be stored in a OpenShift secret at a minimum. Other environment specific information should be stored in environmental variables such as repository id for residencies and repository id for the config.
+### Version Resource
 
-Deployment template will read from the above secret and inject following env variables. These are controlled from application.properties, so if a different env name is needed, change in the application properties file and the deployment template.
+| Name | Example Value | Required |
+|------|---------------|----------|
+| GIT_API_GIT_COMMIT | a2adfk | False |
+| GIT_API_GIT_TAG | v1.2 | False |
+
+## Development
 
-* `TEMPLATE_REPOSITORY_ID`
-* `RESIDENCIES_PARENT_REPOSITORIES_ID`
-* `GITLAB_API_URL`
-* `GITLAB_PERSONAL_ACCESS_TOKEN` (should be secret and a service account)
+See [the deployment README](deployment/README.md) for details on how to spin up a deployment for developing on OpenShift.
 
+
+## Running the application
+
+Prior to running the app, you need to create a **Personal Access Token** linked to your GitLab account.
+
+You could edit your bash profile and make your Quarkus quacky by adding this neat emoji alias, then all you need to fire up your  app is run 🦆
+```
+echo "alias 🦆='./mvnw quarkus:dev -Dquarkus.http.port=8080'" >> ~/.zshrc
+source ~/.zshrc
+
+🦆
+```
+
+### Running the Application 
+
+You can run your application using Quarkus using:
+
+```
+
+# logging
+export OMP_LOGGING=DEBUG
+
+# gitlab
+export GITLAB_API_URL=<The base url of your git api. ie https://gitlab.com>
+export GITLAB_PERSONAL_ACCESS_TOKEN=<GitLab Personal Access Token>
+export DEPLOY_KEY=<Deployment Key for Engagements>
+
+# config 
+export CONFIG_REPOSITORY_ID=<Git Repo id where the config files are>
+
+# engagements
+export ENGAGEMENTS_REPOSITORY_ID=<Parent project id where repos will be saved>
+
+# package the application
+./mvnw clean package
+
+# run the application
+java -jar target/open-management-portal-git-api-*-runner.jar
+```

deployment/README.md

@@ -31,14 +31,12 @@ helm template . \
   --values values-dev.yaml \
   --set git.uri=https://github.com/rht-labs/open-management-portal-git-api.git \
   --set git.ref=master \
+  --set configFile=<your-config-file> \
   --set configRepositoryId=<your-config-repository-id> \
   --set deployKey=<your-gitlab-deploy-key-id> \
   --set gitLabApiUrl=<your-gitlab-base-url> \
   --set gitLabPersonalAccessToken=<your-gitlab-personal-access-token> \
-  --set jwtVerifyPublicKeyLocation=<your-openid-connect-cert-url> \
-  --set residenciesParentRepositoryId=<your-gitlab-group-id> \
-  --set templateRepositoryId=<your-template-repository-id> \
-  --set trustedClientKey=<your-trusted-client-key> \
+  --set engagementsRepositoryId=<your-gitlab-group-id> \
 | oc apply -f -
 ```
 
@@ -48,13 +46,11 @@ It accepts the following variables
 |---|---|
 | `git.uri`  | The HTTPS reference to the repo (your fork!) to build  |
 | `git.ref`  | The branch name to build  |
+| `configFile` | The path including name of the config file |
 | `configRepositoryId`  | The GitLab ID of the config repository  |
 | `deployKey`  | The ID of the GitLab deploy key to enable on newly-created repositories  |
 | `gitLabApiUrl`  | The base URL of the GitLab instance to use  |
 | `gitLabPersonalAccessToken`  | The access token to use to auth against GitLab  |
-| `jwtVerifyPublicKeyLocation`  | The URL at which your OpenID Connect (SSO) provider exposes its public key  |
-| `residenciesParentRepositoryId`  | The ID of the GitLab group under which to create new projects  |
-| `templateRepositoryId`  | The ID of the GitLab repository which defines a template to use for creating new repos  |
-| `trustedClientKey`  | [Temporary] Used as a placeholder to authenticate client requests, being replaced by validating JWT tokens against the `jwtVerifyPublicKeyLocation` |
+| `engagementsRepositoryId`  | The ID of the GitLab group under which to create new projects  |
 
 This will spin up all of the usual resources that this service needs in production, plus a `BuildConfig` configured to build it from source from the Git repository specified. To trigger this build, use `oc start-build omp-git-api`.

deployment/templates/gitlab-secret.yaml

@@ -5,15 +5,10 @@ metadata:
   name: omp-gitlab-configuration
 type: Opaque
 stringData:
-  CACHE_SERVICE: "{{ .Values.cacheService }}"
-  CACHE_USE_AUTH: "{{ .Values.cacheUseAuth }}"
+  CONFIG_FILE: "{{ .Values.configFile }}"
   CONFIG_REPOSITORY_ID: "{{ .Values.configRepositoryId }}"
   DEPLOY_KEY: "{{ .Values.deployKey }}"
   GITLAB_API_URL: "{{ .Values.gitLabApiUrl }}"
   GITLAB_PERSONAL_ACCESS_TOKEN: "{{ .Values.gitLabPersonalAccessToken }}"
-  MP_JWT_VERIFY_PUBLICKEY_LOCATION: >-
-    {{ .Values.jwtVerifyPublicKeyLocation }}
-  RESIDENCIES_PARENT_REPOSITORIES_ID: "{{ .Values.residenciesParentRepositoryId }}"
-  TEMPLATE_REPOSITORY_ID: "{{ .Values.templateRepositoryId }}"
-  TRUSTED_CLIENT_KEY: "{{ .Values.trustedClientKey }}"
+  ENGAGEMENTS_REPOSITORY_ID: "{{ .Values.engagementsRepositoryId }}"
 {{- end }}

deployment/values-dev.yaml

@@ -13,11 +13,9 @@ git:
   uri: https://github.com/rht-labs/open-management-portal-git-api.git
   ref: master
 
+configFile: false
 configRepositoryId: false
 deployKey: false
 gitLabApiUrl: false
 gitLabPersonalAccessToken: false
-jwtVerifyPublicKeyLocation: false
-residenciesParentRepositoryId: false
-templateRepositoryId: false
-trustedClientKey: false
+engagementsRepositoryId: false

src/main/java/com/redhat/labs/omp/resource/ConfigResource.java

@@ -0,0 +1,26 @@
+package com.redhat.labs.omp.resource;
+
+import javax.inject.Inject;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+import com.redhat.labs.omp.models.gitlab.File;
+import com.redhat.labs.omp.service.ConfigService;
+
+@Path("/api/v1/config")
+@Produces(MediaType.APPLICATION_JSON)
+@Consumes(MediaType.APPLICATION_JSON)
+public class ConfigResource {
+
+    @Inject
+    ConfigService configService;
+
+    @GET
+    public File get() {
+        return configService.getConfigFile();
+    }
+
+}