Link to GitHub app from dashboard

openfaas / openfaas-cloud

The Multi-user OpenFaaS Platform

https://docs.openfaas.com/openfaas-cloud/intro/

MIT License

770 stars 227 forks source link

Link to GitHub app from dashboard #697

Closed wilsonianb closed 3 years ago

wilsonianb commented 3 years ago

Users of an OpenFaaS Cloud cluster currently need to obtain the link of the GitHub app out of band. Linking to the app in the dashboard would make the installation step easier.

Expected Behaviour

Ofc users can find the GitHub app to install via the dashboard

Current Behaviour

Link to app is obtained out of band

Possible Solution

Repurpose the dashboard icon linking to the openfaas-cloud github repo https://github.com/codius/openfaas-cloud/commit/d52554f0249ed37922d761b1e2ea27037e884e9e

Steps to Reproduce (for bugs)

Context

Your Environment

FaaS-CLI version ( Full output from: faas-cli version ):
Docker version docker version (e.g. Docker 17.0.05 ):
Are you using Docker Swarm or Kubernetes (FaaS-netes)?
Operating System and version (e.g. Linux, Windows, MacOS):
Link to your project or a code example to reproduce issue:
Please also follow the troubleshooting guide and paste in any other diagnostic information you have:

wilsonianb commented 3 years ago

Ditto for the cluster sealed secrets public key. It could be served and linked to in the dashboard: https://github.com/codius/openfaas-cloud/commit/8e8a7c51b988ea67bdbd344cf1657cdb7ab0e4bf https://github.com/codius/codius-faas/commit/c61d40163ed3fefc34c1ecc83b5580407b507c58

alexellis commented 3 years ago

I would accept a PR for this @wilsonianb and think it would be really useful.

Since SealedSecrets is always going to be installed, we could use a glyph icon for a key, and one for git or a laptop for the Git link.

You'll find a URL for GitLab already, but GitHub will need to be built up or inputted.

alexellis commented 3 years ago

There is actually a gitlab FA icon, that we could switch in depending on config: https://fontawesome.com/icons?d=gallery&q=git

And for a key icon -> https://fontawesome.com/icons/key?style=solid

It'd also be good to have roll-over text for both so that people can see what they are before clicking.

How are we doing to serve the key? by mounting it in the dashboard and returning over /api/...?

wilsonianb commented 3 years ago

I can submit a pr.

How are we doing to serve the key? by mounting it in the dashboard and returning over /api/...?

I've just been putting the key in /dashboard/dist like the favicon.ico https://github.com/codius/openfaas-cloud/commit/8e8a7c51b988ea67bdbd344cf1657cdb7ab0e4bf

alexellis commented 3 years ago

We should also update the blank state page to reference how to install the app / download the sealedsecret key