Merge pull request #1808 from enxebre/awsendpoint-comments

Add comments to clarify aws endpoints controllers
openshift · Oct 18, 2022 · 5f903f2 · 5f903f2
2 parents e9c6b9f + 4b04129
commit 5f903f2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/control-plane-operator/controllers/awsprivatelink/awsprivatelink_controller.go b/control-plane-operator/controllers/awsprivatelink/awsprivatelink_controller.go
@@ -46,6 +46,8 @@ const (
 	defaultResync = 10 * time.Hour
 )
 
+// PrivateServiceObserver watches a given Service type LB and reconciles
+// an awsEndpointService CR representation for it.
 type PrivateServiceObserver struct {
 	client.Client
 
@@ -171,6 +173,8 @@ const (
 	routerDomain                           = "apps"
 )
 
+// AWSEndpointServiceReconciler watches AWSEndpointService resources and reconciles
+// the existence of AWS Endpoints for it in the guest cluster infrastructure.
 type AWSEndpointServiceReconciler struct {
 	client.Client
 	ec2Client     ec2iface.EC2API

diff --git a/hypershift-operator/controllers/platform/aws/controller.go b/hypershift-operator/controllers/platform/aws/controller.go
@@ -46,6 +46,9 @@ const (
 	lbNotActiveRequeueDuration             = 20 * time.Second
 )
 
+// AWSEndpointServiceReconciler watches HC/NodePools/awsEndpointService and reconcile the awsEndpointService
+// CRs existing for the KubeAPIServerPrivateService and the PrivateRouterService.
+// It creates the endpoint service in AWS and keeps the SubnetIDs up to date so NodePools are able to attach to the service endpoint.
 type AWSEndpointServiceReconciler struct {
 	client.Client
 	upsert.CreateOrUpdateProvider