Skip to content

Commit

Permalink
Improve the connectivity checking.
Browse files Browse the repository at this point in the history 
This makes the client check the server version which will be rejected if
the credentials don't allow it.

It also improves the status updating.
  • Loading branch information
@bigkevmcd
bigkevmcd committed Dec 8, 2023
1 parent 1d0c71d commit d3ef4b0
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 16 deletions.
2 changes: 1 addition & 1 deletion api/v1alpha1/gitopscluster_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func (in *GitopsCluster) SetConditions(conditions []metav1.Condition) {
// +kubebuilder:printcolumn:name="ClusterConnectivity",type="string",JSONPath=".status.conditions[?(@.type==\"ClusterConnectivity\")].status",description=""

// GitopsCluster is the Schema for the gitopsclusters API
// +kubebuilder:validation:XValidation:rule="has(self.spec)",message="must confgure spec"
// +kubebuilder:validation:XValidation:rule="has(self.spec)",message="must configure spec"
type GitopsCluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down
62 changes: 47 additions & 15 deletions controllers/gitopscluster_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,17 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/discovery"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"

gitopsv1alpha1 "github.com/weaveworks/cluster-controller/api/v1alpha1"
)
Expand Down Expand Up @@ -119,7 +122,7 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques

conditions.MarkFalse(cluster, meta.ReadyCondition, gitopsv1alpha1.CAPINotEnabled, e.Error())

if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
Expand Down Expand Up @@ -168,16 +171,16 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
if apierrors.IsNotFound(err) {
// TODO: this could _possibly_ be controllable by the
// `GitopsCluster` itself.
log.Info("waiting for cluster secret to be available")
log.Info("Waiting for cluster secret to be available")
conditions.MarkFalse(cluster, meta.ReadyCondition, gitopsv1alpha1.WaitingForSecretReason, e.Error())
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
return ctrl.Result{RequeueAfter: MissingSecretRequeueTime}, nil
}
conditions.MarkFalse(cluster, meta.ReadyCondition, gitopsv1alpha1.WaitingForSecretReason, e.Error())
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
Expand All @@ -188,7 +191,7 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
log.Info("Secret found", "secret", name)

conditions.MarkTrue(cluster, meta.ReadyCondition, gitopsv1alpha1.SecretFoundReason, "Referenced secret is available")
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
Expand All @@ -203,7 +206,7 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
if err := r.Get(ctx, name, &capiCluster); err != nil {
e := fmt.Errorf("failed to get CAPI cluster %q: %w", name, err)
conditions.MarkFalse(cluster, meta.ReadyCondition, gitopsv1alpha1.WaitingForCAPIClusterReason, e.Error())
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
Expand All @@ -221,7 +224,7 @@ func (r *GitopsClusterReconciler) Reconcile(ctx context.Context, req ctrl.Reques
if clusterv1.ClusterPhase(capiCluster.Status.Phase) == clusterv1.ClusterPhaseProvisioned {
conditions.MarkTrue(cluster, gitopsv1alpha1.ClusterProvisionedCondition, gitopsv1alpha1.ClusterProvisionedReason, "CAPI Cluster has been provisioned")
}
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, req.NamespacedName, cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return ctrl.Result{}, err
}
Expand Down Expand Up @@ -250,7 +253,7 @@ func (r *GitopsClusterReconciler) reconcileDeletedReferences(ctx context.Context
conditions.MarkFalse(gc, meta.ReadyCondition,
gitopsv1alpha1.WaitingForCAPIClusterDeletionReason,
"waiting for CAPI cluster to be deleted")
if err := r.Status().Update(ctx, gc); err != nil {
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(gc), gc.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}
Expand All @@ -270,7 +273,7 @@ func (r *GitopsClusterReconciler) reconcileDeletedReferences(ctx context.Context
conditions.MarkFalse(gc, meta.ReadyCondition,
gitopsv1alpha1.WaitingForSecretDeletionReason,
"waiting for access secret to be deleted")
if err := r.Status().Update(ctx, gc); err != nil {
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(gc), gc.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}
Expand All @@ -291,7 +294,7 @@ func (r *GitopsClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
}

builder := ctrl.NewControllerManagedBy(mgr).
For(&gitopsv1alpha1.GitopsCluster{}).
For(&gitopsv1alpha1.GitopsCluster{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
Watches(
&corev1.Secret{},
handler.EnqueueRequestsFromMapFunc(r.requestsForSecretChange),
Expand Down Expand Up @@ -380,7 +383,7 @@ func (r *GitopsClusterReconciler) verifyConnectivity(ctx context.Context, cluste
return nil
}

log.Info("checking connectivity", "cluster", cluster.Name)
log.Info("Checking connectivity", "cluster", cluster.Name)

nsName := types.NamespacedName{Namespace: cluster.Namespace, Name: cluster.Name}

Expand All @@ -394,27 +397,44 @@ func (r *GitopsClusterReconciler) verifyConnectivity(ctx context.Context, cluste

config, err := r.restConfigFromSecret(ctx, cluster)
if err != nil {
log.Error(err, "failed to parse the config from the secret")
conditions.MarkFalse(cluster, gitopsv1alpha1.ClusterConnectivity, gitopsv1alpha1.ClusterConnectionFailedReason, fmt.Sprintf("failed creating rest config from secret: %s", err))
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(cluster), cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}

return nil
}

if _, err := client.New(config, client.Options{}); err != nil {
k8sClient, err := discovery.NewDiscoveryClientForConfig(config)
if err != nil {
log.Error(err, "failed to create a discovery client with the config")
conditions.MarkFalse(cluster, gitopsv1alpha1.ClusterConnectivity, gitopsv1alpha1.ClusterConnectionFailedReason, fmt.Sprintf("failed connecting to the cluster: %s", err))
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(cluster), cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}

return nil
}

version, err := k8sClient.ServerVersion()
if err != nil {
log.Error(err, "failed to get the server version")
conditions.MarkFalse(cluster, gitopsv1alpha1.ClusterConnectivity, gitopsv1alpha1.ClusterConnectionFailedReason, fmt.Sprintf("failed to get server version: %s", err))
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(cluster), cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}

return nil
}

log.Info("Server version", "version", version.String())

conditions.MarkTrue(cluster, gitopsv1alpha1.ClusterConnectivity, gitopsv1alpha1.ClusterConnectionSucceededReason, "cluster connectivity is ok")
if err := r.Status().Update(ctx, cluster); err != nil {
if err := r.patchStatus(ctx, client.ObjectKeyFromObject(cluster), cluster.Status); err != nil {
log.Error(err, "failed to update Cluster status")
return err
}
Expand Down Expand Up @@ -474,3 +494,15 @@ func (r *GitopsClusterReconciler) restConfigFromSecret(ctx context.Context, clus

return restCfg, nil
}

func (r *GitopsClusterReconciler) patchStatus(ctx context.Context, key client.ObjectKey, newStatus gitopsv1alpha1.GitopsClusterStatus) error {
var cluster gitopsv1alpha1.GitopsCluster
if err := r.Get(ctx, key, &cluster); err != nil {
return err
}

patch := client.MergeFrom(cluster.DeepCopy())
cluster.Status = newStatus

return r.Status().Patch(ctx, &cluster, patch)
}

0 comments on commit d3ef4b0

Please sign in to comment.