Feature: Dashboard/Router without CI/CD integration #440

Open alexellis opened 5 years ago

Expected Behaviour

Persona:

As an enterprise user I have my own opinionated way to do CI/CD and I've spent millions of dollars creating it. It's called Jenkins as a Service, or similar. It's been audited, passed security checks and has political buy-in. I don't want your Buildkit.

What do they lose vs. a fully integrated experience?

CI
CD
GitHub / GitLab commit status integration
Build logs integration

What can they gain?

If they deploy from their own CI/CD pipelines using the appropriate labels then they can access:

A rich, new dashboard with integrated statistics
The router for persona/org sub-domains
OAuth2 authentication
OAuth2 authorisation (partially finished/released)

Current Behaviour

Possible, yet undocumented. We could be missing out on many users who would benefit from the enhanced experience.

Possible Solution

Test what the minimum configuration would be and how to deploy it. Test it on functions deployed manually via the CLI or REST API.

See the example in the Dashboard README for how to correctly label/annotate functions: https://github.com/openfaas/openfaas-cloud/tree/master/dashboard#deploy-a-few-functions-for-sample-data

Derek assign: me

If no CI/CD is required the following functions/components can be ignored:

git-tar
buildshiprun
of-builder
pipeline-log
import-secrets - they could still use this one but I think it would be best if we recommend to use the faas cli
github-push or gitlab
github-event or gitlab

It's quite simple to deploy a function and have it be integrated to OpenFaaS Cloud, with [adding the labels]() that @alexellis mentioned on the description you are good to go.

I'm thinking we could do the following to enable this:

Create a script that deletes the previously mentioned components from openfaas cloud. This covers existing users that want to migrate away from the buildkit,
Modify ofc-bootstrap to allow a new "plan" that does not deploy these components(takes more work)
Add a flag to ofc-bootstrap that simply deletes the components(via executing the previously mentioned script) after the installation is done

@alexellis How should we document this? A new docs/CI_CD_DISABLED.md file that gets linked from the readme?

My original idea was to not install the extra components. Or in other words, only to install what is needed depending on the ask from the user.

What are we actually installing? The dashboard + TLS functionality? Anything else?

What we really need is:

edge-router
edge-auth
Dashboard
All the TLS stuff

But do note that we might have some unexpected behavior on the dashboard when the user clicks on the build log button. Maybe we can enable/disable that button based on a cicd flag.

Yes we can feature flag it with an environment variable.

Here is what I'm thinking for this:

Add a section to the manual deployment guide for installing only the router/auth/dashboard components.
Add a flag to ofc bootstrap to only install the mentioned components.

What do you think? @alexellis

Sounds good. Then explain how someone can deploy from their git repo with the right labels and flags

Awesome. I'll get started!

On Thu, Jun 13, 2019, 11:09 Alex Ellis notifications@github.com wrote:

Sounds good. Then explain how someone can deploy from their git repo with the right labels and flags

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/openfaas/openfaas-cloud/issues/440?email_source=notifications&email_token=AB6ADK6FKLGIMQH6A43GFCDP2JIJ7A5CNFSM4HHRCQY2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXT2AQY#issuecomment-501719107, or mute the thread https://github.com/notifications/unsubscribe-auth/AB6ADKYWRQQ2UYBNCN7WAT3P2JIJ7ANCNFSM4HHRCQYQ .

openfaas / openfaas-cloud