Add Redirect Page

ansible · Oct 29, 2024 · a5e90ca · a5e90ca
1 parent 75fc0fc
commit a5e90ca
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 15 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,7 +16,7 @@ jobs:
         include:
           - SCENARIO: default  # tests headless scenario too
           - SCENARIO: externaldb
-          # - SCENARIO: ingress  # TODO: This scenario currently fails because ui and event_stream ingress cannot have the same host and path in minikube nginx ingress controller
+          - SCENARIO: ingress
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
@@ -71,14 +71,14 @@ jobs:
       - name: Test EDA API via API k8s service
         run: |
           kubectl port-forward service/eda-demo-api 8081:8000 &
-          sleep 1
+          sleep 2
           curl -s http://localhost:8081/api/eda/v1/status/
         if: ${{ matrix.SCENARIO == 'default' }}
 
       - name: Test EDA API via UI k8s service
         run: |
           kubectl port-forward service/eda-demo-ui 8080:80 &
-          sleep 1
+          sleep 2
           curl -s http://localhost:8080/api/eda/v1/status/
         if: ${{ matrix.SCENARIO != 'default' }}
 

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -65,14 +65,14 @@ jobs:
       - name: Test EDA API via API k8s service
         run: |
           kubectl port-forward service/eda-demo-api 8081:8000 &
-          sleep 1
+          sleep 2
           curl -s http://localhost:8081/api/eda/v1/status/
         if: ${{ matrix.SCENARIO == 'default' }}
 
       - name: Test EDA API via UI k8s service
         run: |
           kubectl port-forward service/eda-demo-ui 8080:80 &
-          sleep 1
+          sleep 2
           curl -s http://localhost:8080/api/eda/v1/status/
         if: ${{ matrix.SCENARIO != 'default' }}
 

diff --git a/config/manifests/bases/eda-server-operator.clusterserviceversion.yaml b/config/manifests/bases/eda-server-operator.clusterserviceversion.yaml
@@ -190,6 +190,8 @@ spec:
         path: public_base_url
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:text
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:hidden
       - displayName: Automation Server URL
         path: automation_server_url
         x-descriptors:

diff --git a/roles/eda/tasks/deploy_eda.yml b/roles/eda/tasks/deploy_eda.yml
@@ -19,6 +19,13 @@
     definition: "{{ lookup('template', 'eda.configmap.yaml.j2') }}"
     wait: yes
 
+- name: Apply Redirect Page Configmap
+  k8s:
+    apply: yes
+    definition: "{{ lookup('template', 'redirect-page.configmap.html.j2') }}"
+    wait: yes
+  when: public_base_url is defined
+
 - name: Apply Backend deployment resources
   k8s:
     apply: yes

diff --git a/roles/eda/templates/eda-api.configmap.yaml.j2 b/roles/eda/templates/eda-api.configmap.yaml.j2
@@ -40,11 +40,8 @@ data:
                 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
             }
             location / {
-                proxy_pass http://gunicorn;  # Forward requests to Django app
-                proxy_set_header Host $host;
-                proxy_set_header X-Real-IP $remote_addr;
-                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-                proxy_set_header X-Forwarded-Proto $scheme;
+                root {{ static_path }};
+                try_files /index.html =404;
                 access_log /var/log/nginx/proxy_access.log;
                 error_log /var/log/nginx/proxy_error.log;
             }

diff --git a/roles/eda/templates/eda-api.deployment.yaml.j2 b/roles/eda/templates/eda-api.deployment.yaml.j2
@@ -34,6 +34,11 @@ spec:
         app.kubernetes.io/component: '{{ deployment_type }}-api'
       annotations:
         kubectl.kubernetes.io/default-container: 'eda-api'
+{% for template in [
+    "redirect-page.configmap",
+  ] %}
+        checksum-{{ template | replace('/', '-') }}: "{{ lookup('template', template + '.html.j2') | sha1 }}"
+{% endfor %}
 {% for template in [
     "eda.configmap",
   ] %}
@@ -117,10 +122,7 @@ spec:
       - name: eda-initial-data
         image: {{ _image }}
         imagePullPolicy: '{{ image_pull_policy }}'
-        command:
-          - /bin/bash
-          - -c
-          - aap-eda-manage create_initial_data && aap-eda-manage collectstatic --noinput
+        command: ["/bin/bash", "-c", "aap-eda-manage create_initial_data{% if not ui_disabled %} && aap-eda-manage collectstatic --noinput{% endif %}"]
         envFrom:
           - configMapRef:
               name: '{{ ansible_operator_meta.name }}-{{ deployment_type }}-env-properties'
@@ -160,9 +162,11 @@ spec:
 {% if combined_api.resource_requirements is defined %}
         resources: {{ combined_api.resource_requirements }}
 {% endif %}
+{% if not ui_disabled %}
         volumeMounts:
           - name: static-files
             mountPath: {{ static_path }}
