Skip to content

Commit 31445ef

Browse files
committed
chore(docs): add a section to avoid oc binary download
1 parent 47cde76 commit 31445ef

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/GETTING_STARTED.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,32 @@ KUBECONFIG=<kubeconfig file>
2121

2222
or by saving the kubeconfig file under `~/.kube/config`
2323

24+
## OpenShift CLI (oc) Binary
25+
26+
By default, the test framework automatically downloads the OpenShift CLI binary from the target cluster's console CLI download service. This ensures compatibility between the client and cluster versions.
27+
28+
### Using a Local oc Binary
29+
30+
If you already have the `oc` binary installed locally, you can avoid the download by setting the `OC_BINARY_PATH` environment variable:
31+
32+
```bash
33+
export OC_BINARY_PATH=/usr/local/bin/oc
34+
```
35+
36+
Or run tests with the variable:
37+
38+
```bash
39+
OC_BINARY_PATH=/usr/local/bin/oc uv run pytest
40+
```
41+
42+
**Note:** Ensure your local `oc` binary is executable and compatible with your target cluster version.
43+
44+
### Benefits of Using Local Binary
45+
46+
- Faster test startup (no download time)
47+
- Consistent tooling across different test runs
48+
- Useful in air-gapped environments or when internet access is limited
49+
2450
## Running the tests
2551
### Basic run of all tests
2652

0 commit comments

Comments
 (0)