New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds Support for Azure Express Route Circuit. #259

Open

praveenghuge wants to merge 5 commits into crossplane-contrib:master from praveenghuge:az_erc

praveenghuge commented Jun 7, 2021 •

edited

Loading

Description of your changes

Adds Support for Express Route Circuit.

Fixes #258

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.

root and others added 4 commits

June 7, 2021 06:21


          Azure ExpressRoute: initial commit

2b26e9c

Signed-off-by: Praveen Ghuge <praveen.ghuge@outlook.com>


          add package to controller

17047cf

Signed-off-by: Praveen Ghuge <praveen.ghuge@outlook.com>


          complete CRD operations

cca5478

Signed-off-by: Praveen Ghuge <praveen.ghuge@outlook.com>


          minor changes

b9df69d

Signed-off-by: Praveen Ghuge <praveen.ghuge@outlook.com>

praveenghuge force-pushed the az_erc branch from 413fed3 to b9df69d Compare

June 7, 2021 13:21

praveenghuge changed the title ~~Az erc~~ Adds Support for Express Route Circuit.

praveenghuge changed the title ~~Adds Support for Express Route Circuit.~~ Adds Support for Azure Express Route Circuit.

negz closed this

negz reopened this

ulucinar requested changes

View reviewed changes

Collaborator

ulucinar left a comment

Thank you @praveenghuge for working on this. We need to add tests for the client package and the controller package before merging this. Please also take a look at the Crossplane managed resource API conventions doc for how we use the '// +optionalmarker comment and the pointer types for optional fields. Also, could you please rebase this PR onto the current HEAD of themasterbranch, and make sure all your commits are signed following the guide [here](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits). We also require them to be signed-off using something similar togit commit -s. git log --show-signature` should display commit signatures.

Thank you very much!

apis/network/v1alpha3/types.go

@@ @@ -226,3 +226,104 @@ type SubnetList struct { @@
               	metav1.ListMeta `json:"metadata,omitempty"`
               	Items           []Subnet `json:"items"`
               }
