feat: Kubectl proxy support (#355)

kartik-579 · Shubham9t9 · Shubham9t9 · web-flow · commit 8eb1f742126b · 2023-08-09T11:38:35.000+05:30
* added proxy url * set proxy url for terminal session get request * added logs * updated proxyUrl field case * updated proxy url field in cluster save/update apis * updated proxy url validation * wip * removed redundant logs * wip * wip * updated check in cluster save update apis for gitOps * feat: workflow to validate PRs if an issue is linked or not (#3730) * added github actions workflow to validate PRs if an issue is linked or not * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml --------- Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com> Co-authored-by: Prakarsh <71125043+prakarsh-dt@users.noreply.github.com> * commented out path-ignore section in pr-issue-validator (#3739) Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com> * chore: Update pr-issue-validator.yaml (#3740) * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * Update pr-issue-validator.yaml * wip * updated informer obj * chore: migration for kubectl proxy (#3731) * added db scripts * updated sql script * updated sql script no. --------- Co-authored-by: Shubham Kumar <87755583+Shubham9t9@users.noreply.github.com> Co-authored-by: Shubham9t9 <shubhamkumar47022@gmai.com> Co-authored-by: Prakarsh <71125043+prakarsh-dt@users.noreply.github.com>
diff --git a/.github/workflows/pr-issue-validator.yaml b/.github/workflows/pr-issue-validator.yaml
@@ -0,0 +1,87 @@
+name: Validate Pull Request
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - edited
+      - reopened
+    branches:    
+      - 'main'
+      - 'release-**'
+    # paths-ignore:
+    #   - 'docs/**'
+    #   - '.github/'
+    #   - 'CHANGELOG/'
+    #   - 'charts/'
+    #   - 'manifests/'
+    #   - 'sample-docker-templates/'
+  
+jobs:
+  validate-PR-issue:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Validate Issue Reference
+      env:
+        GITHUB_TOKEN: ${{ secrets.GIT_TARGET_TOKEN }}
+        PR_BODY: ${{ github.event.pull_request.body }}
+        url: ${{ github.event.pull_request.url }}
+        PRNUM: ${{ github.event.pull_request.number }}
+        TITLE: ${{ github.event.pull_request.title }}
+      run: |
+        set -x
+        if [[ "$TITLE" == *"doc:"* || "$TITLE" == *"docs:"* || "$TITLE" == *"chore:"* ]]; then
+          echo "Skipping validation as this is a PR for documentation or chore."
+          gh pr edit $PRNUM --remove-label "PR:Issue-verification-failed"
+          gh pr edit $PRNUM --add-label "PR:Ready-to-Review"
+          exit 0
+        fi
+        pattern="((Fixes|Resolves) #[0-9]+)"
+        # Get the pull request body
+        PR_BODY=$(jq -r '.pull_request.body' $GITHUB_EVENT_PATH)
+
+        issue_num=$(echo "$PR_BODY" | grep -o -P "$pattern" | head -n1 | grep -o -E "[0-9]+")
+        if [[ -z "$issue_num" ]]; then
+            issue_num="No issue number"
+        fi
+        echo "$issue_num"
+        
+        IFS="/" read -r -a url_parts <<< "$url"
+        
+        # Remove the last two elements (repos and the issue number)
+        unset url_parts[-1]
+        unset url_parts[-1]
+        # Reattach the URL pieces
+        url=$(IFS=/; echo "${url_parts[*]}")
+
+        # Add the issue number to the URL
+        url="${url}/issues/${issue_num}"
+        echo "$url"
+        response_code=$(curl -s -o /dev/null -w "%{http_code}" "$url")
+        if [[ "$response_code" -eq 200 ]]; then
+          # Check if issue is open or closed
+          text=$(curl -s "$url")
+          echo "checking status of the issue"
+          if [[ $(echo "$text" | jq -r '.state') == "open" ]]; then
+            echo "Issue #$issue_num is open"
+            echo "Issue reference found in the pull request body."
+            gh pr edit $PRNUM --remove-label "PR:Issue-verification-failed"
+            gh pr edit $PRNUM --add-label "PR:Ready-to-Review"
+            exit 0
+          else
+            echo "Issue #$issue_num is not open"
+            exit 1
+          fi
+        else
+            echo "Invalid Response Code obtained - error code: $response_code"
+            echo "No valid issue reference found in the pull request body."
+            gh pr comment $PRNUM --body "PR is not linked to any issue, please make the corresponding changes in the body."
+            gh pr edit $PRNUM --add-label "PR:Issue-verification-failed"
+            gh pr edit $PRNUM --remove-label "PR:Ready-to-Review"
+            exit 1
+        fi
diff --git a/api/bean/ClusterInfo.go b/api/bean/ClusterInfo.go
@@ -9,4 +9,5 @@ type ClusterInfo struct {
 	KeyData               string `json:"keyData"`
 	CertData              string `json:"certData"`
 	CAData                string `json:"CAData"`
+	ProxyUrl              string `json:"proxyUrl"`
 }
diff --git a/api/helm-app/HelmAppService.go b/api/helm-app/HelmAppService.go
@@ -148,6 +148,7 @@ func (impl *HelmAppServiceImpl) listApplications(ctx context.Context, clusterIds
 			Token:        clusterDetail.Config[k8s.BearerToken],
 			ClusterId:    int32(clusterDetail.Id),
 			ClusterName:  clusterDetail.ClusterName,
+			ProxyUrl:     clusterDetail.ProxyUrl,
 		}
 		req.Clusters = append(req.Clusters, config)
 	}
@@ -282,6 +283,7 @@ func (impl *HelmAppServiceImpl) GetClusterConf(clusterId int) (*ClusterConfig, e
 			Token:        clusterObj.Config[k8s.BearerToken],
 			ClusterId:    int32(clusterObj.Id),
 			ClusterName:  clusterObj.ClusterName,
+			ProxyUrl:     clusterObj.ProxyUrl,
 		}
 	}
 
