🌱 ORC: Generate common parts of resource API #2203
Open
Conversation
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
codegen depends on interfaces generated by controller-gen. However, controller-gen will fail during code inspection if the applyconfiguration package does not already exist because it is imported by the code being inspected. This is a bootstrapping problem. We ensure the applyconfiguration package exists by adding a doc.go.
k8s-ci-robot
added
do-not-merge/hold
✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
lentzi90
reviewed
Oct 24, 2024
| // +kubebuilder:validation:Format:=uuid | ||
| ID *string `json:"id,omitempty"` | ||
|
|
||
| // Filter contains an resource query which is expected to return a single |
There was a problem hiding this comment.
Suggested change
| // Filter contains an resource query which is expected to return a single | |
| // Filter contains a resource query which is expected to return a single |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lentzi90 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Comment on lines
+53
to
+54
| // Import refers to an existing ORC object which will be imported instead of | ||
| // creating a new resource. |
There was a problem hiding this comment.
An existing ORC object? Isn't this the ORC object?
Suggested change
| // Import refers to an existing ORC object which will be imported instead of | |
| // creating a new resource. | |
| // Import refers to an existing OpenStack resource which will be imported instead of | |
| // creating a new one. |
| Filter *{{ .Name }}Filter `json:"filter,omitempty"` | ||
| } | ||
|
|
||
| // {{ .Name }}Spec defines the desired state of a ORC object. |
| // | ||
| // Resource may not be specified if the management policy is `unmanaged`. | ||
| // | ||
| // Resource must be specified when the management policy is `managed`. |
There was a problem hiding this comment.
Unless an arcane grammar rule applies here, can we use if for both cases for consistency?
Suggested change
| // Resource must be specified when the management policy is `managed`. | |
| // Resource must be specified if the management policy is `managed`. |
|
|
||
| // ManagementPolicy defines how ORC will treat the object. Valid values are | ||
| // `managed`: ORC will create, update, and delete the resource; `unmanaged`: | ||
| // ORC will import an existing resource, and will not apply updates to it or |
There was a problem hiding this comment.
Is "nor" a word you'd use here?
Suggested change
| // ORC will import an existing resource, and will not apply updates to it or | |
| // ORC will import an existing resource, and will not apply updates to it nor |
Comment on lines
+92
to
+93
| // Progressing indicates the state of the OpenStack resource not currently | ||
| // reflect the desired state, but that reconciliation is progressing. |
There was a problem hiding this comment.
Is it just me or this sentence reads weird?
| APIVersion: "v1alpha1", | ||
| SpecExtraValidations: []specExtraValidation{ | ||
| { | ||
| Rule: "!has(self.__import__) ? has(self.resource.content) : true", |
There was a problem hiding this comment.
This is a good first step, but going forward we probably want a more structured way to define required fields in the spec...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a very simple code generator which simply uses a go template to generate the common parts of an ORC resource API.
My preference was to do this with generics, but for now this breaks controller-tools: kubernetes-sigs/controller-tools#844
/hold