Add configurable base context to angular and spring app #357

fhopfensperger · 2021-03-05T12:14:01Z

This PR allows to configure a subcontext (sub http path) for the Angular and Spring boot app and Keycloak. For example, the services then listen to the following urls: https://example.com/mock-server/auth/ & https://example.com/mock-server/microcks/

Work is still in progress, but I already have a working deployment up and running on my Azure Kubernetes cluster with Istio.

Signed-off-by: Florian Hopfensperger florian.hopfensperger@de.ibm.com

lbroudoux · 2021-03-09T15:50:34Z

Hi @fhopfensperger

Could you explain the motivation with this PR? We had previous discussion (like for example in #320) about that and ended-up with it not being a harde requirement because you could mostly always find a gateway configuration to handle that. Is there some specific issues we wouldn't be able to handle ?

PR seems to involve a large set of resources...

lbroudoux

Had some questions about required changes ...
Also it would be nice removing unnecessary formatting changes (like introduced spaces or new lines) to ease-up a complete review later.

lbroudoux · 2021-03-09T15:52:09Z

webapp/src/main/resources/config/application.properties

+keycloak.cors=true
+keycloak.cors-max-age=3600
+keycloak.cors-allowed-methods=POST, PUT, DELETE, GET, OPTIONS


Could you explain why this is required?

I noticed that all APIs that are secured by Keycloak could no longer be called locally by the Angular app in development mode. Background is (see comment on proxy.conf), the angular app is accessible at http://localhost:4200 and the spring boot app is accessible at http://localhost:8080. So we would have a CORS issue. Link to the Keycloak issue.

lbroudoux · 2021-03-09T15:53:58Z

webapp/src/main/webapp/angular.json

-            "browserTarget": "microcks-ui:build",
-            "proxyConfig": "proxy.conf.json"
-          },
+            "browserTarget": "microcks-ui:build"          },


proxy.conf.json is necessary while in development mode. I use ng serve to serve the frontend with hot-reload and backend is ran with mvn spring-boot:run

