Skip to content

Commit

Permalink
last spelling corrections (#1077)
Browse files Browse the repository at this point in the history
The last of the spelling corrections and updates to the word list.
  • Loading branch information
johrstrom authored Jan 21, 2025
1 parent 6aaf9e2 commit 8f6d17b
Show file tree
Hide file tree
Showing 18 changed files with 262 additions and 240 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Configure Keycloak with CILogon

We will now use Keycloak's admin Web UI to setup the ability to log existing users in with CILogon.

When a user logs in with CILogon for the first time they will be redirected back to Keycloak to log in with their local (ie LDAP)
When a user logs in with CILogon for the first time they will be redirected back to Keycloak to log in with their local (i.e., LDAP)
credentials. This performs a mapping of their CILogon identity with their Keycloak identity.

.. warning::
Expand All @@ -18,11 +18,11 @@ Register your Keycloak instance with CILogon

#. Go to ``https://cilogon.org/oauth2/register`` and fill out the form

#. The Home URL will be the base URL of your Keycloak instance, eg: ``https://ondemand-idpdev.hpc.osc.edu``.
#. The Home URL will be the base URL of your Keycloak instance, e.g.: ``https://ondemand-idpdev.hpc.osc.edu``.
#. The callback URL will be ``https://ondemand-idpdev.hpc.osc.edu/auth/realms/<REALM>/broker/cilogon/endpoint``.
Replace ``https://ondemand-idpdev.hpc.osc.edu`` with your Keycloak instance
#. The box for "Is this a public client?" should not be checked
#. For "Scopes" be sure to check "profile" and "org.cilogon.userinfo"
#. For "Scopes" be sure to check ``profile`` and ``org.cilogon.userinfo``

You will be provided a Client ID and a Client Secret, be sure to save these values.
Your registered client will not be usable until you receive an email from CILogon stating your client has been approved.
Expand All @@ -36,7 +36,7 @@ Add the CILogon Identity Provider
#. Select the "Add provider..." drop down and choose "OpenID Connect v1.0"
#. Fill in the fields as noted below

#. Alias: cilogon (This must be cilogon as this alias is used in the callback URL)
#. Alias: ``cilogon`` (This must be ``cilogon`` as this alias is used in the callback URL)
#. Display Name: CILogon
#. Enabled: ON
#. First Login Flow: browser
Expand All @@ -46,7 +46,7 @@ Add the CILogon Identity Provider
#. Client Authentication: Client secret sent as post
#. Client ID: <Client ID provided by CILogon at registration>
#. Client Secret: <Client Secret provided by CILogon at registration>
#. Default Scopes: "openid profile org.cilogon.userinfo"
#. Default Scopes: ``openid profile org.cilogon.userinfo``

#. Click "Save"

Expand All @@ -56,7 +56,7 @@ Support users removing CILogon mappings
In order for a user to remove an existing CILogon mapping in Keycloak they must navigate to ``https://ondemand-idpdev.hpc.osc.edu/auth/realms/<REALM>/account/identity``.
Replace ``ondemand-idpdev.hpc.osc.edu`` with the web URL for your Keycloak instance.

The URL can be added to the OnDemand Help dropdown with custom text to make it easier for users to access their Keycloak identity page.
The URL can be added to the OnDemand Help drop-down with custom text to make it easier for users to access their Keycloak identity page.

#. Add ``OOD_DASHBOARD_HELP_CUSTOM_URL`` to ``/etc/ood/config/apps/dashboard/env`` that points to the URL of the identity page for your Keycloak instance.
Example: ``https://ondemand-idpdev.hpc.osc.edu/auth/realms/osc/account/identity``
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ Configure LDAP
------------------------------------------

#. Choose User Federation on the left (verify ondemand realm is current realm)
#. Select "ldap" for provider
#. Select ``ldap`` for provider

#. Import Users set to OFF
#. Edit Mode set to READ_ONLY
#. Vendor set to other – for OpenLDAP
#. User Object Classes set to posixAccount – OSC specific and odd
#. Connection URL: ldaps://ldap1.infra.osc.edu:636 ldaps://ldap2.infra.osc.edu:636 – using multiple to demonstrate more than 1
#. User DN: ou=People,dc=osc,dc=edu
#. User Object Classes set to ``posixAccount`` – OSC specific and odd
#. Connection URL: ``ldaps://ldap1.infra.osc.edu:636 ldaps://ldap2.infra.osc.edu:636`` – using multiple to demonstrate more than 1
#. User DN: ``ou=People,dc=osc,dc=edu``
#. Auth Type: none – OSC specific as we allow anonymous binds
#. Use Truststore SPI: never – OSC specific since our LDAP certificates are already trusted since from InCommon, leaving default is probably acceptable if no truststoreSpi defined in XML configs
#. Use Truststore SPI: never – OSC specific since our LDAP certificates are already trusted since from InCommon, leaving default is probably acceptable if no ``truststoreSpi`` defined in XML configurations.

#. Save

Expand All @@ -48,8 +48,8 @@ Add OnDemand as a client

#. Choose Clients, then click Create in top right corner

#. Client ID: ondemand-dev.hpc.osc.edu
#. Client Protocol: openid-connect
#. Client ID: ``ondemand-dev.hpc.osc.edu``
#. Client Protocol: ``openid-connect``
#. Save (leave Root URL blank)

#. Then edit Settings for the newly created client:
Expand All @@ -65,6 +65,6 @@ Add OnDemand as a client

#. Finally, get the client secret to use with OnDemand installation:

#. Select the "Credentials" tab of the "Client" you are viewing i.e. "Clients >> ondemand-dev.hpc.osc.edu"
#. Select the "Credentials" tab of the "Client" you are viewing i.e. ``Clients >> ondemand-dev.hpc.osc.edu``
#. Copy the value for "secret" for future use in this tutorial (and keep it secure).

Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
Configure OnDemand to authenticate with Keycloak
================================================

OnDemand's Apache needs to use mod_auth_openidc to be able to act as an OpenID
Connect client to Keycloak. We will install mod_auth_openidc and modify
OnDemand's Apache configs to enable authentication via Keycloak.
OnDemand's Apache needs to use ``mod_auth_openidc`` to be able to act as an OpenID
Connect client to Keycloak. We will install ``mod_auth_openidc`` and modify
OnDemand's Apache configurations to enable authentication via Keycloak.

Install mod_auth_openidc
------------------------
Install ``mod_auth_openidc``
----------------------------

#. Install httpd24-mod_auth_openidc from ondemand-web repo
#. Install ``httpd24-mod_auth_openidc`` from ondemand-web repository.

.. code-block:: sh
sudo yum install httpd24-mod_auth_openidc
Re-generate main config using ood-portal-generator
Re-generate main configuration using ood-portal-generator
-----------------------------------------------------------

#. Edit the YAML configuration file for the :ref:`ood-portal-generator` located
Expand Down Expand Up @@ -49,20 +49,20 @@ Re-generate main config using ood-portal-generator
Notice that we are

* changing the Authentication directives for openid-connect
* specifying /oidc to be the sub-uri used by mod_auth_openidc
* specifying that /logout should redirect to this /oidc sub-uri to handle logout
* changing the Authentication directives for ``openid-connect``
* specifying ``/oidc`` to be the URI used by ``mod_auth_openidc``
* specifying that /logout should redirect to this ``/oidc`` URI to handle logout
and specifying after logout, the user should be redirected back to OnDemand
(which in this tutorial's case is ``https%3A%2F%2Fondemand-dev.hpc.osc.edu``,
the query param escaped format of ``https://ondemand-dev.hpc.osc.edu``)
the query parameter escaped format of ``https://ondemand-dev.hpc.osc.edu``)

#. Then build and install the new Apache configuration file with:

.. code-block:: sh
sudo /opt/ood/ood-portal-generator/sbin/update_ood_portal
The effect of this change in the Apache config (in case you want to apply the changes manually) are:
The effect of this change in the Apache configuration (in case you want to apply the changes manually) are:

#. Change the authentication directives for all of the Locations that require authentication i.e.:

Expand Down Expand Up @@ -100,10 +100,10 @@ Re-generate main config using ood-portal-generator
Require valid-user
</Location>
Add Keycloak config to OnDemand Apache for mod_auth_openidc
-----------------------------------------------------------
Add Keycloak configuration to OnDemand Apache for ``mod_auth_openidc``
----------------------------------------------------------------------

#. Add the file /opt/rh/httpd24/root/etc/httpd/conf.d/auth_openidc.conf with the contents:
#. Add the file ``/opt/rh/httpd24/root/etc/httpd/conf.d/auth_openidc.conf`` with the contents:

.. code-block:: none
Expand Down Expand Up @@ -140,7 +140,7 @@ Add Keycloak config to OnDemand Apache for mod_auth_openidc
#. Then restart OnDemand's Apache. OnDemand should now be authenticating using KeyCloak.

Stop both servives:
Stop both services:

.. code-block:: sh
Expand Down
Loading

0 comments on commit 8f6d17b

Please sign in to comment.