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]>
Billy99 · Jan 29, 2025 · 5bc0e31 · 5bc0e31
1 parent 3a208e2
commit 5bc0e31
Show file tree

Hide file tree

Showing 13 changed files with 374 additions and 93 deletions.
diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
@@ -24,6 +24,10 @@ jobs:
           go-version: '1.21' # yamllint disable-line rule:quoted-strings
       - name: Install dependencies
         run: |
+          sudo apt-get update
+          sudo apt-get install -qy \
+            libxml2-dev \
+            libxslt-dev \
           python -m pip install --upgrade pip
           pip install -r requirements.txt
 

diff --git a/docs/developer-guide/develop-operator.md b/docs/developer-guide/develop-operator.md
diff --git a/docs/getting-started/operator-quick-start.md b/docs/getting-started/operator-quick-start.md
@@ -26,7 +26,7 @@ After reviewing the possible make targets it's quick and easy to get bpfman depl
 via a [KIND cluster](https://kind.sigs.k8s.io/) with:
 
 ```bash
-cd bpfman/bpfman-operator
+cd bpfman-operator
 make run-on-kind
 ```
 
@@ -40,67 +40,12 @@ make run-on-kind
 
 ### Deploy To Openshift Cluster
 
-First deploy the operator with one of the following two options:
-
-#### 1. Manually with Kustomize
-
-To install manually with Kustomize and raw manifests simply run the following
-commands.
-The Openshift cluster needs to be up and running and specified in `~/.kube/config`
-file.
-
-```bash
-cd bpfman/bpfman-operator
-make deploy-openshift
-```
-
-Which can then be cleaned up at a later time with:
-
-```bash
-make undeploy-openshift
-```
-
-#### 2. Via the OLM bundle
-
-The other option for installing the bpfman-operator is to install it using
-[OLM bundle](https://www.redhat.com/en/blog/deploying-operators-olm-bundles).
-
-First setup the namespace and certificates for the operator with:
-
-```bash
-cd bpfman/bpfman-operator
-oc apply -f ./hack/ocp-scc-hacks.yaml
-```
-
-Then use `operator-sdk` to install the bundle like so:
-
-```bash
-operator-sdk run bundle quay.io/bpfman/bpfman-operator-bundle:latest --namespace openshift-bpfman
-```
-
-Which can then be cleaned up at a later time with:
-
-```bash
-operator-sdk cleanup bpfman-operator
-```
-
-followed by
-
-```bash
-oc delete -f ./hack/ocp-scc-hacks.yaml
-```
-
-## Verify the Installation
-
-Independent of the method used to deploy, if the bpfman-operator came up successfully
-you will see the bpfman-daemon and bpfman-operator pods running without errors:
-
-```bash
-$ kubectl get pods -n bpfman
-NAME                             READY   STATUS    RESTARTS   AGE
-bpfman-daemon-w24pr                3/3     Running   0          130m
-bpfman-operator-78cf9c44c6-rv7f2   2/2     Running   0          132m
-```
+The recommend way of deploying bpfman to an OpenShift cluster is via the
+OpenShift Console and using Operator Hub.
+This is described in
+[OperatorHub via OpenShift Console](../developer-guide/develop-operator.md#operatorhub-via-openshift-console).
+For other options, see
+[Deploy To Existing Cluster](../developer-guide/develop-operator.md#deploy-to-existing-cluster).
 
 ## API Types Overview
 
@@ -162,7 +107,7 @@ Any of the cluster scoped samples can be applied as is.
 To test the deployment simply deploy one of the sample `xdpPrograms`:
 
 ```bash
-cd bpfman/bpfman-operator/
+cd bpfman-operator/
 kubectl apply -f config/samples/bpfman.io_v1alpha1_xdp_pass_xdpprogram.yaml
 ```
 

diff --git a/docs/img/operatorhub/OperatorHub_Community_bpfman.png b/docs/img/operatorhub/OperatorHub_Community_bpfman.png
diff --git a/docs/img/operatorhub/OperatorHub_Community_bpfman_commands.png b/docs/img/operatorhub/OperatorHub_Community_bpfman_commands.png
diff --git a/docs/img/operatorhub/OperatorHub_Community_bpfman_install.png b/docs/img/operatorhub/OperatorHub_Community_bpfman_install.png
diff --git a/docs/img/operatorhub/OperatorHub_RedHat_SecurityProfileOperator.png b/docs/img/operatorhub/OperatorHub_RedHat_SecurityProfileOperator.png
diff --git a/docs/img/operatorhub/OperatorHub_RedHat_bpfman.png b/docs/img/operatorhub/OperatorHub_RedHat_bpfman.png
diff --git a/docs/img/operatorhub/OperatorHub_RedHat_bpfman_details.png b/docs/img/operatorhub/OperatorHub_RedHat_bpfman_details.png
diff --git a/docs/img/operatorhub/OperatorHub_RedHat_bpfman_devel.png b/docs/img/operatorhub/OperatorHub_RedHat_bpfman_devel.png
diff --git a/docs/img/operatorhub/OperatorHub_RedHat_bpfman_install.png b/docs/img/operatorhub/OperatorHub_RedHat_bpfman_install.png
diff --git a/examples/config/base/go-xdp-counter/deployment.yaml b/examples/config/base/go-xdp-counter/deployment.yaml
@@ -1,20 +1,15 @@
 ---
 apiVersion: v1
-kind: Namespace
-metadata:
-  name: go-xdp-counter
----
-apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: bpfman-app-go-xdp-counter
-  namespace: go-xdp-counter
+  namespace: bpfman
 ---
 apiVersion: apps/v1
 kind: DaemonSet
 metadata:
   name: go-xdp-counter-ds
-  namespace: go-xdp-counter
+  namespace: bpfman
   labels:
     k8s-app: go-xdp-counter
 spec:

diff --git a/requirements.txt b/requirements.txt
@@ -9,7 +9,7 @@ ghp-import==2.1.0
 idna==3.4
 importlib-metadata==4.11.4
 Jinja2==3.1.2
-lxml==4.9.3
+lxml==5.0.2
 Markdown==3.3.7
 markdown2==2.4.10
 MarkupSafe==2.1.1