Rename serialized ForProvider as "forProvider" #309

ulucinar · 2021-11-30T07:55:16Z

Description of your changes

I have:

Read and followed Crossplane's contribution process.
Run make reviewable test to ensure this PR is ready for review.

How has this code been tested

Manually tested using the example manifest provided in the repo, examples/network/publicipaddress.yaml.

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar · 2021-11-30T07:56:14Z

apis/network/v1alpha3/types.go

@@ -230,12 +230,11 @@ type SubnetList struct {
 // A PublicIPAddressSpec defines the desired state of a PublicIPAddress.
 type PublicIPAddressSpec struct {
 	xpv1.ResourceSpec `json:",inline"`
-	// +kubebuilder:validation:Required
-	ForProvider PublicIPAddressFormat `json:"properties"`
+	ForProvider       PublicIPAddressProperties `json:"forProvider"`


Per Crossplane conventions, we had better rename the serialized form as forProvider instead of properties.

ulucinar · 2021-11-30T07:57:04Z

apis/network/v1alpha3/types.go

-// PublicIPAddressFormat defines properties of the PublicIPAddress.
-type PublicIPAddressFormat struct {
+// PublicIPAddressProperties defines properties of the PublicIPAddress.
+type PublicIPAddressProperties struct {


Again let's stick to the repo conventions by using Properties as a suffix.

ulucinar · 2021-11-30T08:01:27Z

apis/network/v1alpha3/types.go

 	// +kubebuilder:validation:Enum=Standard;Basic
-	Name string `json:"name,omitempty"`
+	Name string `json:"name"`


spec.forProvider.sku is optional. However, if a spec.forProvider.sku is specified, I think we need to have its name also specified. Thus removing the omitempty tag.

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

- Previously, these were IPV4 & IPv6, which do not match Azure SDK constants Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar · 2021-11-30T11:42:07Z

apis/network/v1alpha3/types.go

+// A PublicIPAddressStatus represents the observed state of a SQLServer.
+type PublicIPAddressStatus struct {
+	xpv1.ResourceStatus `json:",inline"`
+	AtProvider          PublicIPAddressObservation `json:"atProvider,omitempty"`


Per Crossplane conventions, let's move the observation under to status.atProvider.

ulucinar · 2021-11-30T11:42:54Z

apis/network/v1alpha3/types.go

 	PublicIPAllocationMethod string `json:"allocationMethod"`

-	// PublicIPAllocationMethod - The public IP address version. Possible values include: 'IPV4', 'IPV6'
+	// PublicIPAllocationMethod - The public IP address version. Possible values include: 'IPv4', 'IPv6'


Looks like the SDK constants are defined as IPv4 and IPv6.

apis/network/v1alpha3/types.go

muvaf · 2021-11-30T11:57:56Z

apis/network/v1alpha3/types.go

 }

-// PublicIPAddressFormat defines properties of the PublicIPAddress.
-type PublicIPAddressFormat struct {
+// PublicIPAddressProperties defines properties of the PublicIPAddress.


FYI, looks like there are many more properties that can be specified for PublicIPAdress.

We may consider adding them in later PRs unless there is immediate need, what do you think @muvaf?

I personally prefer making it complete while I have the context of the resource, otherwise I'd have to load all that later again, but it can be merged as an alpha resource with less properties than full.

It turns out that we are not sure regarding the immediate requirements around this resource. Hence, I've extended the API surface.

- spec.forProvider.{version,allocationMethod,location} are now marked as immutable and are not considered during drift detection. SDK does not allow such updates in a straightforward manner. Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

- Remove "FQDN" from spec.atProvider's DNS settings as it's a read-only property Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

muvaf

Thanks @ulucinar ! Looks good to merge after resolving non-nitpick comments.

pkg/controller/network/publicipaddress/managed.go

muvaf · 2021-12-02T11:01:09Z

pkg/controller/network/publicipaddress/managed.go

+	if err := e.kube.Update(ctx, s); err != nil {
+		return managed.ExternalObservation{}, errors.Wrap(err, errUpdateCR)
+	}
+


We usually update only if there is a diff and used to do kube.Update for late-init in old controllers but the recommended way today is to return ResourceLateInitialized: true to make managed reconciler handle it.

Thanks @muvaf for the ResourceLateInitialized: true suggestion. I've removed the embedded controller-runtime client from our external client implementation and now always set ObservationResult.ResourceLateInitialized accordingly.

We can at a later time revisit provider-azure's late-initialization utility functions so that they report whether fields have been late-initialized.

While working on this, I had also considered using cmp.Equal to detect any changes after late-initialization, however, I did not choose to do so as API server already detects noops and does not update the resource. However, leaving update calls to the managed reconciler is I think a good compromise.

I just realized that if we leave this to the managed reconciler, we are losing any status updates. So, I'm reverting back to making the update call in-site as we already do elsewhere in the repo:
https://github.com/crossplane/provider-azure/blob/8380dd2d85e0391bd02e23c5c47c13f8962c38a7/pkg/controller/database/postgresqlserver/managed.go#L122

So returning ResourceLateInitialized: true makes us lose status updates and I'd like to address proper calculation of this in a repo-wide manner.

As I mentioned, one alternative could be to:

Make a deep-copy of the spec.forProvider

Run late-initialization logic on it

Compare it with the current spec.forProvider using cmp.Equal to determine whether there is a spec change,

but I prefer not to take this approach right now as I don't believe it's necessary to do so. We could modify the late-init utilities in the repo to report such updates.

pkg/clients/network/network.go

pkg/controller/network/publicipaddress/managed.go

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

Rename serialized ForProvider as "forProvider"

d7d721a

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar commented Nov 30, 2021

View reviewed changes

ulucinar requested review from sergenyalcin and muvaf November 30, 2021 08:02

ulucinar mentioned this pull request Nov 30, 2021

PublicIPAddress support #264

Merged

2 tasks

ulucinar added 3 commits November 30, 2021 13:25

Move observed state to status.atProvider

578de05

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

Add support for drift detection via network.IsPublicIPAddressUpToDate

9bb3ffd

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

Use "IPv4" & "IPv6" as spec.forProvider.version values

ae66fd5

- Previously, these were IPV4 & IPv6, which do not match Azure SDK constants Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar force-pushed the review-pubipaddr branch from bcfb32e to 072fe18 Compare November 30, 2021 11:38

ulucinar commented Nov 30, 2021

View reviewed changes

ulucinar force-pushed the review-pubipaddr branch from 072fe18 to 1abc62f Compare November 30, 2021 11:55

muvaf reviewed Nov 30, 2021

View reviewed changes

ulucinar force-pushed the review-pubipaddr branch from 1abc62f to bb4cb3d Compare November 30, 2021 12:56

ulucinar force-pushed the review-pubipaddr branch 3 times, most recently from 8d4ef4a to 759d10e Compare December 1, 2021 14:24

Add other PublicIPAddress configuration properties

2a6da58

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar force-pushed the review-pubipaddr branch from 759d10e to 2a6da58 Compare December 1, 2021 15:00

Add new fields to the example manifest

4515f75

- Remove "FQDN" from spec.atProvider's DNS settings as it's a read-only property Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar requested a review from turkenh December 2, 2021 10:02

muvaf approved these changes Dec 2, 2021

View reviewed changes

Rename check* functions as is*UpToDate

3ff1b85

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>

ulucinar force-pushed the review-pubipaddr branch from 1c74f51 to 3ff1b85 Compare December 2, 2021 15:52

ulucinar merged commit 7e7f436 into crossplane-contrib:master Dec 2, 2021

ulucinar deleted the review-pubipaddr branch December 2, 2021 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename serialized ForProvider as "forProvider" #309

Rename serialized ForProvider as "forProvider" #309

ulucinar commented Nov 30, 2021 •

edited

Loading

ulucinar Nov 30, 2021

ulucinar Nov 30, 2021

ulucinar Nov 30, 2021

ulucinar Nov 30, 2021

ulucinar Nov 30, 2021

muvaf Nov 30, 2021

ulucinar Nov 30, 2021

muvaf Nov 30, 2021

ulucinar Dec 1, 2021

muvaf left a comment

muvaf Dec 2, 2021

ulucinar Dec 2, 2021

ulucinar Dec 2, 2021 •

edited

Loading

Rename serialized ForProvider as "forProvider" #309

Rename serialized ForProvider as "forProvider" #309

Conversation

ulucinar commented Nov 30, 2021 • edited Loading

Description of your changes

How has this code been tested

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

muvaf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ulucinar Dec 2, 2021 • edited Loading

Choose a reason for hiding this comment

ulucinar commented Nov 30, 2021 •

edited

Loading

ulucinar Dec 2, 2021 •

edited

Loading