|
1 |
| -# Table of Contents |
2 |
| - |
3 |
| -- [Table of Contents](#table-of-contents) |
4 |
| - - [OpenShift Container Storage Operator](#openshift-container-storage-operator) |
5 |
| - - [Deploying pre-built images](#deploying-pre-built-images) |
6 |
| - - [Prerequisites](#prerequisites) |
7 |
| - - [Dedicated nodes](#dedicated-nodes) |
8 |
| - - [Installation](#installation) |
9 |
| - - [Development](#development) |
10 |
| - - [Tools](#tools) |
11 |
| - - [Build](#build) |
12 |
| - - [OCS Operator](#ocs-operator) |
13 |
| - - [OCS Metric Exporter](#ocs-metric-exporter) |
14 |
| - - [OCS Operator Bundle](#ocs-operator-bundle) |
15 |
| - - [OCS Operator Catalog](#ocs-operator-catalog) |
16 |
| - - [Deploying development builds](#deploying-development-builds) |
17 |
| - - [Initial Configuration](#initial-configuration) |
18 |
| - - [Modifying Initial Configuration](#modifying-initial-configuration) |
19 |
| - - [Functional Tests](#functional-tests) |
20 |
| - - [Prerequisites for running Functional Tests](#prerequisites-for-running-functional-tests) |
21 |
| - - [Running functional test](#running-functional-test) |
22 |
| - - [Functional test phases](#functional-test-phases) |
23 |
| - - [Developing Functional Tests](#developing-functional-tests) |
24 |
| - - [Running a single test](#running-a-single-test) |
25 |
| - - [Debugging Functional Test Failures](#debugging-functional-test-failures) |
26 |
| - - [Functional test stdout log](#functional-test-stdout-log) |
27 |
| - - [PROW artifacts](#prow-artifacts) |
| 1 | +- [OpenShift Container Storage Operator](#openshift-container-storage-operator) |
| 2 | +- [Deploying pre-built images](#deploying-pre-built-images) |
| 3 | + - [Prerequisites](#prerequisites) |
| 4 | + - [Dedicated nodes](#dedicated-nodes) |
| 5 | + - [Installation](#installation) |
| 6 | +- [Development](#development) |
| 7 | + - [Tools](#tools) |
| 8 | + - [Build](#build) |
| 9 | + - [OCS Operator](#ocs-operator) |
| 10 | + - [OCS Metric Exporter](#ocs-metric-exporter) |
| 11 | + - [OCS Operator Bundle](#ocs-operator-bundle) |
| 12 | + - [OCS Operator Catalog](#ocs-operator-catalog) |
| 13 | + - [Deploying development builds](#deploying-development-builds) |
| 14 | +- [Initial Configuration](#initial-configuration) |
| 15 | + - [Modifying Initial Configuration](#modifying-initial-configuration) |
| 16 | +- [Functional Tests](#functional-tests) |
| 17 | + - [Prerequisites for running Functional Tests](#prerequisites-for-running-functional-tests) |
| 18 | + - [Running functional test](#running-functional-test) |
| 19 | + - [Functional test phases](#functional-test-phases) |
| 20 | + - [Developing Functional Tests](#developing-functional-tests) |
| 21 | + - [Running a single test](#running-a-single-test) |
| 22 | + - [Debugging Functional Test Failures](#debugging-functional-test-failures) |
| 23 | + - [Functional test stdout log](#functional-test-stdout-log) |
| 24 | + - [PROW artifacts](#prow-artifacts) |
28 | 25 |
|
29 | 26 | ## OpenShift Container Storage Operator
|
30 | 27 |
|
@@ -64,42 +61,6 @@ $ oc adm taint nodes <NodeNames> node.ocs.openshift.io/storage=true:NoSchedule
|
64 | 61 |
|
65 | 62 | The OCS operator can be installed into an OpenShift cluster using Operator Lifecycle Manager (OLM).
|
66 | 63 |
|
67 |
| -**Option 1: Using `make install`** |
68 |
| - |
69 |
| -If you have a development environment or private image and want to install the OCS operator, follow the steps below: |
70 |
| - |
71 |
| -- Label Worker Nodes: |
72 |
| - OCS Operator will install its components only on nodes labeled for OCS. |
73 |
| - |
74 |
| - ```console |
75 |
| - oc label nodes <NodeName1> cluster.ocs.openshift.io/openshift-storage='' |
76 |
| - oc label nodes <NodeName2> cluster.ocs.openshift.io/openshift-storage='' |
77 |
| - oc label nodes <NodeName3> cluster.ocs.openshift.io/openshift-storage='' |
78 |
| - ``` |
79 |
| - |
80 |
| -- Set Environment Variables: |
81 |
| - Define the required variables for your private image: |
82 |
| - |
83 |
| - ```console |
84 |
| - export REGISTRY_NAMESPACE=<your-registry-namespace> |
85 |
| - export IMAGE_TAG=<your-image-tag> |
86 |
| - ``` |
87 |
| - |
88 |
| -- Run the following command: |
89 |
| - |
90 |
| - ```console |
91 |
| - make install |
92 |
| - ``` |
93 |
| - |
94 |
| -- Verify Installation: |
95 |
| - Once the make install process completes, verify the status of the ClusterServiceVersion (CSV): |
96 |
| - |
97 |
| - ```console |
98 |
| - oc get csv -n openshift-storage |
99 |
| - ``` |
100 |
| - |
101 |
| -**Option 2: Using Pre-Built YAML** |
102 |
| - |
103 | 64 | For quick install using pre-built container images, deploy the [deploy-olm.yaml](deploy/deploy-with-olm.yaml) manifest.
|
104 | 65 |
|
105 | 66 | ```console
|
@@ -399,4 +360,4 @@ to the right of the `ci/prow/ocs-operator-bundle-e2e-aws` test entry on your PR.
|
399 | 360 | there look at the top right hand corner for the `artifacts` link. That will
|
400 | 361 | bring you to a directory tree. Follow the `artifacts/` directory to the
|
401 | 362 | `ocs-operator-bundle-e2e-aws/` directory. There you can find logs and information
|
402 |
| -pertaining to objects in the cluster. |
| 363 | +pertaining to objects in the cluster. |
0 commit comments