Added overlays and renamed overrides folder to core-bases to be more …

…aligned with kustomize format
opendatahub-io · Jun 25, 2024 · 3b21179 · 3b21179
1 parent 072b2e2
commit 3b21179
Show file tree

Hide file tree

Showing 29 changed files with 26 additions and 10 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,4 +1,4 @@
-[Dashboard Deployment `containers`]: ../manifests/overrides/base/deployment.yaml
+[Dashboard Deployment `containers`]: ../manifests/core-bases/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

diff --git a/docs/dev-setup.md b/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/overrides/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/overrides/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/core-bases/base/cluster-role.yaml) to your user as we do with the service account [binding](../manifests/core-bases/base/cluster-role-binding.yaml).
 
 ```bash
 npm run start

diff --git a/docs/release-steps.md b/docs/release-steps.md
@@ -1,4 +1,4 @@
-[base/kustomization.yaml]: ../manifests/overrides/base/kustomization.yaml
+[base/kustomization.yaml]: ../manifests/core-bases/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/

diff --git a/manifests/README.md b/manifests/README.md
@@ -13,7 +13,7 @@ Each deployment type will have a `params.env` file where the Operator can inject
 
 Rules for keeping the manifest files in a sane order:
 
-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) 
+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

diff --git a/manifests/common/README.md b/manifests/common/README.md
@@ -4,4 +4,4 @@ These are manifests that are shared in both ODH & RHOAI deployments.
 
 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
+> **Note:** See the [`../overrides`](../core-bases/README.md) folder for those that can be overridden
diff --git a/manifests/core-bases/README.md b/manifests/core-bases/README.md
@@ -0,0 +1,5 @@
+# Core-Bases Manifests
+
+These are manifest files that are intended to be used in part by other deployments and configured for their own use-cases.
+
+> **Note:** There should be note root `kustomization.yaml` as each folder should be treated as a specific target for inclusion or overrides.
diff --git a/...se/auth-delegator.clusterrolebinding.yaml → ...se/auth-delegator.clusterrolebinding.yaml b/...se/auth-delegator.clusterrolebinding.yaml → ...se/auth-delegator.clusterrolebinding.yaml
diff --git a/...base/cluster-monitoring-role-binding.yaml → ...base/cluster-monitoring-role-binding.yaml b/...base/cluster-monitoring-role-binding.yaml → ...base/cluster-monitoring-role-binding.yaml
diff --git a/.../overrides/base/cluster-role-binding.yaml → ...core-bases/base/cluster-role-binding.yaml b/.../overrides/base/cluster-role-binding.yaml → ...core-bases/base/cluster-role-binding.yaml
diff --git a/manifests/overrides/base/cluster-role.yaml → manifests/core-bases/base/cluster-role.yaml b/manifests/overrides/base/cluster-role.yaml → manifests/core-bases/base/cluster-role.yaml
diff --git a/manifests/overrides/base/deployment.yaml → manifests/core-bases/base/deployment.yaml b/manifests/overrides/base/deployment.yaml → manifests/core-bases/base/deployment.yaml
diff --git a/...errides/base/fetch-accelerators.rbac.yaml → ...e-bases/base/fetch-accelerators.rbac.yaml b/...errides/base/fetch-accelerators.rbac.yaml → ...e-bases/base/fetch-accelerators.rbac.yaml
diff --git a/...es/base/fetch-builds-and-images.rbac.yaml → ...es/base/fetch-builds-and-images.rbac.yaml b/...es/base/fetch-builds-and-images.rbac.yaml → ...es/base/fetch-builds-and-images.rbac.yaml
diff --git a/...base/image-puller.clusterrolebinding.yaml → ...base/image-puller.clusterrolebinding.yaml b/...base/image-puller.clusterrolebinding.yaml → ...base/image-puller.clusterrolebinding.yaml
diff --git a/manifests/overrides/base/kustomization.yaml → manifests/core-bases/base/kustomization.yaml b/manifests/overrides/base/kustomization.yaml → manifests/core-bases/base/kustomization.yaml
diff --git a/...ides/base/model-serving-role-binding.yaml → ...ases/base/model-serving-role-binding.yaml b/...ides/base/model-serving-role-binding.yaml → ...ases/base/model-serving-role-binding.yaml
diff --git a/...ts/overrides/base/model-serving-role.yaml → ...s/core-bases/base/model-serving-role.yaml b/...ts/overrides/base/model-serving-role.yaml → ...s/core-bases/base/model-serving-role.yaml
diff --git a/manifests/overrides/base/oauth.secret.yaml → manifests/core-bases/base/oauth.secret.yaml b/manifests/overrides/base/oauth.secret.yaml → manifests/core-bases/base/oauth.secret.yaml
diff --git a/manifests/overrides/base/role-binding.yaml → manifests/core-bases/base/role-binding.yaml b/manifests/overrides/base/role-binding.yaml → manifests/core-bases/base/role-binding.yaml
diff --git a/manifests/overrides/base/role.yaml → manifests/core-bases/base/role.yaml b/manifests/overrides/base/role.yaml → manifests/core-bases/base/role.yaml
diff --git a/manifests/overrides/base/routes.yaml → manifests/core-bases/base/routes.yaml b/manifests/overrides/base/routes.yaml → manifests/core-bases/base/routes.yaml
diff --git a/...fests/overrides/base/service-account.yaml → ...ests/core-bases/base/service-account.yaml b/...fests/overrides/base/service-account.yaml → ...ests/core-bases/base/service-account.yaml
diff --git a/manifests/overrides/base/service.yaml → manifests/core-bases/base/service.yaml b/manifests/overrides/base/service.yaml → manifests/core-bases/base/service.yaml
diff --git a/...ts/overrides/consolelink/consolelink.yaml → ...s/core-bases/consolelink/consolelink.yaml b/...ts/overrides/consolelink/consolelink.yaml → ...s/core-bases/consolelink/consolelink.yaml
diff --git a/.../overrides/consolelink/kustomization.yaml → ...core-bases/consolelink/kustomization.yaml b/.../overrides/consolelink/kustomization.yaml → ...core-bases/consolelink/kustomization.yaml
diff --git a/manifests/overlays/README.md b/manifests/overlays/README.md
@@ -0,0 +1,7 @@
+# Overlay Manifests
+
+These are shared modifications to existing deployments. These set of folders are to be considered for custom deployments or modifications to existing deployments to suit adhoc and non-operator default deployments.
+
+> **Note:** Consider making overlays inside each deployment if your overlay is non-generic.
+
+Each overlay should come with a readme to help with the use-case for it.
diff --git a/manifests/overlays/dev/README.md b/manifests/overlays/dev/README.md
@@ -0,0 +1,3 @@
+# Dev Overlay
+
+Allows for custom direct deployments of the min-viable resources. Used by the custom deployment install without the operator.
diff --git a/manifests/overlays/dev/kustomization.yaml b/manifests/overlays/dev/kustomization.yaml
@@ -0,0 +1,6 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - ../common/crd
+  - ../core-bases/base
+  - ../common/apps
diff --git a/manifests/overrides/README.md b/manifests/overrides/README.md