Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(admin): describe LS Login configuration #25

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

svedziok
Copy link
Contributor

@svedziok svedziok commented Nov 7, 2024

Add admin guide on how to integrate LS-AAI in different services.

Summary by Sourcery

Documentation:

  • Add a new admin guide on integrating LS-AAI with JupyterHub and Hedgedoc.

@svedziok svedziok requested a review from uniqueg November 7, 2024 15:12
Copy link
Contributor

sourcery-ai bot commented Nov 7, 2024

Reviewer's Guide by Sourcery

This PR adds documentation for integrating LS-AAI (Life Science Login) authentication into different services. The implementation consists of adding a new markdown file with detailed configuration guides for JupyterHub and Hedgedoc services, along with updating the mkdocs navigation to include the new guide.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for LS-AAI integration
  • Created a new guide with detailed JupyterHub configuration steps including OAuth settings
  • Added Hedgedoc integration instructions with required environment variables
  • Included links to relevant external resources and prerequisites
  • Added configuration examples with detailed explanations
docs/guides/guide-dev/services_to_ls_aai.md
Updated documentation navigation structure
  • Added new LS-AAI guide to the Administrators section
mkdocs.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @svedziok - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The file path in mkdocs.yml (guide-admin/services_to_ls_aai.md) doesn't match the actual file location (guide-dev/services_to_ls_aai.md). Please ensure these paths are consistent.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 3 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

- ADMIN # here you can specify an user as admin
GenericOAuthenticator:
client_id: # add client id from SPREG
client_secret: # add client id from SPREG
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (documentation): Incorrect comment for client_secret field

The comment should say 'add client secret from SPREG' instead of 'add client id from SPREG'

- name: CMD_OAUTH2_CLIENT_ID
value: _REPLACE BY CLIENT ID_
- name: CMD_OAUTH2_CLIENT_SECRET
value: REPLACE BY CLIENT SECRET_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (documentation): Inconsistent placeholder formatting

Consider standardizing the placeholder format. Either use underscores on both sides for all placeholders or remove them for consistency with the client ID placeholder

Comment on lines +37 to +41
# Add LS_Login to Hedgedoc

Hedgedoc is configured using environment variables. This guide assumes that a Hedgedoc is already deployed, in our case we used this chart:

https://github.com/CSCfi/helm-charts/tree/main/charts/hedgedoc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (documentation): Missing prerequisite information for Hedgedoc setup

Consider adding a note about needing to register a service with LS-Login first, similar to the JupyterHub section, including a link to the registration process

Suggested change
# Add LS_Login to Hedgedoc
Hedgedoc is configured using environment variables. This guide assumes that a Hedgedoc is already deployed, in our case we used this chart:
https://github.com/CSCfi/helm-charts/tree/main/charts/hedgedoc
# Add LS_Login to Hedgedoc
Before configuring Hedgedoc, you need to register your service with LS-Login. Follow the registration process at https://lifescience-ri.eu/ls-login/documentation/how-to-integrate/registration.html
Hedgedoc is configured using environment variables. This guide assumes that a Hedgedoc is already deployed, in our case we used this chart:
https://github.com/CSCfi/helm-charts/tree/main/charts/hedgedoc

@uniqueg uniqueg changed the title Add lsaai docs(admin): describe LS Login configuration Dec 17, 2024
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff! Some minor comments. And I think the comments from Sourcery are also good

@@ -88,6 +88,7 @@ nav:
- "guides/guide-dev/index.md"
- Administrators:
- "guides/guide-admin/index.md"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to add a reference to the new page to the admin docs index page.

Also, see in the "Contributors" section below how you can give the subpages of each section different. It would probably be good to do that as well to make the index on the left side look pretty.

* In the SAML/OIDC setting page, you will also find values for Client ID and Client Secret
* To use LS-Login in Jupyterhub, you have to modify the config.yaml file (see also [here](https://z2jh.jupyter.org/en/stable/administrator/authentication.html)):

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add yaml to indicate the language for better syntax highlighting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants