🌱 ORC: Generate common parts of resource API #2203

mdbooth · 2024-10-22T10:07:42Z

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

netlify · 2024-10-22T10:07:58Z

✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name	Link
🔨 Latest commit	`e4e85c3`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-openstack/deploys/671f60db3260220008a9c7e6
😎 Deploy Preview	https://deploy-preview-2203--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

lentzi90

/approve
(tiny typo below)

lentzi90 · 2024-10-24T08:08:30Z

orc/cmd/resource-generator/data/api.template

+	// +kubebuilder:validation:Format:=uuid
+	ID *string `json:"id,omitempty"`
+
+	// Filter contains an resource query which is expected to return a single


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

k8s-ci-robot · 2024-10-24T08:09:42Z

[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:

~~OWNERS~~ [lentzi90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pierreprinetti

This is a great first step. Thank you for setting up this generator! I hope its life will be glorious and short, until we can use generics in the API.

pierreprinetti · 2024-10-25T10:16:43Z

orc/cmd/resource-generator/data/api.template

+	// Import refers to an existing ORC object which will be imported instead of
+	// creating a new resource.


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.

pierreprinetti · 2024-10-25T10:19:23Z

orc/cmd/resource-generator/data/api.template

+	Filter *{{ .Name }}Filter `json:"filter,omitempty"`
+}
+
+// {{ .Name }}Spec defines the desired state of a ORC object.


a or an?

pierreprinetti · 2024-10-25T10:22:54Z

orc/cmd/resource-generator/data/api.template

+	//
+	// Resource may not be specified if the management policy is `unmanaged`.
+	//
+	// Resource must be specified when the management policy is `managed`.


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`.

pierreprinetti · 2024-10-25T10:25:20Z

orc/cmd/resource-generator/data/api.template

+
+	// 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


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

Honestly I can't think of a practical case when I'd use 'nor' outside of formal logic except: neither this not that. It would be weird here.

pierreprinetti · 2024-10-25T10:27:16Z

orc/cmd/resource-generator/data/api.template

+	// Progressing indicates the state of the OpenStack resource not currently
+	// reflect the desired state, but that reconciliation is progressing.


Is it just me or this sentence reads weird?

pierreprinetti · 2024-10-25T11:11:09Z

orc/cmd/resource-generator/main.go

+		APIVersion: "v1alpha1",
+		SpecExtraValidations: []specExtraValidation{
+			{
+				Rule:    "!has(self.__import__) ? has(self.resource.content) : true",


This is a good first step, but going forward we probably want a more structured way to define required fields in the spec...

This particular one is special because the Image controller is a snowflake. This is a controller-specific validation at the spec level. I don't expect this to be a common pattern.

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.

pierreprinetti · 2024-10-28T09:49:42Z

/lgtm

mdbooth · 2024-10-28T09:57:19Z

Just discovered a templating bug in this PR while adding subnet: the spec ends up on the same line as the previous validation. Will fix.

mdbooth · 2024-10-28T12:31:25Z

/hold cancel

EmilienM · 2024-10-28T12:31:28Z

/lgtm

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 22, 2024

k8s-ci-robot requested review from jichenjc and lentzi90 October 22, 2024 10:07

lentzi90 reviewed Oct 24, 2024

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 24, 2024

pierreprinetti reviewed Oct 25, 2024

View reviewed changes

mdbooth added 2 commits October 28, 2024 09:43

ORC: Move main.go under cmd/manager

58dafa4

mdbooth force-pushed the resource-generator branch from 5d4c506 to d5e31bb Compare October 28, 2024 09:46

k8s-ci-robot assigned pierreprinetti Oct 28, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 28, 2024

ORC: Generate common parts of resource API

e4e85c3

mdbooth force-pushed the resource-generator branch from d5e31bb to e4e85c3 Compare October 28, 2024 10:00

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 28, 2024

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 28, 2024

k8s-ci-robot assigned EmilienM Oct 28, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 28, 2024

k8s-ci-robot merged commit 663ba86 into kubernetes-sigs:main Oct 28, 2024
9 checks passed

mdbooth deleted the resource-generator branch October 28, 2024 12:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 ORC: Generate common parts of resource API #2203

🌱 ORC: Generate common parts of resource API #2203

mdbooth commented Oct 22, 2024

netlify bot commented Oct 22, 2024 •

edited

Loading

lentzi90 left a comment

lentzi90 Oct 24, 2024

k8s-ci-robot commented Oct 24, 2024

pierreprinetti left a comment

pierreprinetti Oct 25, 2024

pierreprinetti Oct 25, 2024

pierreprinetti Oct 25, 2024

pierreprinetti Oct 25, 2024

mdbooth Oct 28, 2024

pierreprinetti Oct 25, 2024

mdbooth Oct 28, 2024

pierreprinetti Oct 25, 2024

mdbooth Oct 28, 2024

pierreprinetti commented Oct 28, 2024

mdbooth commented Oct 28, 2024

mdbooth commented Oct 28, 2024

EmilienM commented Oct 28, 2024

	// Filter contains an resource query which is expected to return a single
	// Filter contains a resource query which is expected to return a single

		// Import refers to an existing ORC object which will be imported instead of
		// creating a new resource.

	// Resource must be specified when the management policy is `managed`.
	// Resource must be specified if the management policy is `managed`.

	// 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

		// Progressing indicates the state of the OpenStack resource not currently
		// reflect the desired state, but that reconciliation is progressing.

🌱 ORC: Generate common parts of resource API #2203

🌱 ORC: Generate common parts of resource API #2203

Conversation

mdbooth commented Oct 22, 2024

netlify bot commented Oct 22, 2024 • edited Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

lentzi90 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 24, 2024

pierreprinetti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pierreprinetti commented Oct 28, 2024

mdbooth commented Oct 28, 2024

mdbooth commented Oct 28, 2024

EmilienM commented Oct 28, 2024

netlify bot commented Oct 22, 2024 •

edited

Loading