docs(changelog): version 0.2.0 [citest skip]#21
Merged
spetrosi merged 1 commit intolinux-system-roles:mainfrom Oct 2, 2025
Merged
docs(changelog): version 0.2.0 [citest skip]#21spetrosi merged 1 commit intolinux-system-roles:mainfrom
spetrosi merged 1 commit intolinux-system-roles:mainfrom
Conversation
Update changelog and .README.html for version 0.2.0 Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
Reviewer's GuideThis PR updates the project documentation to introduce and document new HPC-related variables and playbook examples in .README.html, and publishes the 0.2.0 release notes in CHANGELOG.md with new features, bug fixes, and CI improvements. Class diagram for new and updated HPC configuration variablesclassDiagram
class HPCConfigVariables {
+bool hpc_update_kernel
+bool hpc_update_all_packages
+bool hpc_install_cuda_driver
+bool hpc_install_cuda_toolkit
+bool hpc_install_hpc_nvidia_nccl
+bool hpc_install_nvidia_fabric_manager
+bool hpc_install_rdma
+bool hpc_install_system_openmpi
+bool hpc_build_openmpi_w_nvidia_gpu_support
+bool hpc_tuning
+bool hpc_manage_firewall
}
class FirewallConfig {
+bool hpc_manage_firewall
+enable firewall service()
+set default zone trusted()
}
class OpenMPIConfig {
+bool hpc_install_system_openmpi
+bool hpc_build_openmpi_w_nvidia_gpu_support
+build requirements: GDRCopy, HPCX, PMIx
}
HPCConfigVariables --> FirewallConfig : manages
HPCConfigVariables --> OpenMPIConfig : configures
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 there - I've reviewed your changes - here's some feedback:
- The .README.html list updates introduce complex nesting; please verify all
- and
- tags are correctly opened and closed to avoid malformed HTML in the TOC.
- The release date in CHANGELOG.md is set to 2025-10-02—please confirm this matches the intended release schedule.
Prompt for AI Agents
Please address the comments from this code review: ## Overall Comments - The .README.html list updates introduce complex nesting; please verify all <ul> and <li> tags are correctly opened and closed to avoid malformed HTML in the TOC. - The release date in CHANGELOG.md is set to 2025-10-02—please confirm this matches the intended release schedule. ## Individual Comments ### Comment 1 <location> `.README.html:382-391` </location> <code_context> +<h2 id="hpc_manage_firewall">hpc_manage_firewall</h2> </code_context> <issue_to_address> **🚨 issue (security):** The firewall configuration may introduce security risks if not properly understood. Please add a warning or best practices section to clarify the risks of setting the default firewall zone to trusted and allowing all connections, particularly for users in cloud environments. </issue_to_address> ### Comment 2 <location> `CHANGELOG.md:11` </location> <code_context> + +- feat: Add improvements from Yaju and Fabio feedback (#13) +- feat: Build gdrcopy, hpcx, and openmpi from source (#17) +- feat: Install system openmpi for usecases that don't need GPUs (#19) + +### Bug Fixes </code_context> <issue_to_address> **suggestion (typo):** Consider changing 'usecases' to 'use cases' for correct spelling. Writing 'use cases' as two words ensures clarity and follows standard usage. ```suggestion - feat: Install system openmpi for use cases that don't need GPUs (#19) ``` </issue_to_address>
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+382
to
+391
| <h2 id="hpc_manage_firewall">hpc_manage_firewall</h2> | ||
| <p>Whether to run the linux-system-roles.firewall role to manage | ||
| Firewall.</p> | ||
| <p>Setting this variable to <code>true</code> does the following:</p> | ||
| <ol type="1"> | ||
| <li>Enable and start the firewall service.</li> | ||
| <li>Configure the default firewall zone to be trusted.</li> | ||
| </ol> | ||
| <p>This, basically, allows all connections. This is a common practice | ||
| with HPC workloads because security is handled by cloud providers.</p> |
There was a problem hiding this comment.
🚨 issue (security): The firewall configuration may introduce security risks if not properly understood.
Please add a warning or best practices section to clarify the risks of setting the default firewall zone to trusted and allowing all connections, particularly for users in cloud environments.
|
|
||
| - feat: Add improvements from Yaju and Fabio feedback (#13) | ||
| - feat: Build gdrcopy, hpcx, and openmpi from source (#17) | ||
| - feat: Install system openmpi for usecases that don't need GPUs (#19) |
There was a problem hiding this comment.
suggestion (typo): Consider changing 'usecases' to 'use cases' for correct spelling.
Writing 'use cases' as two words ensures clarity and follows standard usage.
Suggested change
| - feat: Install system openmpi for usecases that don't need GPUs (#19) | |
| - feat: Install system openmpi for use cases that don't need GPUs (#19) |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Update changelog and .README.html for version 0.2.0
Signed-off-by: Sergei Petrosian spetrosi@redhat.com
Summary by Sourcery
Update documentation and changelog for version 0.2.0 by adding and detailing new configuration variables (kernel updates, package updates, system and source-built OpenMPI, firewall, HPC tuning), refreshing example playbooks, and recording recent feature additions, bug fix, and CI improvements
New Features:
Bug Fixes:
Enhancements:
CI:
Documentation: