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

Add documentation re setting up environments #425

Merged
merged 4 commits into from
Feb 22, 2024

Conversation

MrCreosote
Copy link
Member

@MrCreosote MrCreosote commented Feb 14, 2024

Also delete the extremely crufty jetty-config.md and some build.gradle cruft

Closes #344

Also delete the extremely crufty jetty-config.md and some build.gradle
cruft
Copy link

codecov bot commented Feb 14, 2024

Codecov Report

Merging #425 (a9d1a4a) into gavin-inbox (060e222) will increase coverage by 0.00%.
Report is 2 commits behind head on gavin-inbox.
The diff coverage is n/a.

Additional details and impacted files
@@              Coverage Diff               @@
##             gavin-inbox     #425   +/-   ##
==============================================
  Coverage          93.39%   93.39%           
- Complexity          2142     2143    +1     
==============================================
  Files                126      126           
  Lines               7520     7524    +4     
  Branches            1178     1168   -10     
==============================================
+ Hits                7023     7027    +4     
  Misses               454      454           
  Partials              43       43           

Now that they're separated out no need to specify file types
Copy link

@bio-boris bio-boris left a comment

Choose a reason for hiding this comment

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

README.md Show resolved Hide resolved
documentation/Environments.md Outdated Show resolved Hide resolved
documentation/Environments.md Outdated Show resolved Hide resolved
@MrCreosote
Copy link
Member Author

Is it possible to update this example at https://github.com/kbase/auth2/blob/833e4aed898acc512e1264a4652ca224cd8aa036/README.md#administration as well?

I'm not sure what example you're talking about - can you be more specific?

@MrCreosote
Copy link
Member Author

Is it possible to update this example at https://github.com/kbase/auth2/blob/833e4aed898acc512e1264a4652ca224cd8aa036/README.md#administration as well?

Updated per our OOB conversation

@@ -0,0 +1,66 @@
# Authentication service environments

The auth service can support multiple environments, allowing it to service multiple hosts.
Copy link

Choose a reason for hiding this comment

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

The phrase "multiple hosts" can be a bit ambiguous. Maybe something like multiple UI domains or multiple UI deployments.

Copy link
Member Author

Choose a reason for hiding this comment

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

How about

The auth service can support multiple environments, allowing it to service multiple domains -
for a KBase example, `narrative.kbase.us`, `appdev.kbase.us`, and `narrative-dev.kbase.us`
are all served by the same auth service. This allows sharing user accounts and tokens between
environments and deploying alternate versions of UIs running on the same backend.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated

Copy link

@scanon scanon left a comment

Choose a reason for hiding this comment

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

LGTM. One minor comment but it is optional.

@MrCreosote MrCreosote merged commit 17effe4 into kbase:gavin-inbox Feb 22, 2024
3 checks passed
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.

3 participants