Add wait-kubeconfig-timeout flag to clusterctl

Signed-off-by: Vince Prignano <[email protected]>

Author: vincepri

cmd/clusterctl/clusterdeployer/clusterdeployer.go

@@ -19,6 +19,7 @@ package clusterdeployer
 import (
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/pkg/errors"
 	"k8s.io/klog"
@@ -36,6 +37,7 @@ type ClusterDeployer struct {
 	addonComponents         string
 	bootstrapComponents     string
 	cleanupBootstrapCluster bool
+	waitKubeConfigTimeout   time.Duration
 }
 
 func New(
@@ -44,14 +46,16 @@ func New(
 	providerComponents string,
 	addonComponents string,
 	bootstrapComponents string,
-	cleanupBootstrapCluster bool) *ClusterDeployer {
+	cleanupBootstrapCluster bool,
+	waitKubeConfigTimeout time.Duration) *ClusterDeployer {
 	return &ClusterDeployer{
 		bootstrapProvisioner:    bootstrapProvisioner,
 		clientFactory:           clientFactory,
 		providerComponents:      providerComponents,
 		addonComponents:         addonComponents,
 		bootstrapComponents:     bootstrapComponents,
 		cleanupBootstrapCluster: cleanupBootstrapCluster,
+		waitKubeConfigTimeout:   waitKubeConfigTimeout,
 	}
 }
 
@@ -100,7 +104,8 @@ func (d *ClusterDeployer) Create(cluster *clusterv1.Cluster, machines []*cluster
 	}
 
 	klog.Info("Creating target cluster")
-	targetKubeconfig, err := phases.GetKubeconfig(bootstrapClient, provider, kubeconfigOutput, cluster.Name, cluster.Namespace)
+	targetKubeconfig, err := phases.GetKubeconfig(bootstrapClient, provider, kubeconfigOutput,
+		cluster.Name, cluster.Namespace, d.waitKubeConfigTimeout)
 	if err != nil {
 		return fmt.Errorf("unable to create target cluster kubeconfig: %v", err)
 	}

cmd/clusterctl/clusterdeployer/clusterdeployer_test.go

@@ -21,6 +21,7 @@ import (
 	"io/ioutil"
 	"os"
 	"testing"
+	"time"
 
 	"github.com/pkg/errors"
 	apiv1 "k8s.io/api/core/v1"
@@ -846,7 +847,7 @@ func TestClusterCreate(t *testing.T) {
 
 			pcStore := mockProviderComponentsStore{}
 			pcFactory := mockProviderComponentsStoreFactory{NewFromCoreclientsetPCStore: &pcStore}
-			d := New(p, f, "", "", bootstrapComponent, testcase.cleanupExternal)
+			d := New(p, f, "", "", bootstrapComponent, testcase.cleanupExternal, 1*time.Minute)
 
 			inputMachines := make(map[string][]*clusterv1.Machine)
 
@@ -961,7 +962,7 @@ func TestCreateProviderComponentsScenarios(t *testing.T) {
 			pcFactory := mockProviderComponentsStoreFactory{NewFromCoreclientsetPCStore: &tc.pcStore}
 			providerComponentsYaml := "---\nyaml: definition"
 			addonsYaml := "---\nyaml: definition"
-			d := New(p, f, providerComponentsYaml, addonsYaml, "", false)
+			d := New(p, f, providerComponentsYaml, addonsYaml, "", false, 1*time.Minute)
 			err := d.Create(inputCluster, inputMachines, pd, kubeconfigOut, &pcFactory)
 			if err == nil && tc.expectedError != "" {
 				t.Fatalf("error mismatch: got '%v', want '%v'", err, tc.expectedError)
@@ -1102,7 +1103,7 @@ func TestDeleteCleanupExternalCluster(t *testing.T) {
 			f := newTestClusterClientFactory()
 			f.clusterClients[bootstrapKubeconfig] = tc.bootstrapClient
 			f.clusterClients[targetKubeconfig] = tc.targetClient
-			d := New(p, f, "", "", "", tc.cleanupExternalCluster)
+			d := New(p, f, "", "", "", tc.cleanupExternalCluster, 1*time.Minute)
 			err := d.Delete(tc.targetClient)
 			if err != nil || tc.expectedErrorMessage != "" {
 				if err == nil {
@@ -1348,7 +1349,7 @@ func TestClusterDelete(t *testing.T) {
 			f := newTestClusterClientFactory()
 			f.clusterClients[bootstrapKubeconfig] = testCase.bootstrapClient
 			f.ClusterClientErr = testCase.NewCoreClientsetErr
-			d := New(p, f, "", "", "", true)
+			d := New(p, f, "", "", "", true, 1*time.Minute)
 
 			err := d.Delete(testCase.targetClient)
 			if err != nil || testCase.expectedErrorMessage != "" {

cmd/clusterctl/cmd/alpha_phase_get_kubeconfig.go

@@ -19,6 +19,7 @@ package cmd
 import (
 	"fmt"
 	"io/ioutil"
+	"time"
 
 	"github.com/spf13/cobra"
 	"k8s.io/klog"
@@ -27,11 +28,12 @@ import (
 )
 
 type AlphaPhaseGetKubeconfigOptions struct {
-	ClusterName      string
-	Kubeconfig       string
-	KubeconfigOutput string
-	Namespace        string
-	Provider         string
+	ClusterName           string
+	Kubeconfig            string
+	KubeconfigOutput      string
+	Namespace             string
+	Provider              string
+	WaitKubeConfigTimeout time.Duration
 }
 
 var pgko = &AlphaPhaseGetKubeconfigOptions{}
@@ -76,7 +78,7 @@ func RunAlphaPhaseGetKubeconfig(pgko *AlphaPhaseGetKubeconfigOptions) error {
 		return err
 	}
 
-	if _, err := phases.GetKubeconfig(client, provider, pgko.KubeconfigOutput, pgko.ClusterName, pgko.Namespace); err != nil {
+	if _, err := phases.GetKubeconfig(client, provider, pgko.KubeconfigOutput, pgko.ClusterName, pgko.Namespace, pgko.WaitKubeConfigTimeout); err != nil {
 		return fmt.Errorf("unable to get kubeconfig: %v", err)
 	}
 
@@ -93,5 +95,6 @@ func init() {
 	// Optional flags
 	alphaPhaseGetKubeconfigCmd.Flags().StringVarP(&pgko.KubeconfigOutput, "kubeconfig-out", "", "kubeconfig", "Where to output the kubeconfig for the provisioned cluster")
 	alphaPhaseGetKubeconfigCmd.Flags().StringVarP(&pgko.Namespace, "namespace", "n", "", "Namespace")
+	alphaPhaseGetKubeconfigCmd.Flags().DurationVarP(&pgko.WaitKubeConfigTimeout, "wait-kubeconfig-timeout", "", 20*time.Minute, "The total time to wait for KubeConfig to be available before exiting with an error")
 	alphaPhasesCmd.AddCommand(alphaPhaseGetKubeconfigCmd)
 }

cmd/clusterctl/cmd/create_cluster.go

@@ -18,6 +18,7 @@ package cmd
 
 import (
 	"io/ioutil"
+	"time"
 
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
@@ -39,6 +40,7 @@ type CreateOptions struct {
 	Provider                string
 	KubeconfigOutput        string
 	BootstrapFlags          bootstrap.Options
+	WaitKubeConfigTimeout   time.Duration
 }
 
 var co = &CreateOptions{}
@@ -107,7 +109,9 @@ func RunCreate(co *CreateOptions) error {
 		string(pc),
 		string(ac),
 		string(bc),
-		co.BootstrapFlags.Cleanup)
+		co.BootstrapFlags.Cleanup,
+		co.WaitKubeConfigTimeout,
+	)
 
 	return d.Create(c, m, pd, co.KubeconfigOutput, pcsFactory)
 }
@@ -128,6 +132,7 @@ func init() {
 	createClusterCmd.Flags().StringVarP(&co.AddonComponents, "addon-components", "a", "", "A yaml file containing cluster addons to apply to the internal cluster")
 	createClusterCmd.Flags().StringVarP(&co.BootstrapOnlyComponents, "bootstrap-only-components", "", "", "A yaml file containing components to apply only on the bootstrap cluster (before the provider components are applied) but not the provisioned cluster")
 	createClusterCmd.Flags().StringVarP(&co.KubeconfigOutput, "kubeconfig-out", "", "kubeconfig", "Where to output the kubeconfig for the provisioned cluster")
+	createClusterCmd.Flags().DurationVarP(&co.WaitKubeConfigTimeout, "wait-kubeconfig-timeout", "", 20*time.Minute, "The total time to wait for KubeConfig to be available before exiting with an error")
 
 	co.BootstrapFlags.AddFlags(createClusterCmd.Flags())
 	createCmd.AddCommand(createClusterCmd)

cmd/clusterctl/cmd/delete_cluster.go

@@ -17,6 +17,8 @@ limitations under the License.
 package cmd
 
 import (
+	"time"
+
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	v1 "k8s.io/api/core/v1"
@@ -89,7 +91,8 @@ func RunDelete() error {
 		providerComponents,
 		"",
 		"",
-		do.BootstrapFlags.Cleanup)
+		do.BootstrapFlags.Cleanup,
+		1*time.Minute)
 
 	return deployer.Delete(clusterClient)
 }

cmd/clusterctl/phases/getkubeconfig.go

@@ -29,14 +29,13 @@ import (
 )
 
 const (
-	retryKubeConfigReady   = 10 * time.Second
-	timeoutKubeconfigReady = 20 * time.Minute
+	retryKubeConfigReady = 10 * time.Second
 )
 
 // GetKubeconfig returns a kubeconfig for the target cluster
-func GetKubeconfig(bootstrapClient clusterclient.Client, provider provider.Deployer, kubeconfigOutput string, clusterName, namespace string) (string, error) {
+func GetKubeconfig(bootstrapClient clusterclient.Client, provider provider.Deployer, kubeconfigOutput string, clusterName, namespace string, timeout time.Duration) (string, error) {
 	klog.V(1).Info("Getting target cluster kubeconfig.")
-	targetKubeconfig, err := waitForKubeconfigReady(bootstrapClient, provider, clusterName, namespace)
+	targetKubeconfig, err := waitForKubeconfigReady(bootstrapClient, provider, clusterName, namespace, timeout)
 	if err != nil {
 		return "", fmt.Errorf("unable to get target cluster kubeconfig: %v", err)
 	}
@@ -48,9 +47,9 @@ func GetKubeconfig(bootstrapClient clusterclient.Client, provider provider.Deplo
 	return targetKubeconfig, nil
 }
 
-func waitForKubeconfigReady(bootstrapClient clusterclient.Client, provider provider.Deployer, clusterName, namespace string) (string, error) {
+func waitForKubeconfigReady(bootstrapClient clusterclient.Client, provider provider.Deployer, clusterName, namespace string, timeout time.Duration) (string, error) {
 	kubeconfig := ""
-	err := util.PollImmediate(retryKubeConfigReady, timeoutKubeconfigReady, func() (bool, error) {
+	err := util.PollImmediate(retryKubeConfigReady, timeout, func() (bool, error) {
 		cluster, controlPlane, _, err := clusterclient.GetClusterAPIObject(bootstrapClient, clusterName, namespace)
 		if err != nil {
 			return false, err

cmd/clusterctl/testdata/create-cluster-no-args-invalid-flag.golden

@@ -15,6 +15,7 @@ Flags:
   -m, --machines string                       A yaml file containing machine object definition(s). Required.
       --provider string                       Which provider deployment logic to use. Required.
   -p, --provider-components string            A yaml file containing cluster api provider controllers and supporting objects. Required.
+      --wait-kubeconfig-timeout duration      The total time to wait for KubeConfig to be available before exiting with an error (default 20m0s)
 
 Global Flags:
       --alsologtostderr                  log to standard error as well as files

cmd/clusterctl/testdata/create-cluster-no-args.golden

@@ -15,6 +15,7 @@ Flags:
   -m, --machines string                       A yaml file containing machine object definition(s). Required.
       --provider string                       Which provider deployment logic to use. Required.
   -p, --provider-components string            A yaml file containing cluster api provider controllers and supporting objects. Required.
+      --wait-kubeconfig-timeout duration      The total time to wait for KubeConfig to be available before exiting with an error (default 20m0s)
 
 Global Flags:
       --alsologtostderr                  log to standard error as well as files