Skip to content

Commit 3e63860

Browse files
committed
doc: mgr/dashboard: add OAuth2 SSO documentation
Signed-off-by: Pedro Gonzalez Gomez <[email protected]>
1 parent ee6523b commit 3e63860

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

doc/mgr/dashboard.rst

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ The dashboard provides the following features:
4343
after the first login or after a configurable time period. See
4444
:ref:`dashboard-user-role-management` for details.
4545
* **Single Sign-On (SSO)**: The dashboard supports authentication
46-
via an external identity provider using the SAML 2.0 protocol. See
47-
:ref:`dashboard-sso-support` for details.
46+
via an external identity provider using the SAML 2.0 protocol or thse OAuth2 protocol. See
47+
:ref:dashboard-saml2-sso-support and :ref:dashboard-oauth2-sso-support for details.
4848
* **SSL/TLS support**: All HTTP communication between the web browser and the
4949
dashboard is secured via SSL. A self-signed certificate can be created with
5050
a built-in command, but it's also possible to import custom certificates
@@ -698,10 +698,10 @@ If no value is set for that option, it will simply fall back to the value of the
698698
GRAFANA_API_URL option. If set, it will instruct the browser to use this URL to
699699
access Grafana.
700700

701-
.. _dashboard-sso-support:
701+
.. _dashboard-saml2-sso-support:
702702

703-
Enabling Single Sign-On (SSO)
704-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703+
Enabling SAML2 Single Sign-On (SSO)
704+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
705705

706706
The Ceph Dashboard supports external authentication of users via the
707707
`SAML 2.0 <https://en.wikipedia.org/wiki/SAML_2.0>`_ protocol. You need to
@@ -762,6 +762,42 @@ To enable SSO:
762762

763763
ceph dashboard sso enable saml2
764764

765+
.. _dashboard-oauth2-sso-support:
766+
767+
Enabling OAuth2 Single Sign-On (SSO)
768+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
769+
770+
The Ceph Dashboard supports external authentication of users via the
771+
`OAuth <https://en.wikipedia.org/wiki/OAuth>`_ protocol. You need to
772+
have :ref:`cephadm` enabled as your orchestrator with an active
773+
:ref:`deploy-cephadm-mgmt-gateway` and :ref:`deploy-cephadm-oauth2-proxy` services.
774+
775+
From the IDP of choice, Keycloak is the current recomendation and tested solution,
776+
configure the IDP's client used in the `oauth2-proxy` service configuration to validate the following redirect URLs
777+
for login_url: `https://<host_name>|<IP_address>/oauth2/callback` and
778+
the following logout_url: `https://<host_name>|<IP_address>/ /oauth2/sign_out`
779+
780+
Again, from the IDP, we will need a user with a valid role, this user will be the one to perform
781+
authorization against, we can create a role like: 'administator' to give admin level access to the user.
782+
783+
To disable SSO:
784+
785+
.. prompt:: bash $
786+
787+
ceph dashboard sso disable
788+
789+
To check if SSO is enabled:
790+
791+
.. prompt:: bash $
792+
793+
ceph dashboard sso status
794+
795+
To enable SSO:
796+
797+
.. prompt:: bash $
798+
799+
ceph dashboard sso enable oauth2
800+
765801
.. _dashboard-alerting:
766802

767803
Enabling Prometheus Alerting

0 commit comments

Comments
 (0)