Create a Config Set from Configuration Worksheets

Provides detailed steps and examples, including a list of "gotchas" when importing configuration worksheets.

This procedure has no prerequisites.
Use this procedure when performing fresh installs, major upgrades, or any time there is a large amount of configuration data to set up. To create a config set from configuration worksheets, use this process:
  1. Generate the worksheets.
  2. Copy the worksheets to a new location on the management node.
  3. Edit the worksheets.
  4. Import the worksheets.
The detailed steps of this procedure show an example of how to create config set p0 of type cle (default) from configuration worksheets.

Note that the cfgset command is run as root.

  1. Generate new worksheets from configuration service packages installed on the system.
    smw# cfgset create --mode prepare p0
  2. Locate the newly generated worksheets and copy them to a new location.
    smw# cfgset show --fields path p0
p0:
  path: /var/opt/cray/imps/config/sets/p0

smw# cp /var/opt/cray/imps/config/sets/p0/worksheets/* /some/edit/location
  3. Edit the worksheets to customize them for this site.
    The system administrator typically distributes them to site staff members with knowledge about the services being configured so that they can edit the worksheets and enter appropriate values. Each worksheet is a YAML file that contains instructions on how to edit it; the basic idea is to locate the settings of interest, uncomment them, and either retain or change the default setting (if provided).
  4. Import the completed worksheets using cfgset update or cfgset create.
    Import the completed worksheets by updating the config set created when the worksheets were generated originally or by creating an entirely new config set. The argument to the --worksheet-path option is a file glob to allow multiple worksheets to be imported in a single create/update operation. Full paths to single worksheets can also be used.
    • Import to the config set created with --mode prepare in step 1.
      smw# cfgset update --worksheet-path '/some/edit/location/*_worksheet.yaml' p0
    • Import to a new config set.
      smw# cfgset create --worksheet-path '/some/edit/location/*_worksheet.yaml' \
 p0-new
    Remember: When importing worksheets using cfgset with the --worksheet-path option,
    • Always add single quote marks around the worksheet path if a wildcard is used (e.g.,*_worksheet.yaml).
    • Do not add mode, state, level, or service options; the configurator ignores them for worksheet import.
    • The type of the config set must match the type of the worksheets being imported.