diff --git a/README.md b/README.md index 01632884c..734ed03e5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # bpfman-operator -The `bpfman-operator` repository exists in order to deploy and manage bpfman within a Kubernetes cluster. -This operator was built utilizing some great tooling provided by the +The `bpfman-operator` repository exists to deploy and manage bpfman within a Kubernetes cluster. +This operator was built using some great tooling provided by the [operator-sdk library](https://sdk.operatorframework.io/). A great first step in understanding some of the functionality can be to just run `make help`. @@ -92,7 +92,7 @@ To test the deployment simply deploy one of the sample `xdpPrograms`: kubectl apply -f config/samples/bpfman.io_v1alpha1_xdp_pass_xdpprogram.yaml ``` -If loading of the XDP Program to the selected nodes was successful it will be reported +If loading of the XDP Program to the selected nodes was successful, it will be reported back to the user via the `xdpProgram`'s status field: ```bash @@ -148,7 +148,7 @@ xdp-pass-all-nodes pass {} 0 {"primarynodein ## API Types Overview -Refer to [api-spec.md](./api-spec.md) for a detailed description of all the bpfman Kubernetes API types. +Refer to [api-spec.md](https://bpfman.io/main/developer-guide/api-spec/) for a detailed description of all the bpfman Kubernetes API types. ### Multiple Program CRDs @@ -173,11 +173,11 @@ how these programs should be deployed across the cluster. ## BpfProgram CRD The `BpfProgram` CRD is used internally by the `bpfman-deployment` to keep track of per-node `bpfman` state, -such as map pin points, and to report node specific errors back to the user. -Kubernetes users/controllers are only allowed to view these objects, NOT create or edit them. +such as map pinpoints, and to report node-specific errors back to the user. +Kubernetes' users/controllers are only allowed to view these objects, NOT create or edit them. Applications wishing to use `bpfman` to deploy/manage their eBPF programs in Kubernetes will make use of this -object to find references to the bpfMap pinpoints (`spec.maps`) in order to configure their eBPF programs. +object to find references to the bpfMap pinpoints (`spec.maps`) to configure their eBPF programs. ## Developer diff --git a/bundle/manifests/bpfman-operator.clusterserviceversion.yaml b/bundle/manifests/bpfman-operator.clusterserviceversion.yaml index 28b29f3a0..d2440c04b 100644 --- a/bundle/manifests/bpfman-operator.clusterserviceversion.yaml +++ b/bundle/manifests/bpfman-operator.clusterserviceversion.yaml @@ -16,7 +16,7 @@ metadata: "spec": { "bytecode": { "image": { - "url": "quay.io/bpfman-bytecode/go-application-counter:latest" + "url": "quay.io/bpfman-bytecode/go-app-counter:latest" } }, "nodeselector": {}, @@ -296,7 +296,7 @@ metadata: capabilities: Basic Install categories: OpenShift Optional containerImage: quay.io/bpfman/bpfman-operator:v0.0.0 - createdAt: "2024-06-20T14:00:22Z" + createdAt: "2024-07-01T16:49:31Z" operatorframework.io/suggested-namespace-template: |- { "apiVersion": "v1", diff --git a/config/samples/bpfman.io_v1alpha1_bpfapplication.yaml b/config/samples/bpfman.io_v1alpha1_bpfapplication.yaml index bce82eac0..1fd6a2c87 100644 --- a/config/samples/bpfman.io_v1alpha1_bpfapplication.yaml +++ b/config/samples/bpfman.io_v1alpha1_bpfapplication.yaml @@ -9,7 +9,7 @@ spec: nodeselector: {} bytecode: image: - url: quay.io/bpfman-bytecode/go-application-counter:latest + url: quay.io/bpfman-bytecode/go-app-counter:latest programs: - type: Kprobe kprobe: diff --git a/test/integration/app_test.go b/test/integration/app_test.go index 587f4ee63..9922e4481 100644 --- a/test/integration/app_test.go +++ b/test/integration/app_test.go @@ -18,8 +18,8 @@ import ( const ( appGoCounterKustomize = "https://github.com/bpfman/bpfman/examples/config/default/go-app-counter/?timeout=120&ref=main" - appGoCounterUserspaceNs = "go-application-counter" - appGoCounterUserspaceDsName = "go-application-counter-ds" + appGoCounterUserspaceNs = "go-app-counter" + appGoCounterUserspaceDsName = "go-app-counter-ds" ) func TestApplicationGoCounter(t *testing.T) { @@ -51,7 +51,7 @@ func TestApplicationGoCounter(t *testing.T) { // Wait 5 minutes since cosign is slow, https://github.com/bpfman/bpfman/issues/1043 5*time.Minute, 10*time.Second) - pods, err := env.Cluster().Client().CoreV1().Pods(appGoCounterUserspaceNs).List(ctx, metav1.ListOptions{LabelSelector: "name=go-application-counter"}) + pods, err := env.Cluster().Client().CoreV1().Pods(appGoCounterUserspaceNs).List(ctx, metav1.ListOptions{LabelSelector: "name=go-app-counter"}) require.NoError(t, err) goAppCounterPod := pods.Items[0]