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

CASMCMS-9112: Added two SBPS parameters #5332

Merged
merged 4 commits into from
Sep 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion operations/iuf/workflows/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ the HPC CSM Software Recipe with the existing content in `${ADMIN_DIR}`.

1. Edit the `compute-and-uan-bootprep.yaml` and `management-bootprep.yaml` files to account for any site deviations from the default values. For example:
- Comment out the `slurm-site` CFS configuration layer and uncomment the `pbs-site` CFS configuration layer in `compute-and-uan-bootprep.yaml` if PBS is the preferred workload manager
- Comment out the SBPS `rootfs_provider` and `rootfs_provider_passthrough` parameters and uncomment the CPS `rootfs_provider` and `rootfs_provider_passthrough` parameters, if DVS with CPS is the preferred method to project content.
- Uncomment the `gpu-{{recipe.version}}` CFS configuration layer and `gpu-image` image definition in `compute-and-uan-bootprep.yaml` if the system has GPU hardware
- Comment out any CFS configuration layers in `compute-and-uan-bootprep.yaml` and `management-bootprep.yaml` files for products that are not needed on the system
- Any other changes needed to reflect site preferences
Expand All @@ -59,10 +60,24 @@ the HPC CSM Software Recipe with the existing content in `${ADMIN_DIR}`.
There are comments at the top of the `product_vars.yaml` file that describe the variables and related details. The following are a few examples of `site_vars.yaml` changes:
- Add a `default` section containing a `network_type: "cassini"` entry to designate that Cassini is the desired Slingshot network type to be used when executing CFS configurations later in the workflow
- Add a `suffix` entry to the `default` section to append a string to the names of CFS configuration, image, and BOS session template artifacts created during the workflow to make them easy to identify
- Add a `system-name` entry to the `default` section. The Scalable Boot Projection Service (SBPS) uses this system name as the first part of the domain name. Do not add if not using SBPS.
- See the procedure [Create a Session Template to Boot Compute Nodes with SBPS](../../../operations/boot_orchestration/Create_a_Session_Template_to_Boot_Compute_Nodes_with_SBPS.md#boot-set-rootfs_provider_passthrough-parameter)
for more information.
- If the `docs-csm` RPM is installed on a node, then this page can be found under `/usr/share/doc/csm/operations/boot_orchestration/Create_a_Session_Template_to_Boot_Compute_Nodes_with_SBPS.md`. See the
"Boot set `rootfs_provider_passthrough` parameter" section for more details.
- Otherwise, it can be found under the appropriate release branch in <https://github.com/Cray-HPE/docs-csm>.
- This documentation indicates how to find the `system-name`.
- Add a `site-domain` entry to the `default` section. The Scalable Boot Projection Service (SBPS) uses this domain name as the second part of the domain name. Do not add if not using SBPS.
- See the procedure [Create a Session Template to Boot Compute Nodes with SBPS](../../../operations/boot_orchestration/Create_a_Session_Template_to_Boot_Compute_Nodes_with_SBPS.md#boot-set-rootfs_provider_passthrough-parameter)
for more information.
- If the `docs-csm` RPM is installed on a node, then this page can be found under `/usr/share/doc/csm/operations/boot_orchestration/Create_a_Session_Template_to_Boot_Compute_Nodes_with_SBPS.md`.
See the "Boot set `rootfs_provider_passthrough` parameter"section for more details.
- Otherwise, it can be found under the appropriate release branch in <https://github.com/Cray-HPE/docs-csm>.
- This documentation indicates how to find the `site-domain`.

Additional information on `site_vars.yaml` files can be found in the [Site and recipe variables](../IUF.md#site-and-recipe-variables) and [`update-vcs-config`](../stages/update_vcs_config.md) sections.

1. <create a `site_vars.yaml` file with desired key/value pairs >
1. <create a `site_vars.yaml` file with desired key/value pairs >

2. Ensure the `site_vars.yaml` file contents are formatted correctly. The following text is an example for verification purposes only.

Expand All @@ -78,6 +93,8 @@ the HPC CSM Software Recipe with the existing content in `${ADMIN_DIR}`.
default:
network_type: "cassini"
suffix: "-test01"
system-name: "my-system"
site-domain: "my-site-domain.net"
```

3. Ensure the expected files are present in the admin directory after performing the steps in this section.
Expand All @@ -97,6 +114,9 @@ the HPC CSM Software Recipe with the existing content in `${ADMIN_DIR}`.
./site_vars.yaml
```

SAT will not automatically replace the variables `system-name` and `site-domain` with the values defined in `site_vars.yaml` in the `${ADMIN_DIR}/bootprep/compute-and-uan-bootprep.yaml` file. Therefore, they must
be replaced manually. Use the same directions listed above for finding the values for these variables to populate the `site_vars.yaml` file and use them in the `${ADMIN_DIR}/bootprep/compute-and-uan-bootprep.yaml` file.

Once this step has completed:

- `${ADMIN_DIR}` is populated with `product_vars.yaml`, `site_vars.yaml`, and `sat bootprep` input files
Expand Down