CR-14744 - fix skip-ingress flag (#585)

* check SkipIngress flag when needed

Author: ATGardner

CODEOWNERS

@@ -1 +1 @@
-* roi.kramer@codefresh.io noam.gal@codefresh.io oren.gurfinkel@codefresh.io pavel@codefresh.io ziv@codefresh.io
+* roi.kramer@codefresh.io noam.gal@codefresh.io oren.gurfinkel@codefresh.io pavel@codefresh.io ziv@codefresh.io itai@codefresh.io

Makefile

@@ -1,4 +1,4 @@
-VERSION=v0.0.531
+VERSION=v0.0.532
 
 OUT_DIR=dist
 YEAR?=$(shell date +"%Y")

cmd/commands/git-source.go

@@ -65,6 +65,7 @@ type (
 		Exclude             string
 		Include             string
 		HostName            string
+		SkipIngress         bool
 		IngressHost         string
 		IngressClass        string
 		IngressController   routingutil.RoutingController
@@ -104,6 +105,7 @@ type (
 		gsFs              fs.FS
 		hostName          string
 		ingressHost       string
+		skipIngress       bool
 		ingressClass      string
 		ingressController routingutil.RoutingController
 		accessMode        platmodel.AccessMode
@@ -611,6 +613,7 @@ func createDemoResources(ctx context.Context, opts *GitSourceCreateOptions, gsRe
 				gitProvider:       opts.GitProvider,
 				gsFs:              gsFs,
 				hostName:          opts.HostName,
+				skipIngress:       opts.SkipIngress,
 				ingressHost:       opts.IngressHost,
 				ingressClass:      opts.IngressClass,
 				ingressController: opts.IngressController,
@@ -752,7 +755,7 @@ func createDemoCalendarTrigger() sensorsv1alpha1.Trigger {
 }
 
 func createDemoGitPipeline(opts *gitSourceGitDemoPipelineOptions) error {
-	if opts.accessMode == platmodel.AccessModeIngress {
+	if !opts.skipIngress && opts.accessMode == platmodel.AccessModeIngress {
 		// Create an ingress that will manage external access to the git eventsource service
 		routeOpts := routingutil.CreateRouteOpts{
 			RuntimeName:       opts.runtimeName,

cmd/commands/runtime_install.go

@@ -110,6 +110,7 @@ type (
 		TunnelDomain                   string
 		TunnelSubdomain                string
 		SkipIngress                    bool
+		BypassIngressClassCheck        bool
 
 		versionStr        string
 		kubeContext       string
@@ -243,7 +244,7 @@ func NewRuntimeInstallCommand() *cobra.Command {
 	cmd.Flags().DurationVar(&store.Get().WaitTimeout, "wait-timeout", store.Get().WaitTimeout, "How long to wait for the runtime components to be ready")
 	cmd.Flags().StringVar(&gitIntegrationApiURL, "provider-api-url", "", "Git provider API url")
 	cmd.Flags().BoolVar(&installationOpts.SkipIngress, "skip-ingress", false, "Skips the creation of ingress resources")
-	cmd.Flags().BoolVar(&store.Get().BypassIngressClassCheck, "bypass-ingress-class-check", false, "Disables the ingress class check during pre-installation")
+	cmd.Flags().BoolVar(&installationOpts.BypassIngressClassCheck, "bypass-ingress-class-check", false, "Disables the ingress class check during pre-installation")
 	cmd.Flags().BoolVar(&installationOpts.DisableTelemetry, "disable-telemetry", false, "If true, will disable the analytics reporting for the installation process")
 	cmd.Flags().BoolVar(&store.Get().SetDefaultResources, "set-default-resources", false, "If true, will set default requests and limits on all of the runtime components")
 	cmd.Flags().BoolVar(&installationOpts.FromRepo, "from-repo", false, "Installs a runtime from an existing repo. Used for recovery after cluster failure")
@@ -514,17 +515,16 @@ func validateIngressHostCertificate(ctx context.Context, ingressHost string) err
 }
 
 func ensureRoutingControllerSupported(ctx context.Context, opts *RuntimeInstallOptions) error {
-	var controller routingutil.RoutingController
 	var err error
 
 	if opts.useGatewayAPI {
-		controller, err = routingutil.ValidateGatewayController(ctx, opts.KubeFactory, opts.GatewayName, opts.GatewayNamespace)
-	} else {
-		controller, err = routingutil.ValidateIngressController(ctx, opts.KubeFactory, &opts.IngressClass)
+		opts.IngressController, err = routingutil.ValidateGatewayController(ctx, opts.KubeFactory, opts.GatewayName, opts.GatewayNamespace)
+	} else if opts.BypassIngressClassCheck {
+		opts.IngressController = routingutil.GetIngressController("")
+	} else if !opts.SkipIngress {
+		opts.IngressController, opts.IngressClass, err = routingutil.ValidateIngressController(ctx, opts.KubeFactory, opts.IngressClass)
 	}
 
-	opts.IngressController = controller
-
 	return err
 }
 
@@ -570,7 +570,7 @@ func createRuntimeOnPlatform(ctx context.Context, opts *RuntimeInstallOptions, r
 		AccessMode:       &opts.AccessMode,
 	}
 
-	if opts.AccessMode == platmodel.AccessModeIngress {
+	if opts.shouldInstallIngress() {
 		runtimeArgs.InternalIngressHost = &opts.InternalIngressHost
 		runtimeArgs.IngressClass = &opts.IngressClass
 		ingressControllerName := opts.IngressController.Name()
@@ -629,7 +629,7 @@ func runRuntimeInstall(ctx context.Context, opts *RuntimeInstallOptions) error {
 	rt.Spec.IngressHost = opts.IngressHost
 	rt.Spec.InternalIngressHost = opts.InternalIngressHost
 	rt.Spec.Repo = opts.InsCloneOpts.Repo
-	if opts.AccessMode == platmodel.AccessModeIngress {
+	if opts.shouldInstallIngress() {
 		rt.Spec.IngressClass = opts.IngressClass
 		rt.Spec.IngressController = string(opts.IngressController.Name())
 	}
@@ -805,7 +805,7 @@ func createRuntimeComponents(ctx context.Context, opts *RuntimeInstallOptions, r
 		return err
 	}
 
-	if opts.AccessMode == platmodel.AccessModeIngress && opts.IngressController.Name() == string(routingutil.IngressControllerNginxEnterprise) && !opts.FromRepo {
+	if opts.shouldInstallIngress() && opts.IngressController.Name() == string(routingutil.IngressControllerNginxEnterprise) && !opts.FromRepo {
 		err := createMasterIngressResource(ctx, opts)
 		if err != nil {
 			return fmt.Errorf("failed to create master ingress resource: %w", err)
@@ -869,6 +869,7 @@ func createGitSources(ctx context.Context, opts *RuntimeInstallOptions) error {
 		RuntimeName:         opts.RuntimeName,
 		CreateDemoResources: opts.InstallDemoResources,
 		HostName:            opts.HostName,
+		SkipIngress:         opts.SkipIngress,
 		IngressHost:         opts.IngressHost,
 		IngressClass:        opts.IngressClass,
 		IngressController:   opts.IngressController,
@@ -1031,8 +1032,8 @@ func installComponents(ctx context.Context, opts *RuntimeInstallOptions, rt *run
 	var err error
 
 	// bitbucket cloud take more time to push a commit
-	// all coming retries perpuse is to avoid issues of cloning before pervious commit was pushed
-	if opts.AccessMode == platmodel.AccessModeIngress && rt.Spec.IngressController != string(routingutil.IngressControllerALB) {
+	// the perpuse of all retries is to avoid issues of cloning before pervious commit was pushed
+	if opts.shouldInstallIngress() && rt.Spec.IngressController != string(routingutil.IngressControllerALB) {
 		if err = util.Retry(ctx, &util.RetryOptions{
 			Func: func() error {
 				return createWorkflowsIngress(ctx, opts, rt)
@@ -1459,7 +1460,7 @@ func configureAppProxy(ctx context.Context, opts *RuntimeInstallOptions, rt *run
 		hostName = opts.InternalHostName
 	}
 
-	if opts.AccessMode == platmodel.AccessModeIngress {
+	if opts.shouldInstallIngress() {
 		routeOpts := routingutil.CreateRouteOpts{
 			RuntimeName:       rt.Name,
 			Namespace:         rt.Namespace,
@@ -2045,3 +2046,7 @@ func (opts *RuntimeInstallOptions) GetValues(name string) (string, error) {
 		return "", nil
 	}
 }
+
+func (opts *RuntimeInstallOptions) shouldInstallIngress() bool {
+	return !opts.SkipIngress && opts.AccessMode == platmodel.AccessModeIngress
+}

docs/releases/release_notes.md

@@ -23,7 +23,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.531/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.532/cf-linux-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-linux-amd64 /usr/local/bin/cf
@@ -36,7 +36,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.531/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.532/cf-darwin-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-darwin-amd64 /usr/local/bin/cf

manifests/runtime.yaml

@@ -5,7 +5,7 @@ metadata:
   namespace: "{{ namespace }}"
 spec:
   defVersion: 2.0.0
-  version: 0.0.531
+  version: 0.0.532
   bootstrapSpecifier: github.com/codefresh-io/cli-v2/manifests/argo-cd
   components:
     - name: events

pkg/store/store.go

@@ -116,7 +116,6 @@ type Store struct {
 	ArgoCD                            string
 	Silent                            bool
 	InsecureIngressHost               bool
-	BypassIngressClassCheck           bool
 	SetDefaultResources               bool
 	MinimumMemorySizeRequired         string
 	MinimumCpuRequired                string

pkg/util/routing/ingress.go

@@ -181,66 +181,69 @@ func CreateIngress(opts *CreateRouteOpts) *netv1.Ingress {
 	return ingress
 }
 
-func ValidateIngressController(ctx context.Context, kubeFactory kube.Factory, ingressClass *string) (RoutingController, error) {
-	var ingressController RoutingController
-	if store.Get().BypassIngressClassCheck {
-		ingressController = GetIngressController("")
-		return ingressController, nil
-	}
+func ValidateIngressController(ctx context.Context, kubeFactory kube.Factory, requestedIngressClass string) (RoutingController, string, error) {
+	var (
+		ingressController RoutingController
+		ingressClass      string
+		ingressClassNames []string
+	)
 
 	log.G(ctx).Info("Retrieving ingress class info from your cluster...\n")
 
 	cs := kubeFactory.KubernetesClientSetOrDie()
 	ingressClassList, err := cs.NetworkingV1().IngressClasses().List(ctx, metav1.ListOptions{})
 	if err != nil {
-		return nil, fmt.Errorf("failed to get ingress class list from your cluster: %w", err)
+		return nil, "", fmt.Errorf("failed to get ingress class list from your cluster: %w", err)
 	}
 
-	var ingressClassNames []string
 	ingressClassNameToController := make(map[string]RoutingController)
-	var isValidClass bool
 
 	for _, ic := range ingressClassList.Items {
 		for _, controller := range SupportedIngressControllers {
 			if ic.Spec.Controller == string(controller) {
 				ingressClassNames = append(ingressClassNames, ic.Name)
 				ingressClassNameToController[ic.Name] = GetIngressController(string(controller))
 
-				if *ingressClass == ic.Name { // if ingress class provided via flag
-					isValidClass = true
+				if requestedIngressClass == ic.Name {
+					// if ingress class provided via flag
+					ingressClass = requestedIngressClass
 				}
 				break
 			}
 		}
 	}
 
-	if *ingressClass != "" { // if ingress class provided via flag
-		if !isValidClass {
-			return nil, fmt.Errorf("ingress class '%s' is not supported", *ingressClass)
+	if requestedIngressClass != "" {
+		if ingressClass == "" {
+			// if ingress class provided via flag was not found in cluster
+			return nil, "", fmt.Errorf("ingress class '%s' is not supported", requestedIngressClass)
 		}
 	} else if len(ingressClassNames) == 0 {
-		return nil, fmt.Errorf("no ingress classes of the supported types were found")
+		// if no ingress classes in cluster at all
+		return nil, "", fmt.Errorf("no ingress classes of the supported types were found")
 	} else if len(ingressClassNames) == 1 {
+		// if there is only 1 ingress class in the cluster - just use it
 		log.G(ctx).Info("Using ingress class: ", ingressClassNames[0])
-		*ingressClass = ingressClassNames[0]
+		ingressClass = ingressClassNames[0]
 	} else if len(ingressClassNames) > 1 {
-		if !store.Get().Silent {
-			*ingressClass, err = getIngressClassFromUserSelect(ingressClassNames)
-			if err != nil {
-				return nil, err
-			}
-		} else {
-			return nil, fmt.Errorf("there are multiple ingress controllers on your cluster, please add the --ingress-class flag and define its value")
+		// if there are multiple ingress classes in the cluster
+		if store.Get().Silent {
+			return nil, "", fmt.Errorf("there are multiple ingress controllers on your cluster, please add the --ingress-class flag and define its value")
+		}
+
+		ingressClass, err = getIngressClassFromUserSelect(ingressClassNames)
+		if err != nil {
+			return nil, "", err
 		}
 	}
 
-	ingressController = ingressClassNameToController[*ingressClass]
+	ingressController = ingressClassNameToController[ingressClass]
 
 	if ingressController.Name() == string(IngressControllerNginxEnterprise) {
 		log.G(ctx).Warn("You are using the NGINX enterprise edition (nginx.org/ingress-controller) as your ingress controller. To successfully install the runtime, configure all required settings, as described in : ", store.Get().RequirementsLink)
 	}
 
-	return ingressController, nil
+	return ingressController, ingressClass, nil
 }
 
 func getIngressClassFromUserSelect(ingressClassNames []string) (string, error) {