+              // ExpressRouteCircuitsPropertiesFormat defines properties of a ExpressRouteCircuits.
+              type ExpressRouteCircuitsPropertiesFormat struct {

Collaborator

ulucinar Sep 22, 2021

Suggested change

      
            type ExpressRouteCircuitsPropertiesFormat struct {
          
            type ExpressRouteCircuitPropertiesFormat struct {

The corresponding model type name in azure-sdk-for-go is singular: network.ExpressRouteCircuitPropertiesFormat.

apis/network/v1alpha3/types.go

Comment on lines +234 to +240

+              	ServiceProviderName *string `json:"serviceProviderName,omitempty"`
+              	// BandwidthInMbps - Flag denotes bandwithwidth in Mbps.
+              	BandwidthInMbps *int32 `json:"bandwidthInMbps,omitempty"`
+              	// PeeringLocation - Flag denotes peering location.
+              	PeeringLocation *string `json:"peeringLocation,omitempty"`

Collaborator

ulucinar Sep 23, 2021

Per Crossplane MR API conventions document, we had better reflect the azure-sdk-for-go model of this resource for our high fidelity goal. I think we had better move these fields to their own struct, ExpressRouteCircuitServiceProviderProperties, reflecting its SDK model. This will also pay off when we add, for instance, the ExpressRouteCircuitPropertiesFormat.BandwidthInGbps in addition to the proposed ExpressRouteCircuitServiceProviderProperties.BandwidthInMbps.

apis/network/v1alpha3/types.go

@@ @@ -226,3 +226,104 @@ type SubnetList struct { @@
               	metav1.ListMeta `json:"metadata,omitempty"`
               	Items           []Subnet `json:"items"`
               }
+              // ExpressRouteCircuitsPropertiesFormat defines properties of a ExpressRouteCircuits.
+              type ExpressRouteCircuitsPropertiesFormat struct {

Collaborator

ulucinar Sep 23, 2021

nit: We may consider adding the currently missing fields like ExpressRouteCircuitPropertiesFormat.BandwidthInGbps, ExpressRouteCircuitPropertiesFormat.Peerings, etc.

apis/network/v1alpha3/types.go

+              // SKU contains SKU in an ExpressRouteCircuit.
+              type SKU struct {
+              	// Tier - The tier of the SKU. Possible values include: 'ExpressRouteCircuitSkuTierStandard', 'ExpressRouteCircuitSkuTierPremium', 'ExpressRouteCircuitSkuTierBasic', 'ExpressRouteCircuitSkuTierLocal'
+              	Tier string `json:"tier,omitempty"`

Collaborator

ulucinar Sep 23, 2021

If this is optional:

Suggested change

      
            	Tier string `json:"tier,omitempty"`
          
            	// +optional
          
            	Tier *string `json:"tier,omitempty"`

apis/network/v1alpha3/types.go

+              	// Tier - The tier of the SKU. Possible values include: 'ExpressRouteCircuitSkuTierStandard', 'ExpressRouteCircuitSkuTierPremium', 'ExpressRouteCircuitSkuTierBasic', 'ExpressRouteCircuitSkuTierLocal'
+              	Tier string `json:"tier,omitempty"`
+              	// Family - The family of the SKU. Possible values include: 'UnlimitedData', 'MeteredData'
+              	Family string `json:"family,omitempty"`

Collaborator

ulucinar Sep 23, 2021

If this is optional:

Suggested change

      
            	Family string `json:"family,omitempty"`
          
            	// +optional
          
            	Family *string `json:"family,omitempty"`

pkg/controller/network/expressroutecircuits/managed.go

Comment on lines +97 to +102

+              	if azureclients.IsNotFound(err) {
+              		return managed.ExternalObservation{ResourceExists: false}, nil
+              	}
+              	if err != nil {
+              		return managed.ExternalObservation{}, errors.Wrap(err, errGetExpressRouteCircuits)
+              	}

Collaborator

ulucinar Sep 23, 2021

Suggested change

      
            	if azureclients.IsNotFound(err) {
          
            		return managed.ExternalObservation{ResourceExists: false}, nil
          
            	}
          
            	if err != nil {
          
            		return managed.ExternalObservation{}, errors.Wrap(err, errGetExpressRouteCircuits)
          
            	}
          
            	if err != nil {
          
            		return managed.ExternalObservation{}, errors.Wrap(resource.Ignore(azure.IsNotFound, err), errGetExpressRouteCircuits)
          
            	}

pkg/controller/network/expressroutecircuits/managed.go

+              	network.UpdateExpressRouteCircuitStatusFromAzure(exp, az)
+              	exp.SetConditions(xpv1.Available())
+              	o := managed.ExternalObservation{

Collaborator

ulucinar Sep 23, 2021 •

edited

Loading

We also need to check if the MR is up-to-date with the external resource, and report back (to the managed reconciler) this information via managed.ExternalObservation.ResourceUpToDate. The current implementation is always telling the managed reconciler that the managed resource is not up-to-date with the external resource, scheduling probably unnecessary reconciliations for updates.

pkg/controller/network/expressroutecircuits/managed.go

+              		return managed.ExternalCreation{}, errors.New(errNotExpressRouteCircuits)
+              	}
+              	exp.Status.SetConditions(xpv1.Creating())

Collaborator

ulucinar Sep 23, 2021

Suggested change

exp.Status.SetConditions(xpv1.Creating())

crossplane-runtime can now handle setting "creating" and "deleting" conditions.

pkg/controller/network/expressroutecircuits/managed.go

+              		return managed.ExternalUpdate{}, errors.Wrap(err, errGetExpressRouteCircuits)
+              	}
+              	if network.ExpressRouteCircuitNeedsUpdate(exp, az) {

Collaborator

ulucinar Sep 23, 2021

We should be reporting drifts via the return value managed.ExternalObservation.ResourceUpToDate of external.Observe. Please see the above comments.

pkg/controller/network/expressroutecircuits/managed.go

+              		return errors.New(errNotExpressRouteCircuits)
+              	}
+              	mg.SetConditions(xpv1.Deleting())

Collaborator

ulucinar Sep 23, 2021

Suggested change

mg.SetConditions(xpv1.Deleting())

crossplane-runtime can now handle setting "creating" and "deleting" conditions.


          Merge branch 'crossplane:master' into az_erc

7b621ab

Collaborator

ulucinar commented Oct 21, 2021

Hi @praveenghuge,
Thank you for opening this PR. Are you planning to continue working on this or should we plan a hand over?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet