refactor(crds): Use built-in OpenAPI validation #5129
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,42 +25,77 @@ import ( | |
| "github.com/seldonio/seldon-core/apis/go/v2/mlops/scheduler" | ||
| ) | ||
|
|
||
| //+kubebuilder:object:root=true | ||
| //+kubebuilder:subresource:status | ||
| //+kubebuilder:resource:shortName=mlp | ||
|
|
||
| // Pipeline is the Schema for the pipelines API | ||
| type Pipeline struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec PipelineSpec `json:"spec,omitempty"` | ||
| Status PipelineStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| //+kubebuilder:object:root=true | ||
|
|
||
| // PipelineList contains a list of Pipeline | ||
| type PipelineList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
|
|
||
| Items []Pipeline `json:"items"` | ||
| } | ||
|
|
||
| // PipelineSpec defines the desired state of Pipeline | ||
| type PipelineSpec struct { | ||
| // External inputs to this pipeline, optional | ||
| Input *PipelineInput `json:"input,omitempty"` | ||
|
|
||
| // The steps of this inference graph pipeline | ||
| Steps []PipelineStep `json:"steps"` | ||
|
|
||
| // Synchronous output from this pipeline, optional | ||
| Output *PipelineOutput `json:"output,omitempty"` | ||
| } | ||
|
|
||
| // +kubebuilder:validation:Enum=inner;outer;any | ||
| type JoinType string | ||
|
|
||
| const ( | ||
|
There was a problem hiding this comment. explain: It's not ideal that it's repeated here, but this approach seems common [1]. [1] https://github.com/search?q=%2Bkubebuilder%3Avalidation%3AEnum&type=code — e.g. Grafana, Cilium, etc. |
||
| // data must be available from all inputs | ||
| JoinTypeInner JoinType = "inner" | ||
| // data will include any data from any inputs at end of window | ||
| JoinTypeOuter JoinType = "outer" | ||
| // first data input that arrives will be forwarded | ||
| JoinTypeAny JoinType = "any" | ||
| ) | ||
|
|
||
| type PipelineStep struct { | ||
| // Name of the step | ||
| // +kubebuilder:validation:MinLength=1 | ||
| // +kubebuilder:validation:MaxLength=253 | ||
ukclivecox marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // +kubebuilder:validation:Pattern=`^[a-z0-9][a-z0-9\-\.]+[a-z0-9]+$` | ||
| Name string `json:"name"` | ||
|
|
||
| // Previous step to receive data from | ||
| Inputs []string `json:"inputs,omitempty"` | ||
|
|
||
| // msecs to wait for messages from multiple inputs to arrive before joining the inputs | ||
| JoinWindowMs *uint32 `json:"joinWindowMs,omitempty"` | ||
|
|
||
| // Map of tensor name conversions to use e.g. output1 -> input1 | ||
| TensorMap map[string]string `json:"tensorMap,omitempty"` | ||
|
|
||
| // Triggers required to activate step | ||
| Triggers []string `json:"triggers,omitempty"` | ||
|
|
||
| // +kubebuilder:default=inner | ||
| InputsJoinType *JoinType `json:"inputsJoinType,omitempty"` | ||
|
|
||
| TriggersJoinType *JoinType `json:"triggersJoinType,omitempty"` | ||
|
|
||
| // Batch size of request required before data will be sent to this step | ||
| Batch *PipelineBatch `json:"batch,omitempty"` | ||
| } | ||
|
|
@@ -74,25 +109,33 @@ type PipelineBatch struct { | |
| type PipelineInput struct { | ||
| // Previous external pipeline steps to receive data from | ||
| ExternalInputs []string `json:"externalInputs,omitempty"` | ||
|
|
||
| // Triggers required to activate inputs | ||
| ExternalTriggers []string `json:"externalTriggers,omitempty"` | ||
|
|
||
| // msecs to wait for messages from multiple inputs to arrive before joining the inputs | ||
| JoinWindowMs *uint32 `json:"joinWindowMs,omitempty"` | ||
|
|
||
| // +kubebuilder:default=inner | ||
| JoinType *JoinType `json:"joinType,omitempty"` | ||
|
|
||
| // +kubebuilder:default=inner | ||
| TriggersJoinType *JoinType `json:"triggersJoinType,omitempty"` | ||
|
|
||
| // Map of tensor name conversions to use e.g. output1 -> input1 | ||
| TensorMap map[string]string `json:"tensorMap,omitempty"` | ||
| } | ||
|
|
||
| type PipelineOutput struct { | ||
| // Previous step to receive data from | ||
| Steps []string `json:"steps,omitempty"` | ||
|
|
||
| // msecs to wait for messages from multiple inputs to arrive before joining the inputs | ||
| JoinWindowMs uint32 `json:"joinWindowMs,omitempty"` | ||
|
|
||
| // +kubebuilder:default=inner | ||
| StepsJoin *JoinType `json:"stepsJoin,omitempty"` | ||
|
|
||
| // Map of tensor name conversions to use e.g. output1 -> input1 | ||
| TensorMap map[string]string `json:"tensorMap,omitempty"` | ||
| } | ||
|
|
@@ -102,28 +145,6 @@ type PipelineStatus struct { | |
| duckv1.Status `json:",inline"` | ||
| } | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(&Pipeline{}, &PipelineList{}) | ||
| } | ||
|
|
||
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
explain: More conventional kubebuilder annotations to have this for both
structs, and to be ordered this way. This is also the same for the new lines between fields.