Skip to content

Commit 581d69a

Browse files
committed
docs: move operator details from README to docs
The bpfman-operator README.md contained operator details that belonged in the general docs. Move this content to the docs, and expand on the details where needed. Related: bpfman/bpfman-operator#366 Signed-off-by: Billy McFall <[email protected]>
1 parent 60a1fdb commit 581d69a

12 files changed

+370
-92
lines changed

docs/developer-guide/develop-operator.md

Lines changed: 359 additions & 22 deletions
Large diffs are not rendered by default.

docs/getting-started/operator-quick-start.md

Lines changed: 8 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ After reviewing the possible make targets it's quick and easy to get bpfman depl
2626
via a [KIND cluster](https://kind.sigs.k8s.io/) with:
2727

2828
```bash
29-
cd bpfman/bpfman-operator
29+
cd bpfman-operator
3030
make run-on-kind
3131
```
3232

@@ -40,67 +40,12 @@ make run-on-kind
4040

4141
### Deploy To Openshift Cluster
4242

43-
First deploy the operator with one of the following two options:
44-
45-
#### 1. Manually with Kustomize
46-
47-
To install manually with Kustomize and raw manifests simply run the following
48-
commands.
49-
The Openshift cluster needs to be up and running and specified in `~/.kube/config`
50-
file.
51-
52-
```bash
53-
cd bpfman/bpfman-operator
54-
make deploy-openshift
55-
```
56-
57-
Which can then be cleaned up at a later time with:
58-
59-
```bash
60-
make undeploy-openshift
61-
```
62-
63-
#### 2. Via the OLM bundle
64-
65-
The other option for installing the bpfman-operator is to install it using
66-
[OLM bundle](https://www.redhat.com/en/blog/deploying-operators-olm-bundles).
67-
68-
First setup the namespace and certificates for the operator with:
69-
70-
```bash
71-
cd bpfman/bpfman-operator
72-
oc apply -f ./hack/ocp-scc-hacks.yaml
73-
```
74-
75-
Then use `operator-sdk` to install the bundle like so:
76-
77-
```bash
78-
operator-sdk run bundle quay.io/bpfman/bpfman-operator-bundle:latest --namespace openshift-bpfman
79-
```
80-
81-
Which can then be cleaned up at a later time with:
82-
83-
```bash
84-
operator-sdk cleanup bpfman-operator
85-
```
86-
87-
followed by
88-
89-
```bash
90-
oc delete -f ./hack/ocp-scc-hacks.yaml
91-
```
92-
93-
## Verify the Installation
94-
95-
Independent of the method used to deploy, if the bpfman-operator came up successfully
96-
you will see the bpfman-daemon and bpfman-operator pods running without errors:
97-
98-
```bash
99-
$ kubectl get pods -n bpfman
100-
NAME READY STATUS RESTARTS AGE
101-
bpfman-daemon-w24pr 3/3 Running 0 130m
102-
bpfman-operator-78cf9c44c6-rv7f2 2/2 Running 0 132m
103-
```
43+
The recommend way of deploying bpfman to an OpenShift cluster is via the
44+
OpenShift Console and using Operator Hub.
45+
This is described in
46+
[OperatorHub via OpenShift Console](../developer-guide/develop-operator.md#operatorhub-via-openshift-console).
47+
For other options, see
48+
[Deploy To Existing Cluster](../developer-guide/develop-operator.md#deploy-to-existing-cluster).
10449

10550
## API Types Overview
10651

@@ -162,7 +107,7 @@ Any of the cluster scoped samples can be applied as is.
162107
To test the deployment simply deploy one of the sample `xdpPrograms`:
163108

164109
```bash
165-
cd bpfman/bpfman-operator/
110+
cd bpfman-operator/
166111
kubectl apply -f config/samples/bpfman.io_v1alpha1_xdp_pass_xdpprogram.yaml
167112
```
168113

Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

examples/config/base/go-xdp-counter/deployment.yaml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
---
22
apiVersion: v1
3-
kind: Namespace
4-
metadata:
5-
name: go-xdp-counter
6-
---
7-
apiVersion: v1
83
kind: ServiceAccount
94
metadata:
105
name: bpfman-app-go-xdp-counter
11-
namespace: go-xdp-counter
6+
namespace: bpfman
127
---
138
apiVersion: apps/v1
149
kind: DaemonSet
1510
metadata:
1611
name: go-xdp-counter-ds
17-
namespace: go-xdp-counter
12+
namespace: bpfman
1813
labels:
1914
k8s-app: go-xdp-counter
2015
spec:

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ extra:
3838

3939
markdown_extensions:
4040
- admonition
41+
- attr_list
4142
- pymdownx.highlight:
4243
anchor_linenums: true
4344
- pymdownx.inlinehilite

0 commit comments

Comments
 (0)