⚠️ Remove InstanceID from machine spec by mdbooth · Pull Request #1961 · kubernetes-sigs/cluster-api-provider-openstack

mdbooth · 2024-03-20T10:31:39Z

This is a status field and should not be included in the spec. ProviderID is the same, but cannot be removed as it is required by Cluster API.

While we're changing it, we change the default printcolumns for OpenStackMachine to report server ID instead of provider ID. We don't need to report provider ID here because we already know everything is an openstack server. New output example:

> kc get openstackmachine
NAME             CLUSTER    SERVERID                               INSTANCESTATE   READY   MACHINE          AGE
test-foo-fbvcg   test-foo   b4547d60-0f7e-44ea-b77a-30e951556fe3   ACTIVE          true    test-foo-fbvcg   5m52s

/hold

k8s-ci-robot · 2024-03-20T10:31:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mdbooth

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [mdbooth]

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

netlify · 2024-03-20T10:32:05Z

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

Name	Link
🔨 Latest commit	`a3c6d59`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-openstack/deploys/6606e14fd08a6500089cc8c9
😎 Deploy Preview	https://deploy-preview-1961--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.

mdbooth · 2024-03-20T15:17:14Z

This needs a docs update, and also an update to the machine printcolumns.

mdbooth · 2024-03-20T16:26:24Z

Should be good to go now.

mdbooth · 2024-03-21T17:41:11Z

/test pull-cluster-api-provider-openstack-e2e-full-test

MaysaMacedo · 2024-03-21T19:14:44Z

pkg/cloud/services/compute/instance_types.go


-	openStackCluster.Status.Bastion.ID = is.ID()
 	openStackCluster.Status.Bastion.Name = is.Name()
-	openStackCluster.Status.Bastion.SSHKeyName = is.SSHKeyName()


with SSHKeyName being removed, the function at line 91 can also be removed.

Also, it's worth documenting that these fields are being removed

Both addressed. Also noticed that we weren't using AvailabilityZone() any more and removed that, too.

mdbooth · 2024-03-22T15:30:37Z

/test pull-cluster-api-provider-openstack-e2e-full-test

MaysaMacedo · 2024-03-22T19:43:34Z

api/v1alpha6/openstackmachine_conversion.go


