feat: Make Argo UI aware of OpenShift objects#4601 #5096

iam-veeramalla · 2020-12-21T12:43:47Z

Signed-off-by: iam-veeramalla abhishek.veeramalla@gmail.com

Checklist:

Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
The title of the PR states what changed and the related issues number (used for the release note).
I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
Does this PR require documentation updates?
I've updated documentation as required by this PR.
Optional. My organization is added to USERS.md.
I have signed off all my commits as required by DCO
My build is green (troubleshooting builds).

This PR will make Argo UI aware of OpenShift objects. It provides details such as the route url and services attached to route. This feature is currently available for ingress.

Fixes #4601 #7052

Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com>

iam-veeramalla · 2020-12-21T15:23:34Z

@alexmt can you review this ?

jessesuen · 2020-12-21T22:06:06Z

I think @jgwest and/or @wtam2018 would be good ones to review this

wtam2018 · 2020-12-21T23:25:38Z

@iam-veeramalla do you mind to create an issue to describe the enhancement? It would be nice to include some screen shots to illustrate the enhancement.

iam-veeramalla · 2020-12-22T01:39:11Z

@iam-veeramalla do you mind to create an issue to describe the enhancement? It would be nice to include some screen shots to illustrate the enhancement.

Sure @wtam2018

iam-veeramalla · 2020-12-22T11:21:15Z

@iam-veeramalla do you mind to create an issue to describe the enhancement? It would be nice to include some screen shots to illustrate the enhancement.

Sure @wtam2018

Argo renders the Ingress url for Ingress resource deployed in k8s and shows it in the ingress object under network map, This will help users to access their applications(pods) directly from the Argo UI. This feature is not available for openshift routes as Argo does not identify/render/provide any route details. Also, by the nature of openshift, it will convert any ingress resource into routes. So, Argo does not render the url, health details of k8s ingress or openshift routes deployed in openshift. So, the network map is technically not openshift friendly.

This enhancement will allow users to access the openshift route url from Argo UI. This will make user experience better as they don't have to describe route using oc cli and frame the route url(typically host+path) to access their applications. This feature is already available for ingress and istio virtual service in k8s platform. This feature is added as per the requirement in issue #4601

Another screenshot to explain how this enhancement will provide

Openshift route object identified by Argo does not even provide the health details. I will create an issue for that and add it as a follow up enhancement to this.

Please let me know, If you need more details.

@wtam2018 @jgwest

wtam2018 · 2020-12-22T13:41:13Z

Fixes #4601

wtam2018 · 2020-12-23T19:54:07Z

I'll take a look.

wtam2018

#4601 also propose to support DeploymentConfig . Should we address it? We could do it in a different PR.

wtam2018 · 2020-12-24T04:45:39Z

controller/cache/info.go

@@ -170,6 +191,45 @@ func populateIngressInfo(un *unstructured.Unstructured, res *ResourceInfo) {
 	res.NetworkingInfo = &v1alpha1.ResourceNetworkingInfo{TargetRefs: targets, Ingress: ingress, ExternalURLs: urls}
 }

+func populateRouteInfo(un *unstructured.Unstructured, res *ResourceInfo) {


I'd rename this function to populateOpenShiftRouteInfo.

wtam2018 · 2020-12-24T04:50:38Z

controller/cache/info.go

@@ -170,6 +191,45 @@ func populateIngressInfo(un *unstructured.Unstructured, res *ResourceInfo) {
 	res.NetworkingInfo = &v1alpha1.ResourceNetworkingInfo{TargetRefs: targets, Ingress: ingress, ExternalURLs: urls}
 }

+func populateRouteInfo(un *unstructured.Unstructured, res *ResourceInfo) {
+	route := getRoute(un)


This function is more like getOpenShiftIngress()?

wtam2018 · 2020-12-24T05:05:18Z

controller/cache/info.go

+			Namespace: un.GetNamespace(),
+			Name:      fmt.Sprintf("%s", backend["name"]),
+		}] = true
+	}


There is only one to backend service per route but there can be a list of alternateBackends. Please see https://docs.openshift.com/container-platform/3.6/architecture/networking/routes.html#alternateBackends

wtam2018 · 2020-12-24T05:07:34Z

controller/cache/info.go