diff --git a/api/helm-app/applist.pb.go b/api/helm-app/applist.pb.go
diff --git a/api/helm-app/applist.proto b/api/helm-app/applist.proto
@@ -9,6 +9,7 @@ message ClusterConfig {
   string token = 2;
   int32 clusterId = 3;
   string clusterName = 4;
+  string proxyUrl = 5;
 }
 
 message AppListRequest {
diff --git a/client/telemetry/TelemetryEventClient.go b/client/telemetry/TelemetryEventClient.go
@@ -226,6 +226,7 @@ func (impl *TelemetryEventClientImpl) SummaryDetailsForTelemetry() (cluster []cl
 			Token:        clusterDetail.Config[k8s.BearerToken],
 			ClusterId:    int32(clusterDetail.Id),
 			ClusterName:  clusterDetail.ClusterName,
+			ProxyUrl:     clusterDetail.ProxyUrl,
 		}
 		req.Clusters = append(req.Clusters, config)
 		applicationStream, err := impl.helmAppClient.ListApplication(context.Background(), req)
diff --git a/pkg/app/AppService.go b/pkg/app/AppService.go
@@ -3048,6 +3048,7 @@ func (impl *AppServiceImpl) createHelmAppForCdPipeline(overrideRequest *bean.Val
 				ClusterName:  envOverride.Environment.Cluster.ClusterName,
 				Token:        bearerToken,
 				ApiServerUrl: envOverride.Environment.Cluster.ServerUrl,
+				ProxyUrl:     envOverride.Environment.Cluster.ProxyUrl,
 			},
 		}
 
