Skip to content

Commit 6186e1a

Browse files
committed
developing-on-ocp: update README
Signed-off-by: Douglas Schilling Landgraf <[email protected]>
1 parent 07faf0d commit 6186e1a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

developing-on-ocp.md

+14
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This document gives some hints for developing and testing kubernetes-nmstate on
66

77
To test your changes you can either deploy a cluster via cluster-bot or use the [dev-scripts](https://github.com/openshift-metal3/dev-scripts) to spin up a cluster on your hardware. In the following we are focusing on the dev-scripts approach.
88

9+
Please note: The MIRROR_IMAGES option in dev-scripts may cause issues pulling the operator images from some sources. When in doubt, do not use image mirroring for clusters where you intend to install kubernetes-nmstate.
10+
911
### General cluster config
1012

1113
To specify your CNI plugin, you have set the `NETWORK_TYPE` env var in your dev-scripts `config_$USER.sh` file. Valid values are `OVNKubernetes` and `OpenShiftSDN`. E.g.:
@@ -75,6 +77,18 @@ To uninstall the operator again, run the following command:
7577
$ KUBECONFIG=<path to your kubeconfig> make ocp-uninstall-bundle
7678
```
7779

80+
Just in case, the official documentation for the deploy is [located here](https://docs.openshift.com/container-platform/4.13/networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.html) but do not mix the deploy methods.
81+
82+
Finally, there [is a script](https://github.com/openshift/kubernetes-nmstate/blob/07faf0dbb8ebcb76174e12efba1515c816c36d20/hack/ocp-install-nightly-art-operators.sh) that install the latest operator but requires VPN.
83+
84+
For debugging there are commands like:
85+
```
86+
oc get sub -n openshift-nmstate
87+
oc get csv -n openshift-nmstate
88+
```
89+
90+
Official doc for troubleshooting [is here](https://docs.openshift.com/container-platform/4.13/support/troubleshooting/troubleshooting-operator-issues.html)
91+
7892
## Running the E2E Tests locally
7993

8094
The E2E tests run automated in CI. If you want to run them locally anyhow, you can run them with the following commands:

0 commit comments

Comments
 (0)