+
+	if backend, ok, err := unstructured.NestedMap(un.Object, "spec", "to"); ok && err == nil {
+		targetsMap[v1alpha1.ResourceRef{
+			Kind:      kube.ServiceKind,


Currently, Kind can only be Service but should we not hardcode here? Perhaps, use backend["kind"] instead?

wtam2018 · 2020-12-24T05:11:53Z

controller/cache/info.go

+	res := make([]v1.LoadBalancerIngress, 0)
+	for _, item := range route {
+		if lbIngress, ok := item.(map[string]interface{}); ok {
+			if hostname := lbIngress["routerCanonicalHostname"]; hostname != nil {


routerCanonicalHostname is optional. Please see https://docs.openshift.com/container-platform/4.6/rest_api/network_apis/route-route-openshift-io-v1.html

wtam2018 · 2020-12-24T05:14:36Z

controller/cache/info.go

+		urls = append(urls, url)
+	}
+
+	res.NetworkingInfo = &v1alpha1.ResourceNetworkingInfo{TargetRefs: targets, Ingress: route, ExternalURLs: urls}


I think we need to handle edge cases when we are unable to extract backend services, ingress, and urls.

dlmorais-pbh · 2021-01-04T12:56:21Z

#4601 also propose to support DeploymentConfig . Should we address it? We could do it in a different PR.

One thing I know that Argo supports for Deployment, but not for DeploymentConfig, is the ability to trigger a rollout by using the "three dots menu" on Deployment object.

And there is also the icon at object's box.

mbecca · 2021-08-10T23:00:25Z

any update for this PR?

codecov · 2021-10-06T06:22:28Z

Codecov Report

Merging #5096 (619de1c) into master (45b3e48) will increase coverage by 0.08%.
The diff coverage is 82.85%.

@@            Coverage Diff             @@
##           master    #5096      +/-   ##
==========================================
+ Coverage   40.82%   40.90%   +0.08%     
==========================================
  Files         133      133              
  Lines       18154    18189      +35     
==========================================
+ Hits         7411     7440      +29     
- Misses       9672     9675       +3     
- Partials     1071     1074       +3

Impacted Files	Coverage Δ
controller/cache/info.go	`65.76% <82.85%> (+3.19%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 45b3e48...619de1c. Read the comment docs.

iam-veeramalla · 2021-10-06T06:26:16Z

any update for this PR?

I started to work back on this. I will probably get a PR for this by end of the week :)

pasha-codefresh · 2022-03-01T11:21:05Z

@iam-veeramalla could you please update on this? Do you need some help?

crenshaw-dev · 2023-05-29T20:35:03Z

Closing for now, @iam-veeramalla feel free to reopen when ready. :-)

feat: Make Argo UI aware of OpenShift objects#4601

619de1c

Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com>

wtam2018 suggested changes Dec 24, 2020

View reviewed changes

iam-veeramalla mentioned this pull request Aug 23, 2021

Add Link to the URL of Openshift Routes (to match ingress resources) #7052

Open

maxnitze mentioned this pull request Jan 10, 2023

Show links in UI for non-core ingress resources #11934

Open

crenshaw-dev closed this May 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Make Argo UI aware of OpenShift objects#4601 #5096

feat: Make Argo UI aware of OpenShift objects#4601 #5096

iam-veeramalla commented Dec 21, 2020 •

edited

Loading

iam-veeramalla commented Dec 21, 2020

jessesuen commented Dec 21, 2020

wtam2018 commented Dec 21, 2020

iam-veeramalla commented Dec 22, 2020

iam-veeramalla commented Dec 22, 2020 •

edited

Loading

wtam2018 commented Dec 22, 2020

wtam2018 commented Dec 23, 2020

wtam2018 left a comment

wtam2018 Dec 24, 2020

wtam2018 Dec 24, 2020

wtam2018 Dec 24, 2020

wtam2018 Dec 24, 2020 •

edited

Loading

wtam2018 Dec 24, 2020

wtam2018 Dec 24, 2020 •

edited

Loading

dlmorais-pbh commented Jan 4, 2021

mbecca commented Aug 10, 2021

codecov bot commented Oct 6, 2021 •

edited

Loading

iam-veeramalla commented Oct 6, 2021

pasha-codefresh commented Mar 1, 2022

crenshaw-dev commented May 29, 2023

feat: Make Argo UI aware of OpenShift objects#4601 #5096

feat: Make Argo UI aware of OpenShift objects#4601 #5096

Conversation

iam-veeramalla commented Dec 21, 2020 • edited Loading

iam-veeramalla commented Dec 21, 2020

jessesuen commented Dec 21, 2020

wtam2018 commented Dec 21, 2020

iam-veeramalla commented Dec 22, 2020

iam-veeramalla commented Dec 22, 2020 • edited Loading

wtam2018 commented Dec 22, 2020

wtam2018 commented Dec 23, 2020

wtam2018 left a comment

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020 • edited Loading

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020

Choose a reason for hiding this comment

wtam2018 Dec 24, 2020 • edited Loading

Choose a reason for hiding this comment

dlmorais-pbh commented Jan 4, 2021

mbecca commented Aug 10, 2021

codecov bot commented Oct 6, 2021 • edited Loading

Codecov Report

iam-veeramalla commented Oct 6, 2021

pasha-codefresh commented Mar 1, 2022

crenshaw-dev commented May 29, 2023

iam-veeramalla commented Dec 21, 2020 •

edited

Loading

iam-veeramalla commented Dec 22, 2020 •

edited

Loading

wtam2018 Dec 24, 2020 •

edited

Loading

wtam2018 Dec 24, 2020 •

edited

Loading

codecov bot commented Oct 6, 2021 •

edited

Loading