rework manifest files and add testing steps

docs/architecture.md

@@ -1,4 +1,4 @@
-[Dashboard Deployment `containers`]: ../manifests/common/base/deployment.yaml
+[Dashboard Deployment `containers`]: ../manifests/overrides/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/common/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/common/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/overrides/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/overrides/base/cluster-role-binding.yaml).
 
 ```bash
 npm run start

docs/release-steps.md

@@ -1,4 +1,4 @@
-[base/kustomization.yaml]: ../manifests/common/base/kustomization.yaml
+[base/kustomization.yaml]: ../manifests/overrides/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/.gitignore

@@ -0,0 +1,4 @@
+# Ignore the testing files that are described in the README.md
+before-*-test.yaml
+after-*-test.yaml
+output-*.diff

manifests/README.md

@@ -2,25 +2,54 @@
 
 The Dashboard manifests run on Kustomize. There are 3 types of deployments for the Dashboard component.
 
-- Open Data Hub (`./odh`)
+- Open Data Hub ([`./odh`](./odh))
 - Red Hat OpenShift AI
-  - RHOAI Managed (`./rhoai/addon`)
-  - RHOAI Self Managed (`./rhoai/onprem`)
+  - RHOAI Managed ([`./rhoai/addon`](./rhoai/addon))
+  - RHOAI Self Managed ([`./rhoai/onprem`](./rhoai/onprem))
 
-## Adding new Manifests
+## Adding/Modifying Manifests
 
-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.
+Rules for keeping the manifest files in a sane order:
 
-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.
+1. When adding a new type of thing, always make it have its own folder; be sure to add the reference to the parent folder's `kustomziation.yaml` (if applicable) 
+2. When adding to a preexisting folder, be sure to add it to the root `kustomization.yaml` in that folder
+3. Do not reference "a file" (has an extension) inside another folder. Reference other folders, which will pick up the `kustomization.yaml` inside that folder; those `kustomization.yaml` files should reference sibling files
+4. Folders matter -- see the README in each for more details
 
-## Installation
+## Installation (ODH)
 
-Use the `kustomize` tool to process the manifest for the `oc apply` command.
+You can 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/common/base
+```markdown
 # Set the namespace in the manifest where you want to deploy the dashboard
 kustomize edit set namespace <DESTINATION NAMESPACE>