Actually i do the same with ng serve and mvn spring-boot:run but I changed that the Angular services do not use the hardcoded /api/ path instead the (https://github.com/fhopfensperger/microcks/blob/4e3abe87d93030588c2ebc6bd50f115db4a5282c/webapp/src/main/webapp/src/app/services/importers.service.ts#L27) services load the actual address + path from the environment. Because of this I have configured the environment.ts file and removed the not longer needed proxy.conf.json:

export const environment = { production: false, apiUrl: 'http://localhost:8080/', baseContext: '/' };

But something just comes to my mind, we could define in the environment only the / as apiUrl and keep the proxy.conf. Maybe we can fix the CORS issue as well. If you want I can try it out.

lbroudoux · 2021-03-09T15:57:30Z

webapp/src/main/webapp/src/main.ts

+    console.log = () => { };
+    console.warn = () => { };
+    console.error = () => { };


Great idea but I would have let console.error though.. to be sure to grab critical messages.

lbroudoux · 2021-03-09T15:58:29Z

webapp/README.md

@@ -4,7 +4,7 @@ For development purposes, frontend GUI and backend APIs have been separated and
 * Frontend is an Angular 6 application served by `ng serve` with livereload enabled,
 * Backend is a Spring Boot application served by Boot internal server

-We also need a Keycloak server running on port `8180`. 
+We also need a Keycloak server running on port `8180`. You can run the Keycloak server as a container from docker-compose, just adjust the exposed port to `8180`.


lbroudoux · 2021-03-09T15:58:39Z

webapp/README.md

@@ -25,7 +25,7 @@ $ ./standalone.sh -Djboss.socket.binding.port-offset=100
 In a terminal, start frontend GUI server using NG :

 ```
-$ cd src/main/webapp
+$ cd webapp/src/main/webapp


lbroudoux · 2021-03-09T15:59:14Z

webapp/src/main/resources/config/application.properties

Don't understand why this should be now necessary ... 🤔

By default (baeldung) Spring doesn't serve static files from /deployments/asssets/* .
I use this path to mount a ConfigMap (which holds the Angular environment configuration) as a volume to the running pod. Which then allow the Angular App to get the Backend URL and other configuration properties.

https://github.com/fhopfensperger/microcks/blob/4e3abe87d93030588c2ebc6bd50f115db4a5282c/install/kubernetes/microcks/templates/configmap.yaml#L390
https://github.com/fhopfensperger/microcks/blob/4e3abe87d93030588c2ebc6bd50f115db4a5282c/webapp/src/main/webapp/src/environments/environment-loader.ts#L8
https://github.com/fhopfensperger/microcks/blob/4e3abe87d93030588c2ebc6bd50f115db4a5282c/install/kubernetes/microcks/templates/deployment.yaml#L114

fhopfensperger · 2021-03-09T16:36:08Z

Hi @lbroudoux
First of all thank you for the great product. You really surprised me now because at the moment I'm still working on the helm chart when my daily business allows it.

Main reason for the PR was the fact that I have a Kubernetes cluster that has a single external DNS. The DNS entry is routed to the Istio ingress gateway, which then decides which service to route the request to based on sub-path. So unfortunately I cannot implement what has been described in #320, because I don't "have" an "typical" ingress controller. Also when I started the PR, there was no solution for the issue. 😅

Right now I have the implementation running in an AKS cluster and am in the process of testing the same locally on my minikube and CRC with and without sub path.

Hi @fhopfensperger

Could you explain the motivation with this PR? We had previous discussion (like for example in #320) about that and ended-up with it not being a harde requirement because you could mostly always find a gateway configuration to handle that. Is there some specific issues we wouldn't be able to handle ?

PR seems to involve a large set of resources...

fhopfensperger · 2021-03-09T16:37:28Z

Had some questions about required changes ...
Also it would be nice removing unnecessary formatting changes (like introduced spaces or new lines) to ease-up a complete review later.

Would love to fix the formatting issues, what type of formatter do you use for the Typescript and Java code?

fhopfensperger · 2021-03-11T12:08:59Z

Short update from my side. The current implementation (Rest Mocking functionality) has been successfully tested on the following platforms and ingress types:

Azure Kubernetes Service: Istio Ingressgateway with workload routing based on a base context like /mock-server/microcks/ using VirtualServices
Minikube: Ingress Nginx with and without base context
OpenShift on IBM Cloud: OpenShift Router with TLS edge-termination; with and without base context

I have not tested the Async and the Testing feature. Could you please help me with this? If you want to test the current implementation yourself, feel free to use the container image docker.io/fhopfensperger/microcks:1.1.0. (Please ignore the tag that I just randomly selected).

Because: - Allows ingress subpath configuration - Avoids separate external dns names for services Signed-off-by: Florian Hopfensperger <florian.hopfensperger@de.ibm.com>

keiranbatten-nzta · 2023-05-09T23:47:14Z

@fhopfensperger @lbroudoux what is the reason for the inactivity on this PR?

lbroudoux · 2023-05-10T12:22:48Z

Hi,
We didn't have any other requests for this feature and focused on some other ones. Is this something that would be still useful?

lbroudoux · 2023-05-10T12:24:48Z

I just updated to branch 1.7.x where current development goes to refresh the impact of the Pull Request

keiranbatten-nzta · 2023-05-10T19:41:34Z

Hi,

Thanks for your response. I would definitely find this useful. We are looking to deploy in Azure Kubernetes Service using application gateway ingress controller and the only option we have is to run it at a different context path than root. Keycloak now supports this using the --hostname-url and --admin-hostname-url options in the start command or similarly by setting environment variables.

lbroudoux · 2023-05-10T21:37:41Z

Great! As I think I've been too long to answer to keep @fhopfensperger in the loop - sorry for that! - I'd need some help for review, testing and validation.

@keiranbatten-nzta Would you be ready to help on that tasks if I push this one up?

fhopfensperger force-pushed the add_configurable_contextpath branch 2 times, most recently from 3511af7 to 4e3abe8 Compare March 7, 2021 07:54

lbroudoux reviewed Mar 9, 2021

View reviewed changes

fhopfensperger force-pushed the add_configurable_contextpath branch 4 times, most recently from 14adaf7 to 1c861cb Compare March 11, 2021 11:47

Add configurable base context to angular and spring app

39e0a7c

Because: - Allows ingress subpath configuration - Avoids separate external dns names for services Signed-off-by: Florian Hopfensperger <florian.hopfensperger@de.ibm.com>

fhopfensperger force-pushed the add_configurable_contextpath branch from 1c861cb to 39e0a7c Compare March 11, 2021 12:15

fhopfensperger changed the title ~~WIP: Add configurable base context to angular and spring app~~ Add configurable base context to angular and spring app Mar 15, 2021

fhopfensperger requested a review from lbroudoux March 25, 2021 07:25

lbroudoux changed the base branch from master to 1.7.x May 10, 2023 12:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add configurable base context to angular and spring app #357

Add configurable base context to angular and spring app #357

fhopfensperger commented Mar 5, 2021

lbroudoux commented Mar 9, 2021

lbroudoux left a comment •

edited

lbroudoux Mar 9, 2021

fhopfensperger Mar 9, 2021

lbroudoux Mar 9, 2021

fhopfensperger Mar 9, 2021

fhopfensperger Mar 9, 2021

lbroudoux Mar 9, 2021

lbroudoux Mar 9, 2021

lbroudoux Mar 9, 2021

lbroudoux Mar 9, 2021

fhopfensperger Mar 9, 2021

fhopfensperger commented Mar 9, 2021

fhopfensperger commented Mar 9, 2021

fhopfensperger commented Mar 11, 2021 •

edited

keiranbatten-nzta commented May 9, 2023

lbroudoux commented May 10, 2023 •

edited

lbroudoux commented May 10, 2023

keiranbatten-nzta commented May 10, 2023

lbroudoux commented May 10, 2023

Add configurable base context to angular and spring app #357

Are you sure you want to change the base?

Add configurable base context to angular and spring app #357

Conversation

fhopfensperger commented Mar 5, 2021

lbroudoux commented Mar 9, 2021

lbroudoux left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fhopfensperger commented Mar 9, 2021

fhopfensperger commented Mar 9, 2021

fhopfensperger commented Mar 11, 2021 • edited

keiranbatten-nzta commented May 9, 2023

lbroudoux commented May 10, 2023 • edited

lbroudoux commented May 10, 2023

keiranbatten-nzta commented May 10, 2023

lbroudoux commented May 10, 2023

lbroudoux left a comment •

edited

fhopfensperger commented Mar 11, 2021 •

edited

lbroudoux commented May 10, 2023 •

edited