diff --git a/README.md b/README.md index 24d01e61f23..9d7faea06d5 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ The latest version of operator can be installed from the `community-operators` c and installed from source manually, see the Developer guide for further instructions. 1. Subscribe to operator by creating following subscription + ```console cat < -e E2E_TEST_FLAGS="--skip-deletion=true" -``` \ No newline at end of file +``` + +### Troubleshooting + +Please refer to [troubleshooting documentation](docs/troubleshooting.md) \ No newline at end of file diff --git a/docs/DESIGN.md b/docs/DESIGN.md index 21f10e4cee7..83b1f660eb4 100644 --- a/docs/DESIGN.md +++ b/docs/DESIGN.md @@ -3,6 +3,7 @@ ## Motivation 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 @@ -13,7 +14,8 @@ Following are the general goals for redesigning the existing ODH operator: ## Proposed Design -To deploy ODH components seamlessly, ODH operator will watch two CRDS: +To deploy ODH components seamlessly, ODH operator will watch two CRDs: + - DSCInitialization - DataScienceCluster @@ -25,7 +27,6 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDS: - Some examples of initial setup include creating namespaces, network policies, SCCs, common configmaps and secrets. - This will be a singleton CR i.e 1 instance of this CR will always be present in the cluster. - DSCInitialization CR can be deleted to re-run initial setup without requiring re-build of the operator. -- **This CR is not configurable for end users** ### DataScienceCluster @@ -36,8 +37,8 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDS: ## Examples - 1. Enable all components + ```console apiVersion: datasciencecluster.opendatahub.io/v1 kind: DataScienceCluster @@ -60,6 +61,7 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDS: workbenches: managementState: Managed ``` + 2. Enable only Dashboard and Workbenches(Jupyter Notebooks) ```console @@ -75,7 +77,7 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDS: managementState: Managed ``` -3. Enable Data Science Pipelines +3. Enable Data Science Pipelines ```console apiVersion: datasciencecluster.opendatahub.io/v1 @@ -86,4 +88,4 @@ To deploy ODH components seamlessly, ODH operator will watch two CRDS: components: datasciencepipelines: managementState: Managed - ``` \ No newline at end of file + ``` diff --git a/docs/Dev-Preview.md b/docs/Dev-Preview.md index 8c6bc9d82ee..67fe3d31bbf 100644 --- a/docs/Dev-Preview.md +++ b/docs/Dev-Preview.md @@ -75,7 +75,7 @@ EOF 1. When Operator is installed it creates a namespace called `opendatahub`. 2. Users need to create required `DataScienceCluster` resource by going to the `Installed Operators` tab in the OpenShift Cluster. -3. Users should explicitly set components with `enabled: true` in order for components to be installed. +3. Users should explicitly set components with `managementState: Managed` in order for components to be installed. ```console cat <