Restructure the manifest files

docs/architecture.md

@@ -1,4 +1,4 @@
-[Dashboard Deployment `containers`]: ../manifests/base/deployment.yaml
+[Dashboard Deployment `containers`]: ../manifests/common/base/deployment.yaml
 [OpenShift OAuth Proxy repo]: https://github.com/openshift/oauth-proxy
 [OpenShift SDK]: https://github.com/openshift/dynamic-plugin-sdk
 [SDK tidbits]: SDK.md

docs/dev-setup.md

@@ -38,7 +38,7 @@ This is the default context for running a local UI.  Make sure you build the pro
 
 > Note: You must be logged-in with `oc` before you can start the backend. Details for that are in the the [contribution guidelines](../CONTRIBUTING.md#give-your-dev-env-access).
 
-> Note: The CLI logged-in user will need to be a `cluster-admin` level user on the cluster to mimic the Dashboard Service Account level of permissions. You could also bind the [cluster role](../manifests/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/base/cluster-role-binding.yaml).
+> Note: The CLI logged-in user will need to be a `cluster-admin` level user on the cluster to mimic the Dashboard Service Account level of permissions. You could also bind the [cluster role](../manifests/common/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/common/base/cluster-role-binding.yaml).
 
 ```bash
 npm run start

docs/release-steps.md

@@ -1,4 +1,4 @@
-[base/kustomization.yaml]: ../manifests/base/kustomization.yaml
+[base/kustomization.yaml]: ../manifests/common/base/kustomization.yaml
 [quay repo]: https://quay.io/repository/opendatahub/odh-dashboard?tab=tags
 [drafting a new release]: https://github.com/opendatahub-io/odh-dashboard/releases/new
 [semver]: https://semver.org/

manifests/README.md

@@ -1,32 +1,26 @@
-# Dashboard
+# Manifests
 
-The Open Data Hub Dashboard component installs a UI which 
+The Dashboard manifests run on Kustomize. There are 3 types of deployments for the Dashboard component.
 
-- Shows what's installed
-- Show's what's available for installation
-- Links to component UIs
-- Links to component documentation
+- Open Data Hub (`./odh`)
+- Red Hat OpenShift AI
+  - RHOAI Managed (`./rhoai/addon`)
+  - RHOAI Self Managed (`./rhoai/onprem`)
 
-For more information, visit the project [GitHub repo](https://github.com/opendatahub-io/odh-dashboard).
+## Adding new Manifests
 
-### Folders
-1. base: contains all the necessary yaml files to install the dashboard
+Starting at the deployment type folders (see above) there will be a `kustomization.yaml` file -- consider this an "index file". Each reference in these "index files" reference other "index files" in other folders until they reach a folder that contains specific manifest yamls. Maintain this structure for cleanness.
+
+The operator will start from one of the deployment type folders, so we are in control of all the references from there. Keep sane references & be sure to read the README files in each of the root folders for guidelines.
+
+## Installation
 
-##### Installation
 Use the `kustomize` tool to process the manifest for the `oc apply` command.
 
 ```
 # Parse the base manifest to deploy ODH Dashboard WITHOUT the required configs for groups
-cd manifests/base
-kustomize edit set namespace <DESTINATION NAMESPACE>   # Set the namespace in the manifest where you want to deploy the dashboard
-kustomize build . | oc apply -f -
-```
-
-```
-# Deploy ODH Dashboard with authentication AND the default configs for groups and ODHDashboardConfig
-cd manifests/overlays/odhdashboardconfig
-kustomize edit set namespace <DESTINATION NAMESPACE>   # Set the namespace in the manifest where you want to deploy the dashboard
+cd manifests/common/base
+# Set the namespace in the manifest where you want to deploy the dashboard
+kustomize edit set namespace <DESTINATION NAMESPACE>
 kustomize build . | oc apply -f -
-# You will need to re-run the previous step if you receive the error below
-# error: unable to recognize "STDIN": no matches for kind "OdhDashboardConfig" in version "opendatahub.io/v1alpha"
 ```

manifests/common/README.md

@@ -0,0 +1,5 @@
+# Common Manifests
+
+These are manifests that are shared in both ODH & RHOAI deployments.
+
+See `../odh` & `../rhoai` if there are specific deployment manifests needed.

manifests/common/kustomization.yaml

@@ -0,0 +1,10 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+commonLabels:
+  app: odh-dashboard
+  app.kubernetes.io/part-of: odh-dashboard
+resources:
+  - ./apps
+  - ./base
+  - ./consolelink
+  - ./crd

manifests/odh/README.md

@@ -0,0 +1,5 @@
+# ODH Manifests
+
+These are manifests that are only for ODH.
+
+RHOAI manifests should not reference these. If they need to reference something in here, they should be put into common folder instead.

manifests/odh/kustomization.yaml

@@ -0,0 +1,7 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+commonLabels:
+  app: odh-dashboard
+  app.kubernetes.io/part-of: odh-dashboard
+resources:
+  - ../common

manifests/rhoai/README.md

@@ -0,0 +1,5 @@
+# RHOAI Manifests
+
+These manifests are only for RHOAI. Overrides can be performed on the manifest files in common.
+
+Use the `./shared` folder to place anything that is shared between RHOAI deployments.

manifests/overlays/apps/apps-addon/kustomization.yaml → manifests/rhoai/addon/apps/kustomization.yaml

@@ -4,7 +4,6 @@ commonLabels:
   app: odh-dashboard
   app.kubernetes.io/part-of: odh-dashboard
 resources:
-  - ../base
   - ./nvidia
   - ./rhoam
   - ./starburst

manifests/rhoai/addon/kustomization.yaml

@@ -0,0 +1,8 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+commonLabels:
+  app: odh-dashboard
+  app.kubernetes.io/part-of: odh-dashboard
+resources:
+  - ../shared
+  - ./apps

manifests/overlays/apps/apps-onprem/kustomization.yaml → manifests/rhoai/onprem/apps/kustomization.yaml

@@ -4,5 +4,4 @@ commonLabels:
   app: odh-dashboard
   app.kubernetes.io/part-of: odh-dashboard
 resources:
-  - ../base
   - ./starburst-enterprise

manifests/rhoai/onprem/kustomization.yaml

@@ -0,0 +1,7 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+commonLabels:
+  app: odh-dashboard
+  app.kubernetes.io/part-of: odh-dashboard
+resources:
+  - ../shared

manifests/overlays/apps/base/kustomization.yaml → manifests/rhoai/shared/apps/kustomization.yaml

@@ -4,7 +4,6 @@ commonLabels:
   app: odh-dashboard
   app.kubernetes.io/part-of: odh-dashboard
 resources:
-  - ../../../apps
   - ./aikit
   - ./anaconda-ce
   - ./elastic

manifests/overlays/rhoai/kustomization.yaml → manifests/rhoai/shared/base/kustomization.yaml

@@ -4,7 +4,6 @@ commonLabels:
   app: rhods-dashboard
   app.kubernetes.io/part-of: rhods-dashboard
 resources:
-  - ../../base
   - anaconda-ce-validator-cron.yaml
 patchesJson6902:
   - path: service-account.yaml
@@ -84,4 +83,4 @@ vars:
   fieldref:
     fieldpath: data.odh-dashboard-image
 configurations:
-- params.yaml
+- params.yaml

manifests/overlays/consolelink/kustomization.yaml → manifests/rhoai/shared/consolelink/kustomization.yaml

@@ -4,10 +4,10 @@ commonLabels:
   app: rhods-dashboard
   app.kubernetes.io/part-of: rhods-dashboard
 resources:
-  - ../../consolelink
+  - ../../../common/consolelink
 patchesJson6902:
   - path: consolelink.yaml
     target:
       version: v1
       kind: ConsoleLink
-      name: odhlink
+      name: odhlink

manifests/rhoai/shared/kustomization.yaml

@@ -0,0 +1,11 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+commonLabels:
+  app: odh-dashboard
+  app.kubernetes.io/part-of: odh-dashboard
+resources:
+  - ../../common
+  - ./apps
+  - ./base
+  - ./consolelink
+  - ./odhdashboardconfig