CR-8893 get ingress class from user (#218)

* wip- added ensureIngressClass, getIngressClassFromUserSelect

* added --ingress-class to installation and create git source

* wip

* small change

* added ingressClass to the finalParameters

* filter classes by name label

* add check to ingress class provided by flag

* bypass-ingress-class-check hidden flag (#222)

* added bypass-ingress-class-check hidden flag

* bump

* lint fix

* implement bypass-ingress-class-checks flag

* removes duplicate flag

* removed duplicate flag

* added docs link

* bump

* added link to upgrade error

* docs

* improve after review

* print for debug

* improve strings

* bump

* added err report

* indent

* bump

Author: rotem-codefresh

Makefile

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

cmd/commands/common.go

@@ -113,21 +113,32 @@ func askUserIfToInstallDemoResources(cmd *cobra.Command, sampleInstall *bool) er
 
 func ensureRepo(cmd *cobra.Command, runtimeName string, cloneOpts *git.CloneOptions, fromAPI bool) error {
 	ctx := cmd.Context()
-	if cloneOpts.Repo == "" {
-		if fromAPI {
-			runtimeData, err := cfConfig.NewClient().V2().Runtime().Get(ctx, runtimeName)
-			if err != nil {
-				return fmt.Errorf("failed getting runtime repo information: %w", err)
-			}
-			if runtimeData.Repo != nil {
-				die(cmd.Flags().Set("repo", *runtimeData.Repo))
-				return nil
-			}
+	if cloneOpts.Repo != "" {
+		return nil
+	}
+
+	if fromAPI {
+		runtimeData, err := cfConfig.NewClient().V2().Runtime().Get(ctx, runtimeName)
+		if err != nil {
+			return fmt.Errorf("failed getting runtime repo information: %w", err)
 		}
-		if !store.Get().Silent {
-			return getRepoFromUserInput(cmd)
+		if runtimeData.Repo != nil {
+			die(cmd.Flags().Set("repo", *runtimeData.Repo))
+			return nil
+		}
+	}
+
+	if !store.Get().Silent {
+		err := getRepoFromUserInput(cmd)
+		if err != nil {
+			return err
 		}
 	}
+
+	if cloneOpts.Repo == "" {
+		return fmt.Errorf("must enter a valid installation repository URL")
+	}
+
 	return nil
 }
 
@@ -211,6 +222,29 @@ func getRuntimeNameFromUserSelect(ctx context.Context, runtimeName *string) erro
 	return nil
 }
 
+func getIngressClassFromUserSelect(ctx context.Context, ingressClassNames []string, ingressClass *string) error {
+	templates := &promptui.SelectTemplates{
+		Selected: "{{ . | yellow }} ",
+	}
+
+	labelStr := fmt.Sprintf("%vSelect ingressClass%v", CYAN, COLOR_RESET)
+
+	prompt := promptui.Select{
+		Label:     labelStr,
+		Items:     ingressClassNames,
+		Templates: templates,
+	}
+
+	_, result, err := prompt.Run()
+	if err != nil {
+		return fmt.Errorf("Prompt error: %w", err)
+	}
+
+	*ingressClass = result
+
+	return nil
+}
+
 func ensureGitToken(cmd *cobra.Command, cloneOpts *git.CloneOptions) error {
 	if cloneOpts.Auth.Password == "" && !store.Get().Silent {
 		return getGitTokenFromUserInput(cmd)

cmd/commands/git-source.go

@@ -59,6 +59,7 @@ type (
 		Exclude             string
 		Include             string
 		IngressHost         string
+		IngressClass        string
 	}
 
 	GitSourceDeleteOptions struct {
@@ -82,10 +83,11 @@ type (
 	}
 
 	gitSourceGithubExampleOptions struct {
-		runtimeName string
-		gsCloneOpts *git.CloneOptions
-		gsFs        fs.FS
-		ingressHost string
+		runtimeName  string
+		gsCloneOpts  *git.CloneOptions
+		gsFs         fs.FS
+		ingressHost  string
+		ingressClass string
 	}
 )
 
@@ -114,6 +116,7 @@ func NewGitSourceCreateCommand() *cobra.Command {
 		insCloneOpts *git.CloneOptions
 		gsCloneOpts  *git.CloneOptions
 		createRepo   bool
+		ingressClass string
 	)
 
 	cmd := &cobra.Command{
@@ -138,6 +141,10 @@ func NewGitSourceCreateCommand() *cobra.Command {
 				log.G(ctx).Fatal("must enter a valid value to --git-src-repo. Example: https://github.com/owner/repo-name/path/to/workflow")
 			}
 
+			if ingressClass == "" && !store.Get().BypassIngressClassCheck {
+				log.G(ctx).Fatal("must enter a valid ingressClass name to --ingress-class")
+			}
+
 			err := ensureRepo(cmd, args[0], insCloneOpts, true)
 			if err != nil {
 				return err
@@ -174,11 +181,13 @@ func NewGitSourceCreateCommand() *cobra.Command {
 				GsName:              args[1],
 				RuntimeName:         args[0],
 				CreateDemoResources: false,
+				IngressClass: ingressClass,
 			})
 		},
 	}
 
 	cmd.Flags().BoolVar(&createRepo, "create-repo", false, "If true, will create the specified git-source repo in case it doesn't already exist")
+	cmd.Flags().StringVar(&ingressClass, "ingress-class", "", "The ingress class name")
 	cmd.Flags().BoolVar(&store.Get().BypassIngressClassCheck, "bypass-ingress-class-check", false, "Disables the ingress class check during git-source installation")
 	util.Die(cmd.Flags().MarkHidden("bypass-ingress-class-check"))
 
@@ -236,10 +245,11 @@ func createDemoResources(ctx context.Context, opts *GitSourceCreateOptions, gsRe
 		}
 
 		err = createGithubExamplePipeline(&gitSourceGithubExampleOptions{
-			runtimeName: opts.RuntimeName,
-			gsCloneOpts: opts.GsCloneOpts,
-			gsFs:        gsFs,
-			ingressHost: opts.IngressHost,
+			runtimeName:  opts.RuntimeName,
+			gsCloneOpts:  opts.GsCloneOpts,
+			gsFs:         gsFs,
+			ingressHost:  opts.IngressHost,
+			ingressClass: opts.IngressClass,
 		})
 		if err != nil {
 			return fmt.Errorf("failed to create github example pipeline. Error: %w", err)
@@ -650,7 +660,7 @@ func createDemoWorkflowTemplate(gsFs fs.FS, runtimeName string) error {
 
 func createGithubExamplePipeline(opts *gitSourceGithubExampleOptions) error {
 	// Create an ingress that will manage external access to the github eventsource service
-	ingress := createGithubExampleIngress()
+	ingress := createGithubExampleIngress(opts.ingressClass)
 	ingressFilePath := opts.gsFs.Join(opts.gsCloneOpts.Path(), store.Get().GithubExampleIngressFileName)
 	err := opts.gsCloneOpts.FS.WriteYamls(ingressFilePath, ingress)
 	if err != nil {
@@ -677,9 +687,10 @@ func createGithubExamplePipeline(opts *gitSourceGithubExampleOptions) error {
 	return nil
 }
 
-func createGithubExampleIngress() *netv1.Ingress {
+func createGithubExampleIngress(ingressClass string) *netv1.Ingress {
 	return ingressutil.CreateIngress(&ingressutil.CreateIngressOptions{
-		Name: store.Get().CodefreshDeliveryPipelines,
+		Name:             store.Get().CodefreshDeliveryPipelines,
+		IngressClassName: ingressClass,
 		Paths: []ingressutil.IngressPath{
 			{
 				Path:        store.Get().GithubExampleEventSourceEndpointPath,

cmd/commands/runtime.go

@@ -73,6 +73,7 @@ type (
 		RuntimeToken         string
 		RuntimeStoreIV       string
 		IngressHost          string
+		IngressClass         string
 		Insecure             bool
 		InstallDemoResources bool
 		Version              *semver.Version
@@ -189,6 +190,7 @@ func NewRuntimeInstallCommand() *cobra.Command {
 				"Runtime name":              installationOpts.RuntimeName,
 				"Repository URL":            installationOpts.InsCloneOpts.Repo,
 				"Ingress host":              installationOpts.IngressHost,
+				"IngressClass":              installationOpts.IngressClass,
 				"Installing demo resources": strconv.FormatBool(installationOpts.InstallDemoResources),
 			}
 
@@ -206,6 +208,7 @@ func NewRuntimeInstallCommand() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&installationOpts.IngressHost, "ingress-host", "", "The ingress host")
+	cmd.Flags().StringVar(&installationOpts.IngressClass, "ingress-class", "", "The ingress class name")
 	cmd.Flags().StringVar(&installationOpts.versionStr, "version", "", "The runtime version to install (default: latest)")
 	cmd.Flags().BoolVar(&installationOpts.InstallDemoResources, "demo-resources", true, "Installs demo resources (default: true)")
 	cmd.Flags().DurationVar(&store.Get().WaitTimeout, "wait-timeout", store.Get().WaitTimeout, "How long to wait for the runtime components to be ready")
@@ -273,6 +276,12 @@ func runtimeInstallCommandPreRunHandler(cmd *cobra.Command, opts *RuntimeInstall
 		return fmt.Errorf("%w", err)
 	}
 
+	err = ensureIngressClass(cmd.Context(), opts)
+	handleCliStep(reporter.InstallStepPreCheckEnsureIngressClass, "Getting ingress class", err, false)
+	if err != nil {
+		return err
+	}
+
 	err = ensureRepo(cmd, opts.RuntimeName, opts.InsCloneOpts, false)
 	handleCliStep(reporter.InstallStepPreCheckEnsureRuntimeRepo, "Getting runtime repo", err, false)
 	if err != nil {
@@ -397,6 +406,54 @@ func ensureIngressHost(cmd *cobra.Command, opts *RuntimeInstallOptions) error {
 	return nil
 }
 
+func ensureIngressClass(ctx context.Context, opts *RuntimeInstallOptions) error {
+	if store.Get().BypassIngressClassCheck {
+		return nil
+	}
+	
+	fmt.Print("Retrieving ingress class info from your cluster...\n")
+
+	cs := opts.KubeFactory.KubernetesClientSetOrDie()
+	ingressClassList, err := cs.NetworkingV1().IngressClasses().List(ctx, metav1.ListOptions{})
+	if err != nil {
+		return fmt.Errorf("failed to get ingressClass list from your cluster: %w", err)
+	}
+
+	var ingressClassNames []string
+	var isValidClass bool
+	for _, ic := range ingressClassList.Items {
+		if ic.ObjectMeta.Labels["app.kubernetes.io/name"] == "ingress-nginx" {
+			ingressClassNames = append(ingressClassNames, ic.Name)
+			if opts.IngressClass == ic.Name {
+				isValidClass = true
+			}
+		}
+	}
+
+	if opts.IngressClass != "" { //if user provided ingress class by flag
+		if isValidClass { 
+			return nil
+		}
+		return fmt.Errorf("Ingress Class '%s' is not supported. Only the ingress class of type NGINX is supported. for more information: %s", opts.IngressClass, store.Get().RequirementsLink)
+	}
+
+	if len(ingressClassNames) == 0 {
+		return fmt.Errorf("No ingressClasses of type nginx were found. please install a nginx ingress controller on your cluster before installing a runtime. see instructions at: %s", store.Get().RequirementsLink)
+	}
+
+	if len(ingressClassNames) == 1 {
+		log.G(ctx).Info("Using ingress class: ", ingressClassNames[0])
+		opts.IngressClass = ingressClassNames[0]
+		return nil
+	}
+
+	if !store.Get().Silent {
+		return getIngressClassFromUserSelect(ctx, ingressClassNames, &opts.IngressClass)
+	}
+
+	return fmt.Errorf("Please add the --ingress-class flag and define its value")
+}
+
 func getComponents(rt *runtime.Runtime, opts *RuntimeInstallOptions) []string {
 	var componentNames []string
 	for _, component := range rt.Spec.Components {
@@ -547,6 +604,7 @@ func RunRuntimeInstall(ctx context.Context, opts *RuntimeInstallOptions) error {
 		RuntimeName:         opts.RuntimeName,
 		CreateDemoResources: opts.InstallDemoResources,
 		IngressHost:         opts.IngressHost,
+		IngressClass:        opts.IngressClass,
 	})
 	handleCliStep(reporter.InstallStepCreateGitsource, gitSrcMessage, err, true)
 	if err != nil {
@@ -611,7 +669,7 @@ func addDefaultGitIntegration(ctx context.Context, runtime string, opts *apmodel
 func installComponents(ctx context.Context, opts *RuntimeInstallOptions, rt *runtime.Runtime) error {
 	var err error
 	if opts.IngressHost != "" {
-		if err = createWorkflowsIngress(ctx, opts.InsCloneOpts, rt); err != nil {
+		if err = createWorkflowsIngress(ctx, opts, rt); err != nil {
 			return fmt.Errorf("failed to patch Argo-Workflows ingress: %w", err)
 		}
 	}
@@ -674,7 +732,7 @@ func preInstallationChecks(ctx context.Context, opts *RuntimeInstallOptions) err
 	}
 
 	if rt.Spec.DefVersion.GreaterThan(store.Get().MaxDefVersion) {
-		err = fmt.Errorf("your cli version is out of date. please upgrade to the latest version before installing")
+		err = fmt.Errorf("your cli version is out of date. please upgrade to the latest version before installing. for more information: %s", store.Get().DownloadCliLink)
 	}
 	handleCliStep(reporter.InstallStepRunPreCheckEnsureCliVersion, "Checking CLI version", err, false)
 	if err != nil {
@@ -1160,16 +1218,17 @@ func persistRuntime(ctx context.Context, cloneOpts *git.CloneOptions, rt *runtim
 	return apu.PushWithMessage(ctx, r, "Persisted runtime data")
 }
 
-func createWorkflowsIngress(ctx context.Context, cloneOpts *git.CloneOptions, rt *runtime.Runtime) error {
-	r, fs, err := cloneOpts.GetRepo(ctx)
+func createWorkflowsIngress(ctx context.Context, opts *RuntimeInstallOptions, rt *runtime.Runtime) error {
+	r, fs, err := opts.InsCloneOpts.GetRepo(ctx)
 	if err != nil {
 		return err
 	}
 
 	overlaysDir := fs.Join(apstore.Default.AppsDir, store.Get().WorkflowsIngressPath, apstore.Default.OverlaysDir, rt.Name)
 	ingress := ingressutil.CreateIngress(&ingressutil.CreateIngressOptions{
-		Name:      rt.Name + store.Get().WorkflowsIngressName,
-		Namespace: rt.Namespace,
+		Name:             rt.Name + store.Get().WorkflowsIngressName,
+		Namespace:        rt.Namespace,
+		IngressClassName: opts.IngressClass,
 		Annotations: map[string]string{
 			"ingress.kubernetes.io/protocol":               "https",
 			"ingress.kubernetes.io/rewrite-target":         "/$2",
@@ -1254,8 +1313,9 @@ func configureAppProxy(ctx context.Context, opts *RuntimeInstallOptions, rt *run
 
 	if opts.IngressHost != "" {
 		ingress := ingressutil.CreateIngress(&ingressutil.CreateIngressOptions{
-			Name:      rt.Name + store.Get().AppProxyIngressName,
-			Namespace: rt.Namespace,
+			Name:             rt.Name + store.Get().AppProxyIngressName,
+			Namespace:        rt.Namespace,
+			IngressClassName: opts.IngressClass,
 			Paths: []ingressutil.IngressPath{
 				{
 					Path:        fmt.Sprintf("/%s", store.Get().AppProxyIngressPath),

docs/commands/cli-v2_git-source_create.md

@@ -24,6 +24,7 @@ cli-v2 git-source create runtime_name git-source_name [flags]
   -t, --git-token string           Your git provider api token [GIT_TOKEN]
   -u, --git-user string            Your git provider user name [GIT_USER] (not required in GitHub)
   -h, --help                       help for create
+      --ingress-class string       The ingress class name
       --repo string                Repository URL [GIT_REPO]
 ```
 

docs/commands/cli-v2_runtime_install.md

@@ -37,6 +37,7 @@ cli-v2 runtime install [runtime_name] [flags]
   -t, --git-token string           Your git provider api token [GIT_TOKEN]
   -u, --git-user string            Your git provider user name [GIT_USER] (not required in GitHub)
   -h, --help                       help for install
+      --ingress-class string       The ingress class name
       --ingress-host string        The ingress host
       --kubeconfig string          Path to the kubeconfig file to use for CLI requests.
   -n, --namespace string           If present, the namespace scope for this CLI request

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.208/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.209/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.208/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.209/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: 1.0.0
-    version: 0.0.208
+    version: 0.0.209
     bootstrapSpecifier: github.com/codefresh-io/cli-v2/manifests/argo-cd
     components:
         - name: events

pkg/reporter/reporter.go

@@ -63,6 +63,7 @@ const (
 	InstallStepPreCheckGetRuntimeName                 CliStep = "install.pre-check.step.get-runtime-name"
 	InstallStepPreCheckRuntimeNameValidation          CliStep = "install.pre-check.step.runtime-name-validation"
 	InstallStepPreCheckGetKubeContext                 CliStep = "install.pre-check.step.get-kube-context"
+	InstallStepPreCheckEnsureIngressClass             CliStep = "install.pre-check.step.ensure-ingress-class"
 	InstallStepPreCheckEnsureRuntimeRepo              CliStep = "install.pre-check.step.ensure-runtime-repo"
 	InstallStepPreCheckEnsureGitToken                 CliStep = "install.pre-check.step.ensure-git-token"
 	InstallStepPreCheckEnsureIngressHost              CliStep = "install.pre-check.step.ensure-ingress-host"

pkg/store/store.go

@@ -124,6 +124,8 @@ type Store struct {
 	ReplicaSetReporterServiceAccount     string
 	ReplicaSetResourceName               string
 	WorkflowResourceName                 string
+	RequirementsLink                     string
+	DownloadCliLink                      string
 	RolloutReporterName                  string
 	RolloutResourceName                  string
 	RolloutReporterServiceAccount        string
@@ -213,6 +215,8 @@ func init() {
 	s.RolloutResourceName = "rollouts"
 	s.RolloutReporterServiceAccount = "rollout-reporter-sa"
 	s.SegmentWriteKey = segmentWriteKey
+	s.RequirementsLink = "https://codefresh.io/csdp-docs/docs/runtime/requirements/"
+	s.DownloadCliLink = "https://codefresh.io/csdp-docs/docs/clients/csdp-cli/"
 	initVersion()
 }