+{% endif %}
 {% if bundle_ca_crt  %}
       - name: configure-bundle-ca-cert
         image: {{ _image }}
@@ -282,9 +286,11 @@ spec:
 {% if combined_api.resource_requirements is defined %}
         resources: {{ combined_api.resource_requirements }}
 {% endif %}
+{% if not ui_disabled %}
         volumeMounts:
         - name: static-files
           mountPath: {{ static_path }}
+{% endif %}
       - name: daphne
         image: {{ _image }}
         imagePullPolicy: '{{ image_pull_policy }}'
@@ -375,8 +381,16 @@ spec:
         ports:
           - containerPort: {{ api_nginx_port }}
         volumeMounts:
+{% if not ui_disabled %}
           - name: static-files
-            mountPath: {{ static_path }}
+            mountPath: '{{ static_path }}'
+{% else %}
+{% if public_base_url is defined %}
+          - name: redirect-page
+            mountPath: '{{ static_path }}/index.html'
+            subPath: redirect-page.html
+{% endif %}
+{% endif %}
           - name: '{{ ansible_operator_meta.name }}-nginx-api-conf'
             mountPath: /etc/nginx/nginx.conf
             subPath: nginx.conf
@@ -386,9 +400,21 @@ spec:
           - name: nginx-run
             mountPath: /var/run
       restartPolicy: Always
+
       volumes:
+{% if not ui_disabled %}
         - name: static-files
           emptyDir: {}
+{% else %}
+{% if public_base_url is defined %}
+        - name: redirect-page
+          configMap:
+            name: '{{ ansible_operator_meta.name }}-redirect-page'
+            items:
+              - key: redirect-page.html
+                path: redirect-page.html
+{% endif %}
+{% endif %}
         - name: '{{ ansible_operator_meta.name }}-nginx-api-conf'
           configMap:
             name: '{{ ansible_operator_meta.name }}-nginx-api-configmap'

diff --git a/roles/eda/templates/redirect-page.configmap.html.j2 b/roles/eda/templates/redirect-page.configmap.html.j2
@@ -0,0 +1,77 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ ansible_operator_meta.name }}-redirect-page
+  namespace: {{ ansible_operator_meta.namespace }}
+data:
+  redirect-page.html: |
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="refresh" content="15; url={{ public_base_url }}">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Redirecting to Ansible Automation Platform</title>
+
+        <!-- Favicon links -->
+        <link rel="icon" type="image/x-icon" href="static/rest_framework/docs/img/favicon.ico">
+
+        <!-- Link to DRF's CSS -->
+        <link rel="stylesheet" type="text/css" href="static/rest_framework/css/bootstrap.min.css">
+        <link rel="stylesheet" type="text/css" href="static/rest_framework/css/bootstrap-theme.min.css">
+
+        <style>
+            body {
+                font-family: Arial, sans-serif;
+                text-align: center;
+                padding-top: 0px;
+                /* background-color: rgb(34, 34, 34); */
+            }
+            .banner {
+                background-color: #151414;
+                color: rgb(255, 255, 255);
+                padding: 20px;
+                margin-bottom: 20px;
+                min-height: 70px; /* Ensure the banner is tall enough to fit the logo */
+            }
+            .logo {
+                width: 150px;
+                margin-bottom: 20px;
+                float: left;
+            }
+            a {
+                color: #007BFF;
+                text-decoration: none;
+            }
+            a:hover {
+                text-decoration: underline;
+            }
+            .doc-note {
+                font-size: 0.7em; /* Makes the text smaller */
+                color: #555; /* Optional: Change text color to a lighter shade */
+                background-color: #f9f9f9; /* Optional: Light background color */
+                padding: 10px; /* Optional: Add some padding */
+                margin: 10px 0; /* Optional: Add some margin */
+                float: left;
+            }
+        </style>
+    </head>
+    <body>
+        <!-- Banner Section with Brand Logo -->
+        <div class="banner">
+            <img class="logo" src="/static/logo/aap-logo.svg" alt="Brand Logo">
+        </div>
+
+        <h2>Redirecting to Ansible Automation Platform...</h2>
+        <p>If you are not redirected automatically, <a href="{{ public_base_url }}">click here</a> to go to AAP.</p>
+        <p class="doc-note">
+            The API endpoints for this platform service will temporarily remain available at the URL for this service.
+            Please use the Ansible Automation Platform API endpoints corresponding to this component in the future.
+            These can be found at <a href="{{ public_base_url }}/api/eda/" target="_blank">{{ public_base_url }}/api/eda</a>.
+        </p>
+
+        <!-- Include any additional scripts if needed -->
+        <script src="static/rest_framework/js/jquery-3.5.1.min.js"></script>
+        <script src="static/rest_framework/js/bootstrap.min.js"></script>
+    </body>
+    </html>