diff --git a/pkg/cluster/ClusterService.go b/pkg/cluster/ClusterService.go
@@ -65,6 +65,7 @@ type ClusterBean struct {
 	Id                      int                        `json:"id" validate:"number"`
 	ClusterName             string                     `json:"cluster_name,omitempty" validate:"required"`
 	ServerUrl               string                     `json:"server_url,omitempty" validate:"url,required"`
+	ProxyUrl                string                     `json:"proxyUrl,omitempty" validate:"omitempty,url"`
 	PrometheusUrl           string                     `json:"prometheus_url,omitempty" validate:"validate-non-empty-url"`
 	Active                  bool                       `json:"active"`
 	Config                  map[string]string          `json:"config,omitempty"`
@@ -87,6 +88,7 @@ func GetClusterBean(model repository.Cluster) ClusterBean {
 	bean.Id = model.Id
 	bean.ClusterName = model.ClusterName
 	bean.ServerUrl = model.ServerUrl
+	bean.ProxyUrl = model.ProxyUrl
 	bean.PrometheusUrl = model.PrometheusEndpoint
 	bean.AgentInstallationStage = model.AgentInstallationStage
 	bean.Active = model.Active
@@ -120,8 +122,9 @@ type PrometheusAuth struct {
 func (bean ClusterBean) GetClusterConfig() (*k8s.ClusterConfig, error) {
 	host := bean.ServerUrl
 	configMap := bean.Config
+	proxyUrl := bean.ProxyUrl
 	bearerToken := configMap[k8s.BearerToken]
-	clusterCfg := &k8s.ClusterConfig{Host: host, BearerToken: bearerToken}
+	clusterCfg := &k8s.ClusterConfig{Host: host, BearerToken: bearerToken, ProxyUrl: proxyUrl}
 	clusterCfg.InsecureSkipTLSVerify = bean.InsecureSkipTLSVerify
 	if bean.InsecureSkipTLSVerify == false {
 		clusterCfg.KeyData = configMap[k8s.TlsKey]
@@ -226,7 +229,7 @@ func (impl *ClusterServiceImpl) ConvertClusterBeanToCluster(clusterBean *Cluster
 	model.Config = clusterBean.Config
 	model.PrometheusEndpoint = clusterBean.PrometheusUrl
 	model.InsecureSkipTlsVerify = clusterBean.InsecureSkipTLSVerify
-
+	model.ProxyUrl = clusterBean.ProxyUrl
 	if clusterBean.PrometheusAuth != nil {
 		model.PUserName = clusterBean.PrometheusAuth.UserName
 		model.PPassword = clusterBean.PrometheusAuth.Password
@@ -475,7 +478,9 @@ func (impl *ClusterServiceImpl) Update(ctx context.Context, bean *ClusterBean, u
 		bean.Config[k8s.CertificateAuthorityData] = model.Config[k8s.CertificateAuthorityData]
 	}
 
-	if bean.ServerUrl != model.ServerUrl || bean.InsecureSkipTLSVerify != model.InsecureSkipTlsVerify || dbConfigBearerToken != requestConfigBearerToken || dbConfigTlsKey != requestConfigTlsKey || dbConfigCertData != requestConfigCertData || dbConfigCAData != requestConfigCAData {
+	if bean.ServerUrl != model.ServerUrl || bean.ProxyUrl != model.ProxyUrl ||
+		bean.InsecureSkipTLSVerify != model.InsecureSkipTlsVerify || dbConfigBearerToken != requestConfigBearerToken ||
+		dbConfigTlsKey != requestConfigTlsKey || dbConfigCertData != requestConfigCertData || dbConfigCAData != requestConfigCAData {
 		if bean.ClusterName == DEFAULT_CLUSTER {
 			impl.logger.Errorw("default_cluster is reserved by the system and cannot be updated, default_cluster", "name", bean.ClusterName)
 			return nil, fmt.Errorf("default_cluster is reserved by the system and cannot be updated")
@@ -491,7 +496,7 @@ func (impl *ClusterServiceImpl) Update(ctx context.Context, bean *ClusterBean, u
 	model.ServerUrl = bean.ServerUrl
 	model.InsecureSkipTlsVerify = bean.InsecureSkipTLSVerify
 	model.PrometheusEndpoint = bean.PrometheusUrl
-
+	model.ProxyUrl = bean.ProxyUrl
 	if bean.PrometheusAuth != nil {
 		if bean.PrometheusAuth.UserName != "" {
 			model.PUserName = bean.PrometheusAuth.UserName
@@ -612,6 +617,7 @@ func (impl *ClusterServiceImpl) SyncNsInformer(bean *ClusterBean) {
 		ClusterName:           bean.ClusterName,
 		BearerToken:           requestConfig,
 		ServerUrl:             bean.ServerUrl,
+		ProxyUrl:              bean.ProxyUrl,
 		InsecureSkipTLSVerify: bean.InsecureSkipTLSVerify,
 	}
 	if !bean.InsecureSkipTLSVerify {
@@ -668,6 +674,7 @@ func (impl *ClusterServiceImpl) buildInformer() {
 				ClusterName:           model.ClusterName,
 				BearerToken:           bearerToken,
 				ServerUrl:             model.ServerUrl,
+				ProxyUrl:              model.ProxyUrl,
 				InsecureSkipTLSVerify: model.InsecureSkipTlsVerify,
 				KeyData:               model.Config[k8s.TlsKey],
 				CertData:              model.Config[k8s.CertData],
@@ -1023,6 +1030,7 @@ func (impl *ClusterServiceImpl) ValidateKubeconfig(kubeConfig string) (map[strin
 
 		if clusterObj != nil {
 			clusterBeanObject.InsecureSkipTLSVerify = clusterObj.InsecureSkipTLSVerify
+			clusterBeanObject.ProxyUrl = clusterObj.ProxyURL
 		}
 
 		if (clusterObj != nil) && !clusterObj.InsecureSkipTLSVerify && (clusterBeanObject.ErrorInConnecting == "") {
diff --git a/pkg/cluster/ClusterServiceExtended.go b/pkg/cluster/ClusterServiceExtended.go
@@ -221,8 +221,8 @@ func (impl *ClusterServiceImplExtended) Update(ctx context.Context, bean *Cluste
 
 	}
 
-	// if git-ops configured, then only update cluster in ACD, otherwise ignore
-	if isGitOpsConfigured {
+	// if git-ops configured and no proxy is configured, then only update cluster in ACD, otherwise ignore
+	if isGitOpsConfigured && len(bean.ProxyUrl) == 0 {
 		configMap := bean.Config
 		serverUrl := bean.ServerUrl
 		bearerToken := ""
@@ -334,8 +334,8 @@ func (impl *ClusterServiceImplExtended) Save(ctx context.Context, bean *ClusterB
 		return nil, err
 	}
 
-	// if git-ops configured, then only add cluster in ACD, otherwise ignore
-	if isGitOpsConfigured {
+	// if git-ops configured and no proxy is configured, then only add cluster in ACD, otherwise ignore
+	if isGitOpsConfigured && len(clusterBean.ProxyUrl) == 0 {
 		//create it into argo cd as well
 		cl := impl.ConvertClusterBeanObjectToCluster(bean)
 
diff --git a/pkg/cluster/repository/ClusterRepository.go b/pkg/cluster/repository/ClusterRepository.go
@@ -35,6 +35,7 @@ type Cluster struct {
 	Id                     int               `sql:"id,pk"`
 	ClusterName            string            `sql:"cluster_name"`
 	ServerUrl              string            `sql:"server_url"`
+	ProxyUrl               string            `sql:"proxy_url"`
 	PrometheusEndpoint     string            `sql:"prometheus_endpoint"`
 	Active                 bool              `sql:"active,notnull"`
 	CdArgoSetup            bool              `sql:"cd_argo_setup,notnull"`
diff --git a/pkg/k8s/informer/K8sInformerFactory.go b/pkg/k8s/informer/K8sInformerFactory.go
@@ -68,6 +68,7 @@ func (impl *K8sInformerFactoryImpl) BuildInformer(clusterInfo []*bean.ClusterInf
 			ClusterName:           info.ClusterName,
 			BearerToken:           info.BearerToken,
 			Host:                  info.ServerUrl,
+			ProxyUrl:              info.ProxyUrl,
 			InsecureSkipTLSVerify: info.InsecureSkipTLSVerify,
 			KeyData:               info.KeyData,
 			CertData:              info.CertData,
diff --git a/pkg/terminal/terminalSesion.go b/pkg/terminal/terminalSesion.go
@@ -271,7 +271,6 @@ func getExecutor(k8sClient kubernetes.Interface, cfg *rest.Config, podName, name
 		Stderr:    true,
 		TTY:       tty,
 	}, scheme.ParameterCodec)
-
 	exec, err := remotecommand.NewSPDYExecutor(cfg, "POST", req.URL())
 	return exec, err
 }
diff --git a/scripts/sql/163_alter_cluster.down.sql b/scripts/sql/163_alter_cluster.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE cluster
+    DROP COLUMN IF EXISTS proxy_url;
diff --git a/scripts/sql/163_alter_cluster.up.sql b/scripts/sql/163_alter_cluster.up.sql
@@ -0,0 +1,2 @@
+ALTER TABLE cluster
+    ADD COLUMN IF NOT EXISTS proxy_url text;
diff --git a/util/k8s/K8sUtil.go b/util/k8s/K8sUtil.go
@@ -76,6 +76,7 @@ type K8sUtil struct {
 type ClusterConfig struct {
 	ClusterName           string
 	Host                  string
+	ProxyUrl              string
 	BearerToken           string
 	InsecureSkipTLSVerify bool
 	KeyData               string
@@ -109,6 +110,14 @@ func (impl K8sUtil) GetRestConfigByCluster(clusterConfig *ClusterConfig) (*restc
 		}
 	} else {
 		restConfig = &rest.Config{Host: clusterConfig.Host, BearerToken: bearerToken, TLSClientConfig: rest.TLSClientConfig{Insecure: clusterConfig.InsecureSkipTLSVerify}}
+		if len(clusterConfig.ProxyUrl) > 0 {
+			proxy, err := url.Parse(clusterConfig.ProxyUrl)
+			if err != nil {
+				impl.logger.Errorw("error in parsing proxy url", "err", err, "proxyUrl", clusterConfig.ProxyUrl)
+				return nil, err
+			}
+			restConfig.Proxy = http.ProxyURL(proxy)
+		}
 		if clusterConfig.InsecureSkipTLSVerify == false {
 			restConfig.TLSClientConfig.ServerName = restConfig.ServerName
 			restConfig.TLSClientConfig.KeyData = []byte(clusterConfig.KeyData)

Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,5 @@ type ClusterInfo struct {`
`9`	`9`	KeyData string `json:"keyData"`
`10`	`10`	CertData string `json:"certData"`
`11`	`11`	CAData string `json:"CAData"`
	`12`	+ ProxyUrl string `json:"proxyUrl"`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -148,6 +148,7 @@ func (impl *HelmAppServiceImpl) listApplications(ctx context.Context, clusterIds`
`148`	`148`	`Token: clusterDetail.Config[k8s.BearerToken],`
`149`	`149`	`ClusterId: int32(clusterDetail.Id),`
`150`	`150`	`ClusterName: clusterDetail.ClusterName,`
	`151`	`+ ProxyUrl: clusterDetail.ProxyUrl,`
`151`	`152`	`}`
`152`	`153`	`req.Clusters = append(req.Clusters, config)`
`153`	`154`	`}`
`@@ -282,6 +283,7 @@ func (impl HelmAppServiceImpl) GetClusterConf(clusterId int) (ClusterConfig, e`
`282`	`283`	`Token: clusterObj.Config[k8s.BearerToken],`
`283`	`284`	`ClusterId: int32(clusterObj.Id),`
`284`	`285`	`ClusterName: clusterObj.ClusterName,`
	`286`	`+ ProxyUrl: clusterObj.ProxyUrl,`
`285`	`287`	`}`
`286`	`288`	`}`
`287`	`289`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ message ClusterConfig {`
`9`	`9`	`string token = 2;`
`10`	`10`	`int32 clusterId = 3;`
`11`	`11`	`string clusterName = 4;`
	`12`	`+ string proxyUrl = 5;`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`message AppListRequest {`
Original file line number	Diff line number	Diff line change
`@@ -226,6 +226,7 @@ func (impl *TelemetryEventClientImpl) SummaryDetailsForTelemetry() (cluster []cl`
`226`	`226`	`Token: clusterDetail.Config[k8s.BearerToken],`
`227`	`227`	`ClusterId: int32(clusterDetail.Id),`
`228`	`228`	`ClusterName: clusterDetail.ClusterName,`
	`229`	`+ ProxyUrl: clusterDetail.ProxyUrl,`
`229`	`230`	`}`
`230`	`231`	`req.Clusters = append(req.Clusters, config)`
`231`	`232`	`applicationStream, err := impl.helmAppClient.ListApplication(context.Background(), req)`
Original file line number	Diff line number	Diff line change
`@@ -3048,6 +3048,7 @@ func (impl AppServiceImpl) createHelmAppForCdPipeline(overrideRequest bean.Val`
`3048`	`3048`	`ClusterName: envOverride.Environment.Cluster.ClusterName,`
`3049`	`3049`	`Token: bearerToken,`
`3050`	`3050`	`ApiServerUrl: envOverride.Environment.Cluster.ServerUrl,`
	`3051`	`+ ProxyUrl: envOverride.Environment.Cluster.ProxyUrl,`
`3051`	`3052`	`},`
`3052`	`3053`	`}`
`3053`	`3054`