-kustomize build . | oc apply -f -
+kustomize build common | oc apply -f -
+kustomize build overrides/base | oc apply -f -
+```
+
+## Testing Changes
+
+One way to test changes locally is to generate the full structure before your changes, and then again after your changes.
+
+Before:
+```markdown
+# Generate the files before your changes for a baseline
+kustomize build rhoai/addon > before-rhoai-addon-test.yaml
+kustomize build rhoai/onprem > before-rhoai-onprem-test.yaml
+kustomize build odh > before-odh-test.yaml
+```
+
+After:
+```markdown
+# Generate the files after your changes
+kustomize build rhoai/addon > after-rhoai-addon-test.yaml
+kustomize build rhoai/onprem > after-rhoai-onprem-test.yaml
+kustomize build odh > after-odh-test.yaml
+
+# Generate the diff between the two
+git diff --no-index before-rhoai-addon-test.yaml after-rhoai-addon-test.yaml > output-rhoai-addon.diff
+git diff --no-index before-rhoai-onprem-test.yaml after-rhoai-onprem-test.yaml > output-rhoai-onprem.diff
+git diff --no-index before-odh-test.yaml after-odh-test.yaml > output-odh.diff
 ```
+
+Viewing the diffs will help you understand what changed.

manifests/common/README.md

@@ -2,4 +2,6 @@
 
 These are manifests that are shared in both ODH & RHOAI deployments.
 
-See `../odh` & `../rhoai` if there are specific deployment manifests needed.
+These files are not intended to be the base of overriding or changing in any way. These should be immutable between both RHOAI and ODH deployments.
+
+> **Note:** See the [`../overrides`](../overrides/README.md) folder for those that can be overridden

manifests/common/apps/jupyter/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - create-jupyter-notebook-quickstart.yaml
 - deploy-python-model-quickstart.yaml

manifests/common/apps/kustomization.yaml

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

manifests/common/crd/kustomization.yaml

@@ -1,11 +1,8 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - odhdashboardconfigs.opendatahub.io.crd.yaml
 - odhquickstarts.console.openshift.io.crd.yaml
 - odhdocuments.dashboard.opendatahub.io.crd.yaml
 - odhapplications.dashboard.opendatahub.io.crd.yaml
-- acceleratorprofiles.opendatahub.io.crd.yaml
+- acceleratorprofiles.opendatahub.io.crd.yaml

manifests/common/kustomization.yaml

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

manifests/odh/README.md

@@ -1,5 +1,3 @@
-# ODH Manifests
+# ODH Deployment
 
-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.
+This is the starting location for ODH manifests.

manifests/odh/kustomization.yaml

@@ -5,3 +5,5 @@ commonLabels:
   app.kubernetes.io/part-of: odh-dashboard
 resources:
   - ../common
+  - ../overrides/base
+  - ../overrides/consolelink

manifests/overrides/README.md

@@ -0,0 +1,5 @@
+# Overridable Manifests
+
+These are manifest files that are intended to be used as-is or to be overridden.
+
+> **Note:** There should be note root `kustomization.yaml` as each folder should be treated as a specific target for inclusion or overrides.

manifests/common/base/kustomization.yaml → manifests/overrides/base/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
   - role.yaml
   - cluster-role.yaml

manifests/rhoai/README.md

@@ -1,5 +1,3 @@
 # 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.
+These manifests are only for RHOAI. Overrides can be performed on the manifest files in `../overrides`.

manifests/rhoai/addon/README.md

@@ -0,0 +1,7 @@
+# RHOAI Addon Deployment
+
+This is the starting location for RHOAI addon manifests.
+
+Only add items to this folder that are exclusively addon manifests.
+
+> **Note:** See [`../shared`](../shared/README.md) for common items between RHOAI deployments.

manifests/rhoai/addon/apps/kustomization.yaml

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

manifests/rhoai/addon/apps/nvidia/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - nvidia-app.yaml
 - gpu-quickstart.yaml

manifests/rhoai/addon/apps/rhoam/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - rhoam-app.yaml
 - deploy-model-rhoam-quickstart.yaml

manifests/rhoai/addon/apps/starburst/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - starburst-app.yaml
 - starburst-galaxy-quickstart.yaml

manifests/rhoai/addon/kustomization.yaml

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

manifests/rhoai/onprem/README.md

@@ -0,0 +1,7 @@
+# RHOAI OnPrem Deployment
+
+This is the starting location for RHOAI onprem manifests.
+
+Only add items to this folder that are exclusively onprem manifests.
+
+> **Note:** See [`../shared`](../shared/README.md) for common items between RHOAI deployments.

manifests/rhoai/onprem/apps/kustomization.yaml

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

manifests/rhoai/onprem/apps/starburst-enterprise/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - query-starburstenterprise-quickstart.yaml
 - starburstenterprise-app.yaml

manifests/rhoai/onprem/kustomization.yaml

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

manifests/rhoai/shared/README.md

@@ -0,0 +1,3 @@
+# RHOAI Shared Manifests
+
+These are all the manifests that are shared between all of the RHOAI deployments.

manifests/rhoai/shared/apps/aikit/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - oneapi-aikit-notebook-quickstart.yaml
 - aikit-app.yaml

manifests/rhoai/shared/apps/anaconda-ce/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - anaconda-ce-app.yaml
 - anaconda-ce-create-jupyter-notebook-quickstart.yaml

manifests/rhoai/shared/apps/elastic/kustomization.yaml

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

manifests/rhoai/shared/apps/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
   - ./aikit
   - ./anaconda-ce

manifests/rhoai/shared/apps/openvino/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - openvino-app.yaml
 - openvino-docs.yaml

manifests/rhoai/shared/apps/pachyderm/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - pachyderm-app.yaml
 - pachyderm-docs.yaml

manifests/rhoai/shared/apps/rhoai/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
   - rhoai-app.yaml
   - rhoai-docs.yaml

manifests/rhoai/shared/apps/watson-x/kustomization.yaml

@@ -1,8 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: odh-dashboard
-  app.kubernetes.io/part-of: odh-dashboard
 resources:
 - watson-x-docs.yaml
 - watson-x-app.yaml

manifests/rhoai/shared/base/kustomization.yaml

@@ -1,9 +1,7 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-commonLabels:
-  app: rhods-dashboard
-  app.kubernetes.io/part-of: rhods-dashboard
 resources:
+  - ../../../overrides/base
   - anaconda-ce-validator-cron.yaml
 patchesJson6902:
   - path: service-account.yaml

manifests/rhoai/shared/consolelink/kustomization.yaml

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

manifests/rhoai/shared/kustomization.yaml

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