Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial support for Load/Attach Split
Includes support for Cluster-Scoped XDP, TXC, and Fentry Programs This commit introduces the foundation for the load/attach split, including: - Updates to the `BpfApplication` CRD to support a separate list of optional attach points for programs. This allows programs to be loaded before attachments are made and enables dynamic attachment updates. - An initial version of the `BpfApplicationState` CRD to manage per-node information for a single `BpfApplication`. - Proof of concept and initial implementation for cluster-scoped XDP, TCX, and Fentry programs, with working unit tests and samples. See TODO.md for more info. Signed-off-by: Andre Fredette <[email protected]>
- Loading branch information
1 parent
d5ffe86
commit 69a1b95
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| The code has support for XDP, TCX, and Fentry programs in a BpfApplication | ||
|
|
||
| The new code is mainly in these directories: | ||
|
|
||
| Updated & working APIs: | ||
|
|
||
| - apis/v1alpha1/fentryProgram_types.go | ||
| - apis/v1alpha1/xdpProgram_types.go | ||
| - apis/v1alpha1/tcxProgram_types.go | ||
| - apis/v1alpha1/bpfApplication_types.go | ||
| - apis/v1alpha1/bpfApplicationState_types.go | ||
|
|
||
| Note: the rest are partially updated. | ||
|
|
||
| New Agent: | ||
|
|
||
| - controllers/app-agent | ||
|
|
||
| New Operator: | ||
|
|
||
| - controllers/app-operator | ||
|
|
||
| Note: I left the old bpfman-agent and bpfman-operator code unchanged (except as needed due to CRD changed). It should work, but it's not being initialized when we run the operator. | ||
|
|
||
| Testing: | ||
|
|
||
| - Unit tests for the agent and the operator | ||
| - The following working samples: | ||
| - config/samples/bpfman.io_v1alpha1_bpfapplication.yaml | ||
| - config/samples/bpfman.io_v1alpha1_fentry_bpfapplication.yaml | ||
|
|
||
| TODO: | ||
|
|
||
| - I want to redo the status/condition values. I’m currently using the existing framework and some values for status/conditions, but I intend to create a new set of conditions/status values that make more sense with the new design. | ||
| - Review all comments and logs. | ||
| - Maybe make more code common. | ||
| - Support the rest of the program types (including namespace-scoped CRDs). | ||
| - Integrate with the new bpfman code with load/attach split (of course) | ||
| - Lots more testing. | ||
| - Lots of other stuff (I'm sure). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| /* | ||
| Copyright 2023 The bpfman Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| metav1types "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| // BpfApplicationProgramState defines the desired state of BpfApplication | ||
| // +union | ||
| // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'XDP' ? has(self.xdp) : !has(self.xdp)",message="xdp configuration is required when type is XDP, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'TC' ? has(self.tc) : !has(self.tc)",message="tc configuration is required when type is TC, and forbidden otherwise" | ||
| // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'TCX' ? has(self.tcx) : !has(self.tcx)",message="tcx configuration is required when type is TCX, and forbidden otherwise" | ||
| // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Fentry' ? has(self.fentry) : !has(self.fentry)",message="fentry configuration is required when type is Fentry, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Fexit' ? has(self.fexit) : !has(self.fexit)",message="fexit configuration is required when type is Fexit, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Kprobe' ? has(self.kprobe) : !has(self.kprobe)",message="kprobe configuration is required when type is Kprobe, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Kretprobe' ? has(self.kretprobe) : !has(self.kretprobe)",message="kretprobe configuration is required when type is Kretprobe, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Uprobe' ? has(self.uprobe) : !has(self.uprobe)",message="uprobe configuration is required when type is Uprobe, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Uretprobe' ? has(self.uretprobe) : !has(self.uretprobe)",message="uretprobe configuration is required when type is Uretprobe, and forbidden otherwise" | ||
| // // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Tracepoint' ? has(self.tracepoint) : !has(self.tracepoint)",message="tracepoint configuration is required when type is Tracepoint, and forbidden otherwise" | ||
| type BpfApplicationProgramState struct { | ||
| // ProgramAttachStatus records whether the program should be loaded and whether | ||
| // the program is loaded. | ||
| ProgramAttachStatus BpfProgramConditionType `json:"programattachstatus"` | ||
|
|
||
| // ProgramId is the id of the program in the kernel. Not set until the | ||
| // program is loaded. | ||
| // +optional | ||
| ProgramId *uint32 `json:"program_id"` | ||
|
|
||
| // Type specifies the bpf program type | ||
| // +unionDiscriminator | ||
| // +kubebuilder:validation:Required | ||
| // +kubebuilder:validation:Enum:="XDP";"TC";"TCX";"Fentry";"Fexit";"Kprobe";"Kretprobe";"Uprobe";"Uretprobe";"Tracepoint" | ||
| Type EBPFProgType `json:"type,omitempty"` | ||
|
|
||
| // xdp defines the desired state of the application's XdpPrograms. | ||
| // +unionMember | ||
| // +optional | ||
| XDP *XdpProgramInfoState `json:"xdp,omitempty"` | ||
|
|
||
| // // tc defines the desired state of the application's TcPrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // TC *TcProgramInfoState `json:"tc,omitempty"` | ||
|
|
||
| // tcx defines the desired state of the application's TcxPrograms. | ||
| // +unionMember | ||
| // +optional | ||
| TCX *TcxProgramInfoState `json:"tcx,omitempty"` | ||
|
|
||
| // fentry defines the desired state of the application's FentryPrograms. | ||
| // +unionMember | ||
| // +optional | ||
| Fentry *FentryProgramInfoState `json:"fentry,omitempty"` | ||
|
|
||
| // // fexit defines the desired state of the application's FexitPrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Fexit *FexitProgramInfoState `json:"fexit,omitempty"` | ||
|
|
||
| // // kprobe defines the desired state of the application's KprobePrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Kprobe *KprobeProgramInfoState `json:"kprobe,omitempty"` | ||
|
|
||
| // // kretprobe defines the desired state of the application's KretprobePrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Kretprobe *KprobeProgramInfoState `json:"kretprobe,omitempty"` | ||
|
|
||
| // // uprobe defines the desired state of the application's UprobePrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Uprobe *UprobeProgramInfoState `json:"uprobe,omitempty"` | ||
|
|
||
| // // uretprobe defines the desired state of the application's UretprobePrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Uretprobe *UprobeProgramInfoState `json:"uretprobe,omitempty"` | ||
|
|
||
| // // tracepoint defines the desired state of the application's TracepointPrograms. | ||
| // // +unionMember | ||
| // // +optional | ||
| // Tracepoint *TracepointProgramInfoState `json:"tracepoint,omitempty"` | ||
| } | ||
|
|
||
| // BpfApplicationSpec defines the desired state of BpfApplication | ||
| type BpfApplicationStateSpec struct { | ||
| // The number of times the BpfApplicationState has been updated. Set to 1 | ||
| // when the object is created, then it is incremented prior to each update. | ||
| // This allows us to verify that the API server has the updated object prior | ||
| // to starting a new Reconcile operation. | ||
| UpdateCount int64 `json:"updatecount"` | ||
| // AppLoadStatus reflects the status of loading the bpf application on the | ||
| // given node. | ||
| AppLoadStatus BpfProgramConditionType `json:"apploadstatus"` | ||
| // Programs is a list of bpf programs contained in the parent application. | ||
| // It is a map from the bpf program name to BpfApplicationProgramState | ||
| // elements. | ||
| Programs map[string]BpfApplicationProgramState `json:"programs,omitempty"` | ||
| } | ||
|
|
||
| // +genclient | ||
| // +genclient:nonNamespaced | ||
| // +kubebuilder:object:root=true | ||
| // +kubebuilder:subresource:status | ||
| // +kubebuilder:resource:scope=Cluster | ||
|
|
||
| // BpfApplicationState contains the per-node state of a BpfApplication. | ||
| // ANF-TODO: I can't get the Node to display in the kubectl output. | ||
| // // +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".metadata.labels['kubernetes.io/hostname']" | ||
| // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[0].reason` | ||
| // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" | ||
| type BpfApplicationState struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec BpfApplicationStateSpec `json:"spec,omitempty"` | ||
| Status BpfAppStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
| // BpfApplicationStateList contains a list of BpfApplicationState objects | ||
| type BpfApplicationStateList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []BpfApplicationState `json:"items"` | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetName() string { | ||
| return an.Name | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetUID() metav1types.UID { | ||
| return an.UID | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetAnnotations() map[string]string { | ||
| return an.Annotations | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetLabels() map[string]string { | ||
| return an.Labels | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetStatus() *BpfAppStatus { | ||
| return &an.Status | ||
| } | ||
|
|
||
| func (an BpfApplicationState) GetClientObject() client.Object { | ||
| return &an | ||
| } | ||
|
|
||
| func (anl BpfApplicationStateList) GetItems() []BpfApplicationState { | ||
| return anl.Items | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.