re-work ref impl to use path based routing instead (#169)

Signed-off-by: Manabu McCloskey <[email protected]>

Author: nabuskey

.devcontainer/devcontainer.json

@@ -8,5 +8,8 @@
   },
   "postCreateCommand": ".devcontainer/postCreateCommand.sh",
   "workspaceFolder": "/home/vscode/idpbuilder",
-  "workspaceMount": "source=${localWorkspaceFolder},target=/home/vscode/idpbuilder,type=bind"
+  "workspaceMount": "source=${localWorkspaceFolder},target=/home/vscode/idpbuilder,type=bind",
+  "hostRequirements": {
+    "cpus": 4
+  }
 }

examples/ref-implementation/README.md

@@ -18,15 +18,20 @@ Ensure you have the following tools installed on your computer.
 
 ## Installation
 
+**_NOTE:_**
+- If you'd like to run this in your web browser through Codespaces, please follow [the instructions here](./codespaces.md) to install instead. 
+
+- _This example assumes that you run the reference implementation with the default port configguration of 8443 for the idpBuilder.
+If you happen to configure a different host or port for the idpBuilder, the manifests in the reference example need to be updated
+and be configured with the new host and port. you can use the [replace.sh](replace.sh) to change the port as desired prior to applying the manifest as instructed in the command above._
+
 Run the following command from the root of this repository.
 
 ```bash
-idpbuilder create --package-dir examples/ref-implementation
+idpbuilder create --use-path-routing --package-dir examples/ref-implementation
 ```
 
