From 742b09bdd0c3cf639554faf782c25675ec1daa6b Mon Sep 17 00:00:00 2001 From: Wen Zhou Date: Wed, 28 Aug 2024 03:06:02 +0200 Subject: [PATCH] docs: update old docs (#1188) Signed-off-by: Wen Zhou --- README.md | 13 ++++++------- docs/DESIGN.md | 23 +++++++++-------------- docs/troubleshooting.md | 21 +++++++++++++++++++++ docs/upgrade-testing.md | 20 ++++++++++++++++---- 4 files changed, 52 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 251eb7673b0..294b406a009 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,7 @@ Additionally installing `Authorino operator` & `Service Mesh operator` enhances Please note that the latest releases are made in the `Fast` channel. -- It can also be build -and installed from source manually, see the Developer guide for further instructions. +- It can also be build and installed from source manually, see the Developer guide for further instructions. 1. Subscribe to operator by creating following subscription @@ -91,11 +90,11 @@ Each component is associated with its manifest location in the `COMPONENT_MANIFE #### Workflow 1. The script clones the remote repository `/` from the specified ``. -2. It then copies the content from the relative path `` to the local `odh-manifests/` folder. +2. It then copies the content from the relative path `` to the local `opt/manifests/` folder. #### Local Storage -The script utilizes a local, empty folder named `odh-manifests` to host all required manifests, sourced either directly from the component’s source repository or the default `odh-manifests` git repository. +The script utilizes a local, empty folder named `opt/manifests` to host all required manifests, sourced directly from each component’s source repository. #### Adding New Components @@ -123,7 +122,7 @@ If the flag name matches components key defined in `COMPONENT_MANIFESTS` it will make get-manifests ``` -This first cleanup your local `odh-manifests` folder. +This first cleanup your local `opt/manifests` folder. Ensure back up before run this command if you have local changes of manifests want to reuse later. ##### for build operator image @@ -135,7 +134,7 @@ make image-build By default, building an image without any local changes(as a clean build) This is what the production build system is doing. -In order to build an image with local `odh-manifests` folder, to set `IMAGE_BUILD_FLAGS ="--build-arg USE_LOCAL=true"` in make. +In order to build an image with local `opt/manifests` folder, to set `IMAGE_BUILD_FLAGS ="--build-arg USE_LOCAL=true"` in make. e.g `make image-build -e IMAGE_BUILD_FLAGS="--build-arg USE_LOCAL=true"` #### Build Image @@ -353,7 +352,7 @@ spec: managementState: Managed ``` -**Note:** Default value for a component is `false`. +**Note:** Default value for managementState in component is `false`. ### Run functional Tests diff --git a/docs/DESIGN.md b/docs/DESIGN.md index 64e52fb158a..0e82ac0acb4 100644 --- a/docs/DESIGN.md +++ b/docs/DESIGN.md @@ -7,7 +7,7 @@ Following are the general goals for redesigning the existing ODH operator: - Create an opinionated deployment of ODH components. - Provide users / cluster administrators with ability to customize components - Provide ability to enable / disable individual components -- Eliminate limitations of the existing operator: +- Eliminate limitations of v1 operator: - ODH uninstallation fails to clean up, leaving broken clusters that cannot be easily upgraded. - ODH deployments, when they fail, provide no useful troubleshooting or debugging information. - ODH cannot easily reconcile some change in live declared state. @@ -54,8 +54,16 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDs: managementState: Managed kserve: managementState: Managed + serving: + ingressGateway: + certificate: + type: OpenshiftDefaultIngress + managementState: Managed + name: knative-serving modelmeshserving: managementState: Managed + modelregistry: + managementState: Managed ray: managementState: Managed kueue: @@ -82,16 +90,3 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDs: workbenches: managementState: Managed ``` - -3. Enable Data Science Pipelines - - ```console - apiVersion: datasciencecluster.opendatahub.io/v1 - kind: DataScienceCluster - metadata: - name: example - spec: - components: - datasciencepipelines: - managementState: Managed - ``` diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 80f2078430e..5afa37f1512 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,6 +1,7 @@ # What This document serves as the knowledge base for troubleshooting the Open Data Hub Operator. +More information can be found at https://github.com/opendatahub-io/opendatahub-operator/wiki ## Troubleshooting @@ -17,3 +18,23 @@ To upgrade, follow these steps: All of the above steps can be performed either through the console UI or via the `oc`/`kubectl` CLI. After completing these steps, please refer to the installation guide to proceed with a clean installation of the v2.2+ operator. + + +### Why component's managementState is set to {} not Removed? + +Only if managementState is explicitliy set to "Managed" on component level, below configs in DSC CR to component "X" take the same effects: + +```console +spec: +components: + X: + managementState: Removed + +``` + +```console +spec: +components: + X: {} +``` + diff --git a/docs/upgrade-testing.md b/docs/upgrade-testing.md index f00ef9cf56d..ce9bd1ef0e4 100644 --- a/docs/upgrade-testing.md +++ b/docs/upgrade-testing.md @@ -121,20 +121,32 @@ metadata: spec: components: codeflare: - managementState: Removed + managementState: Managed dashboard: managementState: Managed datasciencepipelines: managementState: Managed kserve: managementState: Managed + serving: + ingressGateway: + certificate: + type: OpenshiftDefaultIngress + managementState: Managed + name: knative-serving modelmeshserving: - managementState: Removed + managementState: Managed + modelregistry: + managementState: Managed ray: - managementState: Removed + managementState: Managed + kueue: + managementState: Managed + trainingoperator: + managementState: Managed workbenches: managementState: Managed trustyai: - managementState: Removed + managementState: Managed EOF ``` \ No newline at end of file