diff --git a/docs/architecture.md b/docs/architecture.md index 1cf44fd2b1..7f8aee5c68 100644 --- 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 index cbf7296e48..e78f3fc0ff 100644 --- 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 index fad6ed7647..09046efd62 100644 --- 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 index 532d627542..67126d4a47 100644 --- 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 @@ -26,9 +26,11 @@ You can use the `kustomize` tool to process the manifest for the `oc apply` comm # Set the namespace in the manifest where you want to deploy the dashboard kustomize edit set namespace kustomize build common | oc apply -f - -kustomize build overrides/base | oc apply -f - +kustomize build core-bases/base | oc apply -f - ``` +Alternatively, you can use the `./install/deploy.sh` which uses the `overlays/dev` overlay to select specific folders. + ## Testing Changes One way to test changes locally is to generate the full structure before your changes, and then again after your changes. diff --git a/manifests/common/README.md b/manifests/common/README.md index 8d875e5c97..50a954acc7 100644 --- 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 new file mode 100644 index 0000000000..65400eb175 --- /dev/null +++ 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/manifests/overrides/base/auth-delegator.clusterrolebinding.yaml b/manifests/core-bases/base/auth-delegator.clusterrolebinding.yaml similarity index 100% rename from manifests/overrides/base/auth-delegator.clusterrolebinding.yaml rename to manifests/core-bases/base/auth-delegator.clusterrolebinding.yaml diff --git a/manifests/overrides/base/cluster-monitoring-role-binding.yaml b/manifests/core-bases/base/cluster-monitoring-role-binding.yaml similarity index 100% rename from manifests/overrides/base/cluster-monitoring-role-binding.yaml rename to manifests/core-bases/base/cluster-monitoring-role-binding.yaml diff --git a/manifests/overrides/base/cluster-role-binding.yaml b/manifests/core-bases/base/cluster-role-binding.yaml similarity index 100% rename from manifests/overrides/base/cluster-role-binding.yaml rename to manifests/core-bases/base/cluster-role-binding.yaml diff --git a/manifests/overrides/base/cluster-role.yaml b/manifests/core-bases/base/cluster-role.yaml similarity index 100% rename from manifests/overrides/base/cluster-role.yaml rename to manifests/core-bases/base/cluster-role.yaml diff --git a/manifests/overrides/base/deployment.yaml b/manifests/core-bases/base/deployment.yaml similarity index 100% rename from manifests/overrides/base/deployment.yaml rename to manifests/core-bases/base/deployment.yaml diff --git a/manifests/overrides/base/fetch-accelerators.rbac.yaml b/manifests/core-bases/base/fetch-accelerators.rbac.yaml similarity index 100% rename from manifests/overrides/base/fetch-accelerators.rbac.yaml rename to manifests/core-bases/base/fetch-accelerators.rbac.yaml diff --git a/manifests/overrides/base/fetch-builds-and-images.rbac.yaml b/manifests/core-bases/base/fetch-builds-and-images.rbac.yaml similarity index 100% rename from manifests/overrides/base/fetch-builds-and-images.rbac.yaml rename to manifests/core-bases/base/fetch-builds-and-images.rbac.yaml diff --git a/manifests/overrides/base/image-puller.clusterrolebinding.yaml b/manifests/core-bases/base/image-puller.clusterrolebinding.yaml similarity index 100% rename from manifests/overrides/base/image-puller.clusterrolebinding.yaml rename to manifests/core-bases/base/image-puller.clusterrolebinding.yaml diff --git a/manifests/overrides/base/kustomization.yaml b/manifests/core-bases/base/kustomization.yaml similarity index 100% rename from manifests/overrides/base/kustomization.yaml rename to manifests/core-bases/base/kustomization.yaml diff --git a/manifests/overrides/base/model-serving-role-binding.yaml b/manifests/core-bases/base/model-serving-role-binding.yaml similarity index 100% rename from manifests/overrides/base/model-serving-role-binding.yaml rename to manifests/core-bases/base/model-serving-role-binding.yaml diff --git a/manifests/overrides/base/model-serving-role.yaml b/manifests/core-bases/base/model-serving-role.yaml similarity index 100% rename from manifests/overrides/base/model-serving-role.yaml rename to manifests/core-bases/base/model-serving-role.yaml diff --git a/manifests/overrides/base/oauth.secret.yaml b/manifests/core-bases/base/oauth.secret.yaml similarity index 100% rename from manifests/overrides/base/oauth.secret.yaml rename to manifests/core-bases/base/oauth.secret.yaml diff --git a/manifests/overrides/base/role-binding.yaml b/manifests/core-bases/base/role-binding.yaml similarity index 100% rename from manifests/overrides/base/role-binding.yaml rename to manifests/core-bases/base/role-binding.yaml diff --git a/manifests/overrides/base/role.yaml b/manifests/core-bases/base/role.yaml similarity index 100% rename from manifests/overrides/base/role.yaml rename to manifests/core-bases/base/role.yaml diff --git a/manifests/overrides/base/routes.yaml b/manifests/core-bases/base/routes.yaml similarity index 100% rename from manifests/overrides/base/routes.yaml rename to manifests/core-bases/base/routes.yaml diff --git a/manifests/overrides/base/service-account.yaml b/manifests/core-bases/base/service-account.yaml similarity index 100% rename from manifests/overrides/base/service-account.yaml rename to manifests/core-bases/base/service-account.yaml diff --git a/manifests/overrides/base/service.yaml b/manifests/core-bases/base/service.yaml similarity index 100% rename from manifests/overrides/base/service.yaml rename to manifests/core-bases/base/service.yaml diff --git a/manifests/overrides/consolelink/consolelink.yaml b/manifests/core-bases/consolelink/consolelink.yaml similarity index 100% rename from manifests/overrides/consolelink/consolelink.yaml rename to manifests/core-bases/consolelink/consolelink.yaml diff --git a/manifests/overrides/consolelink/kustomization.yaml b/manifests/core-bases/consolelink/kustomization.yaml similarity index 100% rename from manifests/overrides/consolelink/kustomization.yaml rename to manifests/core-bases/consolelink/kustomization.yaml diff --git a/manifests/overlays/README.md b/manifests/overlays/README.md new file mode 100644 index 0000000000..97feec9980 --- /dev/null +++ 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 new file mode 100644 index 0000000000..12c1d0ce3b --- /dev/null +++ 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 new file mode 100644 index 0000000000..4c5a4150be --- /dev/null +++ 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 deleted file mode 100644 index 570f8b8849..0000000000 --- a/manifests/overrides/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# 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.