+func restorev1alpha6MachineStatus(previous *OpenStackMachineStatus, dst *OpenStackMachineStatus) {
+	if dst.InstanceState == nil || *dst.InstanceState == "" {
+		dst.InstanceState = previous.InstanceState


the other restore functions skip the setting of previous into dst when the resource is empty/nil. Should we follow the same pattern here?

I've been adding that incrementally. As this is a new function I should have added it here.

MaysaMacedo · 2024-03-22T19:45:56Z

docs/book/src/topics/crd-changes/v1alpha7-to-v1beta1.md


+#### Removal of instanceID from spec
+
+The OpenStackMachine controller previously set `instanceID` in the machine spec, in addition to `providerID`. `providerID` remains unchanged as it is required by Cluster API, but `instanceID` is no longer set. If still required, it is now available in the status in `dependentResources`.


dependentResources should be renamed to resources

MaysaMacedo · 2024-03-22T19:47:28Z

api/v1beta1/openstackmachine_types.go

 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this OpenStackMachine belongs"
-// +kubebuilder:printcolumn:name="InstanceState",type="string",JSONPath=".status.instanceState",description="OpenStack instance state"
+// +kubebuilder:printcolumn:name="ServerID",type="string",JSONPath=".status.dependentResources.server.id",description="OpenStack instance ID"


dependentResources should now be resources?

Updated and re-tested on a running cluster:

> kc get openstackmachine NAME CLUSTER SERVERID INSTANCESTATE READY MACHINE AGE test-foo-c4wdz test-foo a5500a2d-d1f8-4b8e-a7bb-2b94977eb893 BUILD test-foo-c4wdz 4m26s

MaysaMacedo · 2024-03-22T19:47:34Z

api/v1beta1/openstackmachine_types.go

 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this OpenStackMachine belongs"
-// +kubebuilder:printcolumn:name="InstanceState",type="string",JSONPath=".status.instanceState",description="OpenStack instance state"
+// +kubebuilder:printcolumn:name="ServerID",type="string",JSONPath=".status.dependentResources.server.id",description="OpenStack instance ID"
+// +kubebuilder:printcolumn:name="InstanceState",type="string",JSONPath=".status.dependentResources.server.state",description="OpenStack instance state"


MaysaMacedo · 2024-03-22T19:49:26Z

api/v1alpha7/openstackmachine_conversion.go

+}
+
+func Convert_v1alpha7_OpenStackMachineStatus_To_v1beta1_OpenStackMachineStatus(in *OpenStackMachineStatus, out *infrav1.OpenStackMachineStatus, s apiconversion.Scope) error {
+	// ReferencedResources have no equivalent in v1beta1


we probably want to replace ReferencedResources for Resolved

mdbooth · 2024-03-22T22:01:03Z

/test pull-cluster-api-provider-openstack-e2e-full-test

MaysaMacedo · 2024-03-25T13:29:06Z

/lgtm

k8s-ci-robot · 2024-03-25T17:02:05Z

New changes are detected. LGTM label has been removed.

mdbooth · 2024-03-25T17:07:50Z

api/v1beta1/types.go

 }

 type BastionStatus struct {
-	ID         string              `json:"id,omitempty"`


Should probably put bastion ID and State back, too.

It was the idea that State and ID goes into Server to mimic what's on OpenStackMachineStatus. No strong opinion from my side here.

mdbooth · 2024-03-25T17:08:28Z

api/v1beta1/types.go

+
+	// Server describes the OpenStack server created for the bastion
+	// +optional
+	Server *ServerStatus `json:"server,omitempty"`


Do we still need this?

This is a status field and should not be included in the spec. ProviderID is the same, but cannot be removed as it is required by Cluster API.

dulek · 2024-03-29T15:42:18Z

Okay, I think I found the issue.

k8s-ci-robot · 2024-03-29T16:25:24Z

@mdbooth: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-openstack-e2e-test	`a3c6d59`	link	true	`/test pull-cluster-api-provider-openstack-e2e-test`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot · 2024-03-29T16:25:31Z

PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mdbooth · 2024-04-01T10:27:35Z

I've decided to replace this with #1988, which has a smaller scope.

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. labels Mar 20, 2024

k8s-ci-robot requested review from EmilienM and lentzi90 March 20, 2024 10:31

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 20, 2024

mdbooth force-pushed the instanceidstatus branch from d29b359 to 0e6a0b3 Compare March 20, 2024 16:24

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 20, 2024

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 21, 2024

mdbooth force-pushed the instanceidstatus branch from 0e6a0b3 to 071f41f Compare March 21, 2024 11:43

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 21, 2024

mdbooth force-pushed the instanceidstatus branch from 071f41f to f5c1f4b Compare March 21, 2024 18:58

MaysaMacedo reviewed Mar 21, 2024

View reviewed changes

mdbooth force-pushed the instanceidstatus branch 2 times, most recently from 6b9c47b to 5275848 Compare March 22, 2024 13:40

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 22, 2024

mdbooth force-pushed the instanceidstatus branch from 5275848 to 084caa7 Compare March 22, 2024 18:08

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 22, 2024

MaysaMacedo reviewed Mar 22, 2024

View reviewed changes

k8s-ci-robot assigned MaysaMacedo Mar 25, 2024

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

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

mdbooth commented Mar 25, 2024

View reviewed changes

Remove InstanceID from machine spec

f88ecbf

This is a status field and should not be included in the spec. ProviderID is the same, but cannot be removed as it is required by Cluster API.

dulek force-pushed the instanceidstatus branch from 011a3a9 to c7a6cef Compare March 26, 2024 16:02

mdbooth and others added 3 commits March 29, 2024 16:38

Remove unused BastionStatus fields

0484ceb

Update stray references to dependentResources and referencedResources

6d8f168

Move Server from .Resources to .Status

a3c6d59

dulek force-pushed the instanceidstatus branch from c7a6cef to a3c6d59 Compare March 29, 2024 15:42

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 29, 2024

mdbooth mentioned this pull request Apr 1, 2024

⚠️ Move InstanceID from Spec to Status #1988

Merged

1 task

mdbooth closed this Apr 1, 2024

mdbooth deleted the instanceidstatus branch April 1, 2024 10:27


		#### Removal of instanceID from spec

		The OpenStackMachine controller previously set `instanceID` in the machine spec, in addition to `providerID`. `providerID` remains unchanged as it is required by Cluster API, but `instanceID` is no longer set. If still required, it is now available in the status in `dependentResources`.

Conversation

mdbooth commented Mar 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Mar 20, 2024

Uh oh!

netlify bot commented Mar 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

mdbooth commented Mar 20, 2024

Uh oh!

mdbooth commented Mar 20, 2024

Uh oh!

mdbooth commented Mar 21, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdbooth commented Mar 22, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdbooth commented Mar 22, 2024

Uh oh!

MaysaMacedo commented Mar 25, 2024

Uh oh!

k8s-ci-robot commented Mar 25, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dulek commented Mar 29, 2024

Uh oh!

k8s-ci-robot commented Mar 29, 2024

Uh oh!

k8s-ci-robot commented Mar 29, 2024

Uh oh!

mdbooth commented Apr 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mdbooth commented Mar 20, 2024 •

edited

Loading

netlify bot commented Mar 20, 2024 •

edited

Loading