Update admin installation documentation #1035
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis PR updates the admin installation documentation by reorganizing and splitting the installation guides into separate files for bare metal and Docker installations. The changes include updating the changelog to reflect this documentation update. Documentation structure update for admin installationgraph TD;
A[Admin Installation Documentation] -->|Split into| B(Bare Metal Installation Guide);
A -->|Split into| C(Docker Installation Guide);
A -->|Updated| D(Changelog);
B -->|New File| E[install_bare_metal.rst];
C -->|New File| F[install_docker.rst];
D -->|Reflects Update| G[CHANGELOG.md];
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @nedvedba - I've reviewed your changes - here's some feedback:
Overall Comments:
- Please provide a more detailed PR description explaining what specific changes were made to the admin installation documentation and why they were needed. This helps reviewers understand the context and purpose of the changes.
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+63
to
+75
| 1. DATAFED_GLOBUS_APP_SECRET | ||
| 2. DATAFED_GLOBUS_APP_ID | ||
| 3. DATAFED_ZEROMQ_SESSION_SECRET | ||
| 4. DATAFED_ZEROMQ_SYSTEM_SECRET | ||
| 5. DATAFED_DATABASE_PASSWORD | ||
| 6. DATAFED_DATABASE_IP_ADDRESS | ||
| 7. DATAFED_GCS_ROOT_NAME | ||
| 8. DATAFED_GCS_IP | ||
| 9. DATAFED_REPO_ID_AND_DIR | ||
| 10. DATAFED_HOST_COLLECTION_MOUNT | ||
| 11. DATAFED_GLOBUS_SUBSCRIPTION | ||
| 12. DATAFED_GCS_COLLECTION_BASE_PATH | ||
| 13. DATAFED_GCS_COLLECTION_ROOT_PATH |
There was a problem hiding this comment.
suggestion (documentation): Environment variables need descriptions
Consider adding brief descriptions for each environment variable to help users understand their purpose and required values.
1. DATAFED_GLOBUS_APP_SECRET - Secret key for Globus authentication
2. DATAFED_GLOBUS_APP_ID - Application ID from Globus registration
3. DATAFED_ZEROMQ_SESSION_SECRET - ZeroMQ session encryption key
4. DATAFED_ZEROMQ_SYSTEM_SECRET - ZeroMQ system-wide encryption key
5. DATAFED_DATABASE_PASSWORD - Password for database access
6. DATAFED_DATABASE_IP_ADDRESS - IP address of the database server
7. DATAFED_GCS_ROOT_NAME - Root name for Globus Collection Store
8. DATAFED_GCS_IP - IP address of Globus Collection Store
9. DATAFED_REPO_ID_AND_DIR - Repository ID and directory path
10. DATAFED_HOST_COLLECTION_MOUNT - Host collection mount point
11. DATAFED_GLOBUS_SUBSCRIPTION - Globus subscription identifier
12. DATAFED_GCS_COLLECTION_BASE_PATH - Base path for GCS collections
13. DATAFED_GCS_COLLECTION_ROOT_PATH - Root path for GCS collections
| #. Navigate to Add an App > Advanced Registration. | ||
| #. Choose an accurate name for your app, and in the redirects field add the single redirect ``https://localhost/ui/authn`` for development, or your domain/IP for production | ||
| #. Click Add Client Secret and choose a descriptive name. | ||
| #. Take note of the Secret that it generates and the Client UUID of the Globus application and remember them for future steps. |
There was a problem hiding this comment.
issue (documentation): Specify required Globus app permissions
Please document which Globus permissions/scopes need to be configured for the application to function correctly.
| ========== | ||
|
|
||
| If the web server and core server are on different machines you will need to | ||
| ensure that they can communicate, this will require exchanging the public keys |
There was a problem hiding this comment.
suggestion (documentation): Add instructions for key exchange
Please provide specific steps or commands for exchanging public keys between web and core servers.
ensure that they can communicate. This requires copying the public key files between servers:
1. On the web server, copy /opt/datafed/keys/web.pub to the core server
2. On the core server, copy /opt/datafed/keys/core.pub to the web server
3. Place each copied key in the respective /opt/datafed/keys directory
|
Add labels when you create a PR, this one would fall under documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request aims to address #1003
Summary by Sourcery
Documentation: