Skip to content

Commit a941c0d

Browse files
committed
update dev documentation
We no longer need to tell people to install the operator-sdk, or to use it to run the tests. Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
1 parent 5151562 commit a941c0d

File tree

2 files changed

+6
-32
lines changed

2 files changed

+6
-32
lines changed

docs/dev-setup.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
# Setup Development Environment
22

3-
## Install the operator-sdk
4-
5-
Follow the instructions on the [Operator SDK website](https://sdk.operatorframework.io/docs/installation/install-operator-sdk/)
6-
to check out and install the operator-sdk tools.
7-
8-
## Install openapi-gen
9-
10-
Install the kube-api version of [openapi-gen](https://github.com/kubernetes/kube-openapi)
11-
12-
```bash
13-
go get k8s.io/kube-openapi/cmd/openapi-gen
14-
```
15-
163
## With minikube
174

185
1. Install and launch minikube
@@ -25,7 +12,7 @@ go get k8s.io/kube-openapi/cmd/openapi-gen
2512
kubectl create namespace metal3
2613
```
2714

28-
1. Install operator-sdk
15+
1. Install operator in the cluster
2916

3017
```bash
3118
eval $(go env)
@@ -39,15 +26,15 @@ go get k8s.io/kube-openapi/cmd/openapi-gen
3926
kubectl apply -f deploy/crds/metal3.io_baremetalhosts_crd.yaml
4027
```
4128

42-
1. Launch the operator locally
29+
1. OR Launch the operator locally
4330

4431
```bash
4532
export OPERATOR_NAME=baremetal-operator
4633
export DEPLOY_KERNEL_URL=http://172.22.0.1/images/ironic-python-agent.kernel
4734
export DEPLOY_RAMDISK_URL=http://172.22.0.1/images/ironic-python-agent.initramfs
4835
export IRONIC_ENDPOINT=http://localhost:6385/v1/
4936
export IRONIC_INSPECTOR_ENDPOINT=http://localhost:5050/v1
50-
operator-sdk run --local --watch-namespace=metal3
37+
make run
5138
```
5239

5340
1. Create the CR

docs/testing.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Running end-to-end-tests
1+
# Running the tests
22

33
## Setup
44

@@ -10,22 +10,9 @@ create CRDs. An example role binding setting for configuring the
1010
oc --as system:admin apply -f test/e2e/role_binding.yaml
1111
```
1212

13-
### Run the e2e tests
13+
### Run the unit tests
1414

15-
Run the tests using the operator-sdk command line tool
16-
17-
```bash
18-
operator-sdk test local ./test/e2e --namespace operator-test --up-local --debug
19-
```
20-
21-
If the setup steps above have already been run, causing "X already
22-
exists" errors, use the --no-setup option to skip that step in the test.
23-
24-
```bash
25-
operator-sdk test local ./test/e2e --namespace operator-test --up-local --debug --no-setup
26-
```
27-
28-
The tests can also be run via `make`
15+
The tests can be run via `make`
2916

3017
```bash
3118
make test

0 commit comments

Comments
 (0)