From 250fd66374b20d8789d9916d5839b619b9c1c57f Mon Sep 17 00:00:00 2001 From: Oded Viner Date: Wed, 12 Feb 2025 19:14:08 +0200 Subject: [PATCH] fix code Signed-off-by: Oded Viner --- README.md | 89 ++++++++++++++++--------------------------------------- 1 file changed, 25 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 49142528a3..297c0b68d5 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,27 @@ -# Table of Contents - -- [Table of Contents](#table-of-contents) - - [OpenShift Container Storage Operator](#openshift-container-storage-operator) - - [Deploying pre-built images](#deploying-pre-built-images) - - [Prerequisites](#prerequisites) - - [Dedicated nodes](#dedicated-nodes) - - [Installation](#installation) - - [Development](#development) - - [Tools](#tools) - - [Build](#build) - - [OCS Operator](#ocs-operator) - - [OCS Metric Exporter](#ocs-metric-exporter) - - [OCS Operator Bundle](#ocs-operator-bundle) - - [OCS Operator Catalog](#ocs-operator-catalog) - - [Deploying development builds](#deploying-development-builds) - - [Initial Configuration](#initial-configuration) - - [Modifying Initial Configuration](#modifying-initial-configuration) - - [Functional Tests](#functional-tests) - - [Prerequisites for running Functional Tests](#prerequisites-for-running-functional-tests) - - [Running functional test](#running-functional-test) - - [Functional test phases](#functional-test-phases) - - [Developing Functional Tests](#developing-functional-tests) - - [Running a single test](#running-a-single-test) - - [Debugging Functional Test Failures](#debugging-functional-test-failures) - - [Functional test stdout log](#functional-test-stdout-log) - - [PROW artifacts](#prow-artifacts) +- [OpenShift Container Storage Operator](#openshift-container-storage-operator) +- [Deploying pre-built images](#deploying-pre-built-images) + - [Prerequisites](#prerequisites) + - [Dedicated nodes](#dedicated-nodes) + - [Installation](#installation) +- [Development](#development) + - [Tools](#tools) + - [Build](#build) + - [OCS Operator](#ocs-operator) + - [OCS Metric Exporter](#ocs-metric-exporter) + - [OCS Operator Bundle](#ocs-operator-bundle) + - [OCS Operator Catalog](#ocs-operator-catalog) + - [Deploying development builds](#deploying-development-builds) +- [Initial Configuration](#initial-configuration) + - [Modifying Initial Configuration](#modifying-initial-configuration) +- [Functional Tests](#functional-tests) + - [Prerequisites for running Functional Tests](#prerequisites-for-running-functional-tests) + - [Running functional test](#running-functional-test) + - [Functional test phases](#functional-test-phases) + - [Developing Functional Tests](#developing-functional-tests) + - [Running a single test](#running-a-single-test) + - [Debugging Functional Test Failures](#debugging-functional-test-failures) + - [Functional test stdout log](#functional-test-stdout-log) + - [PROW artifacts](#prow-artifacts) ## OpenShift Container Storage Operator @@ -64,42 +61,6 @@ $ oc adm taint nodes node.ocs.openshift.io/storage=true:NoSchedule The OCS operator can be installed into an OpenShift cluster using Operator Lifecycle Manager (OLM). -**Option 1: Using `make install`** - -If you have a development environment or private image and want to install the OCS operator, follow the steps below: - -- Label Worker Nodes: - OCS Operator will install its components only on nodes labeled for OCS. - - ```console - oc label nodes cluster.ocs.openshift.io/openshift-storage='' - oc label nodes cluster.ocs.openshift.io/openshift-storage='' - oc label nodes cluster.ocs.openshift.io/openshift-storage='' - ``` - -- Set Environment Variables: - Define the required variables for your private image: - - ```console - export REGISTRY_NAMESPACE= - export IMAGE_TAG= - ``` - -- Run the following command: - - ```console - make install - ``` - -- Verify Installation: - Once the make install process completes, verify the status of the ClusterServiceVersion (CSV): - - ```console - oc get csv -n openshift-storage - ``` - -**Option 2: Using Pre-Built YAML** - For quick install using pre-built container images, deploy the [deploy-olm.yaml](deploy/deploy-with-olm.yaml) manifest. ```console @@ -399,4 +360,4 @@ to the right of the `ci/prow/ocs-operator-bundle-e2e-aws` test entry on your PR. there look at the top right hand corner for the `artifacts` link. That will bring you to a directory tree. Follow the `artifacts/` directory to the `ocs-operator-bundle-e2e-aws/` directory. There you can find logs and information -pertaining to objects in the cluster. +pertaining to objects in the cluster. \ No newline at end of file