Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support external link annotation #4752

Closed
kenchan0130 opened this issue Dec 16, 2020 · 3 comments · Fixed by #5667
Closed

Support external link annotation #4752

kenchan0130 opened this issue Dec 16, 2020 · 3 comments · Fixed by #5667
Labels
good first issue Good for newcomers type/feature Feature request

Comments

@kenchan0130
Copy link

kenchan0130 commented Dec 16, 2020

Summary

Like argoproj/argo-cd#4380, we may want to put external links to workflow templates and workflow execution results from UI as well.

Use Cases

  • Check the specifications for workflow.
  • Check logs and performance of workflow execution results

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritise the issues with the most 👍.

@kenchan0130 kenchan0130 added the type/feature Feature request label Dec 16, 2020
@alexec
Copy link
Contributor

alexec commented Dec 16, 2020

A feature to add links exists: https://argoproj.github.io/argo/links/
If we had a standard annotation we could modify the code to allow you to link that too. Would you like to submit a PR?

@alexec alexec added the good first issue Good for newcomers label Dec 16, 2020
@kenchan0130
Copy link
Author

A feature to add links exists: https://argoproj.github.io/argo/links/

This is to provide a link to the argo server, and I am aware that it is not possible to provide a link for individual workflows.

If we had a standard annotation we could modify the code to allow you to link that too. Would you like to submit a PR?

I don't know what the policy is for modifications, so please let me know.

Are you assuming that you don't add any processing on the server side, but modify the front end (probably around here)?

@alexec
Copy link
Contributor

alexec commented Dec 17, 2020

links:
      - name: Example Workflow Link
        scope: workflow
        url: http://logging-facility?namespace=${metadata.namespace}&workflowName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}
      - name: Example Pod Link
        scope: pod
        url: http://logging-facility?namespace=${metadata.namespace}&podName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}

I thinking new formatting things could be added:

links:
      - name: Example Workflow Link
        scope: workflow
        URL: "${metadata.annotations[''workflows.argoproj.io/external-link"]}'

You'd need to modify this func to support it:

https://github.com/argoproj/argo/blob/master/ui/src/app/workflows/components/workflow-details/workflow-details.tsx#L350

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers type/feature Feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants