weaveworks / weave-gitops

Weave GitOps provides insights into your application deployments, and makes continuous delivery with GitOps easier to adopt and scale across your teams.
https://docs.gitops.weave.works/
Apache License 2.0
918 stars 153 forks source link

Improve the Dex guide #3389

Closed Callisto13 closed 1 year ago

Callisto13 commented 1 year ago

Proposed changes to this page.

Currently opaque, hard to follow, and makes many assumptions about what's been done+prior knowledge.

Could swap this for a guide on Keycloak instead, because their docs are waaaay better.

Acceptance criteria:

interdependence commented 1 year ago

It is a little confusing, but personally I really like Dex. I think most of the confusion (at least when I was following this guide) stems from how the orgs field of the Dex connector works, and how it relates to the RBAC configuration.

Callisto13 commented 1 year ago

Thanks for the note @interdependence πŸ‘

This ticket is open for anyone to pick up if you have ideas... 😏 πŸ˜„

joshri commented 1 year ago

The pre-reqs mention having TLS enabled - when I go to those docs, I get a little confused about what this is/how to do it coming in with zero knowledge of TLS.

Like here - do I have to put this in a specific place? kubectl create secret tls my-tls-secret \ --cert=path/to/cert/file \ --key=path/to/key/file

And then the next step is to reference it in "the helm release". Which helm release?

interdependence commented 1 year ago

You would run that command if you have a pre-existing cert that you would like to use instead of using another method for getting a cert (like cert-manager).

The helm release referenced is the weave-gitops helm release, and you can either let the dashboard handle TLS directly or delegate it to a dedicated ingress controller like ingress-nginx or traefik. Since Dex also should be setup using TLS, I would recommend using a dedicated ingress controller.

LappleApple commented 1 year ago

Closed this as the page will be folded into the install guide with modifications.