-This will take ~6 minutes for everything to come up. To track the progress, you can go to the [ArgoCD UI](https://argocd.cnoe.localtest.me:8443/applications).
-
-**_NOTE:_**: _This example assumes that you run the reference implementation with the default port configguration of 8443 for the idpBuilder. If you happen to configure a different port for the idpBuilder, the manifests in the reference example need to be updated and be configured with the new port. you can use the [replace-port.sh](replace-port.sh) to change the port as desired prior to applying the manifest as instructed in the command above._
+This will take ~6 minutes for everything to come up. To track the progress, you can go to the [ArgoCD UI](https://cnoe.localtest.me:8443/argocd/applications).
 
 ### What was installed?
 
@@ -49,15 +54,15 @@ The only package that cannot be removed this way is Keycloak because other packa
 
 
 #### Accessing UIs
-- Argo CD: https://argocd.cnoe.localtest.me:8443
-- Argo Workflows: https://argo.cnoe.localtest.me:8443
-- Backstage: https://backstage.cnoe.localtest.me:8443
-- Gitea: https://gitea.cnoe.localtest.me:8443
-- Keycloak: https://keycloak.cnoe.localtest.me:8443/admin/master/console/
+- Argo CD: https://cnoe.localtest.me:8443/argocd
+- Argo Workflows: https://cnoe.localtest.me:8443/argo
+- Backstage: https://cnoe.localtest.me:8443/
+- Gitea: https://cnoe.localtest.me:8443/gitea
+- Keycloak: https://cnoe.localtest.me:8443/keycloak/admin/master/console/
 
 # Using it
 
-For this example, we will walk through a few demonstrations. Once applications are ready, go to the [backstage URL](https://backstage.cnoe.localtest.me:8443).
+For this example, we will walk through a few demonstrations. Once applications are ready, go to the [backstage URL](https://cnoe.localtest.me:8443).
 
 Click on the Sign-In button, you will be asked to log into the Keycloak instance. There are two users set up in this 
 configuration, and their password can be retrieved with the following command:
@@ -73,7 +78,7 @@ Both users use the same password retrieved above.
 
 If you want to create a new user or change existing users:
 
-1. Go to the [Keycloak UI](https://keycloak.cnoe.localtest.me:8443/admin/master/console/). 
+1. Go to the [Keycloak UI](https://cnoe.localtest.me:8443/keycloak/admin/master/console/). 
 Login with the username `cnoe-admin`. Password is the `KEYCLOAK_ADMIN_PASSWORD` field from the command above. 
 2. Select `cnoe` from the realms drop down menu.
 3. Select users tab.
@@ -100,9 +105,9 @@ You can click on the ArgoCD Application name to see more details.
 
 ### What just happened?
 
-1. Backstage created [a git repository](https://gitea.cnoe.localtest.me:8443/giteaAdmin/demo), then pushed templated contents to it.
-2. Backstage created [an ArgoCD Application](https://argocd.cnoe.localtest.me:8443/applications/argocd/demo?) and pointed it to the git repository.
-3. Backstage registered the application as [a component](https://gitea.cnoe.localtest.me:8443/giteaAdmin/demo/src/branch/main/catalog-info.yaml) in Backstage.
+1. Backstage created [a git repository](https://cnoe.localtest.me:8443/gitea/giteaAdmin/demo), then pushed templated contents to it.
+2. Backstage created [an ArgoCD Application](https://cnoe.localtest.me:8443/argocd/applications/argocd/demo?) and pointed it to the git repository.
+3. Backstage registered the application as [a component](https://cnoe.localtest.me:8443/gitea/giteaAdmin/demo/src/branch/main/catalog-info.yaml) in Backstage.
 4. ArgoCD deployed the manifests stored in the repo to the cluster.
 5. Backstage retrieved application health from ArgoCD API, then displayed it.
 

examples/ref-implementation/argo-workflows/manifests/dev/ingress.yaml

@@ -3,14 +3,27 @@ kind: Ingress
 metadata:
   name: argo-workflows-ingress
   namespace: argo
+  annotations:
+    nginx.ingress.kubernetes.io/use-regex: "true"
+    nginx.ingress.kubernetes.io/rewrite-target: /$2
 spec:
   ingressClassName: "nginx"
   rules:
-    - host: argo.cnoe.localtest.me
+    - host: localhost
       http:
         paths:
-          - path: /
-            pathType: Prefix
+          - path: /argo-workflows(/|$)(.*)
+            pathType: ImplementationSpecific
+            backend:
+              service:
+                name: argo-server
+                port:
+                  name: web
+    - host: cnoe.localtest.me
+      http:
+        paths:
+          - path: /argo-workflows(/|$)(.*)
+            pathType: ImplementationSpecific
             backend:
               service:
                 name: argo-server

examples/ref-implementation/argo-workflows/manifests/dev/patches/cm-argo-workflows.yaml

@@ -7,14 +7,14 @@ data:
   config: |
     sso:
       insecureSkipVerify: true 
-      issuer: https://keycloak.cnoe.localtest.me:8443/realms/cnoe
+      issuer: https://cnoe.localtest.me:8443/keycloak/realms/cnoe
       clientId:
         name: keycloak-oidc
         key: client-id
       clientSecret:
         name: keycloak-oidc
         key: secret-key
-      redirectUrl: https://argo.cnoe.localtest.me:8443/oauth2/callback
+      redirectUrl: https://cnoe.localtest.me:8443/argo-workflows/oauth2/callback
       rbac:
         enabled: true
       scopes:

examples/ref-implementation/argo-workflows/manifests/dev/patches/deployment-argo-server.yaml

@@ -13,6 +13,9 @@ spec:
               path: /
               port: 2746
               scheme: HTTP
+          env:
+            - name: BASE_HREF
+              value: "/argo-workflows/"
           args:
             - server
             - --configmap=workflow-controller-configmap

examples/ref-implementation/backstage-templates.yaml

@@ -21,4 +21,3 @@ spec:
       - CreateNamespace=true
     automated:
       selfHeal: true
-

examples/ref-implementation/backstage-templates/entities/app-with-bucket/skeleton/catalog-info.yaml

@@ -19,7 +19,7 @@ metadata:
     backstage.io/kubernetes-namespace: default
     argocd/app-name: ${{values.name | dump}}
   links:
-    - url: https://gitea.cnoe.localtest.me:8443
+    - url: https://cnoe.localtest.me:8443/gitea
       title: Repo URL
       icon: github
 spec:

examples/ref-implementation/backstage-templates/entities/app-with-bucket/template.yaml

@@ -100,7 +100,7 @@ spec:
       input:
         description: This is an example app
         # Hard coded value for this demo purposes only.
-        repoUrl: gitea.cnoe.localtest.me:8443?repo=${{parameters.name}}
+        repoUrl: cnoe.localtest.me:8443/gitea?repo=${{parameters.name}}
         defaultBranch: main
     - id: create-argocd-app
       name: Create ArgoCD App

examples/ref-implementation/backstage-templates/entities/argo-workflows/skeleton/catalog-info.yaml

@@ -13,7 +13,7 @@ metadata:
     apache-spark.cnoe.io/label-selector: env=dev,entity-id=${{values.name}}
     apache-spark.cnoe.io/cluster-name: local
   links:
-    - url: https://gitea.cnoe.localtest.me:8443
+    - url: https://cnoe.localtest.me:8443/gitea
       title: Repo URL
       icon: github
 spec:

examples/ref-implementation/backstage-templates/entities/argo-workflows/template.yaml

@@ -35,7 +35,7 @@ spec:
       input:
         description: This is an example app
         # Hard coded value for this demo purposes only.
-        repoUrl: gitea.cnoe.localtest.me:8443?repo=${{parameters.name}}
+        repoUrl: cnoe.localtest.me:8443/gitea?repo=${{parameters.name}}
         defaultBranch: main
     - id: create-argocd-app
       name: Create ArgoCD App