Skip to content

Commit bf49c1a

Browse files
committed
Add make install Procedure to README for Installation
Signed-off-by: Oded Viner <[email protected]>
1 parent 1085e40 commit bf49c1a

File tree

1 file changed

+61
-24
lines changed

1 file changed

+61
-24
lines changed

README.md

Lines changed: 61 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# Table of Contents
22

3-
- [OpenShift Container Storage Operator](#openshift-container-storage-operator)
4-
- [Deploying pre-built images](#deploying-pre-built-images)
5-
- [Prerequisites](#prerequisites)
6-
- [Dedicated nodes](#dedicated-nodes)
7-
- [Installation](#installation)
8-
- [Development](#development)
9-
- [Tools](#tools)
10-
- [Build](#build)
11-
1. [OCS Operator](#ocs-operator)
12-
2. [OCS Metric Exporter](#ocs-metric-exporter)
13-
3. [OCS Operator Bundle](#ocs-operator-bundle)
14-
4. [OCS Operator Catalog](#ocs-operator-catalog)
15-
- [Deploying development builds](#deploying-development-builds)
16-
- [Initial Configuration](#initial-configuration)
17-
- [Modifying Initial Configuration](#modifying-initial-configuration)
18-
- [Functional Tests](#functional-tests)
19-
- [Prerequisites for running Functional Tests](#prerequisites-for-running-functional-tests)
20-
- [Running functional test](#running-functional-test)
21-
- [Functional test phases](#functional-test-phases)
22-
- [Developing Functional Tests](#developing-functional-tests)
23-
- [Running a single test](#running-a-single-test)
24-
- [Debugging Functional Test Failures](#debugging-functional-test-failures)
25-
- [Functional test stdout log](#functional-test-stdout-log)
26-
- [PROW artifacts](#prow-artifacts)
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)
2728

2829
## OpenShift Container Storage Operator
2930

@@ -63,6 +64,42 @@ $ oc adm taint nodes <NodeNames> node.ocs.openshift.io/storage=true:NoSchedule
6364

6465
The OCS operator can be installed into an OpenShift cluster using Operator Lifecycle Manager (OLM).
6566

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+
66103
For quick install using pre-built container images, deploy the [deploy-olm.yaml](deploy/deploy-with-olm.yaml) manifest.
67104

68105
```console

0 commit comments

Comments
 (0)