List the details of all volumes registered in UAS with the cray uas admin config volumes list command. Use this command to obtain the volume_id value of volume, which is required for other UAS administrative commands.
Install and initialize the cray administrative CLI.
List the details of all the volumes registered in UAS.
Print out the list in TOML.
ncn-m001-pit# cray uas admin config volumes list
[[results]]
mount_path = "/lus"
volume_id = "2b23a260-e064-4f3e-bee5-3da8e3664f29"
volumename = "lustre"
[results.volume_description.host_path]
path = "/lus"
type = "DirectoryOrCreate"
[[results]]
mount_path = "/etc/slurm"
volume_id = "53ea3f18-b202-455f-a8ec-79f9463aeb7b"
volumename = "slurm-config"
[results.volume_description.config_map]
name = "slurm-map"
[[results]]
mount_path = "/root/slurm_config/munge"
volume_id = "656aed94-fb5a-4b94-bcb7-19607bd8670f"
volumename = "munge-key"
[results.volume_description.secret]
secret_name = "munge-secret"
[[results]]
mount_path = "/etc/pbs"
volume_id = "7ee2bbe9-6428-43c8-b626-0d2316f3aff8"
volumename = "pbs-config"
[results.volume_description.config_map]
name = "pbs-config"
[[results]]
mount_path = "/opt/forge_license"
volume_id = "99e705a2-9bde-48cf-934d-ae721403d8fa"
volumename = "optforgelicense"
[results.volume_description.host_path]
path = "/opt/forge_license"
type = "DirectoryOrCreate"
[[results]]
mount_path = "/opt/forge"
volume_id = "de224953-f5de-42f4-9d18-638855799dba"
volumename = "opt-forge"
[results.volume_description.host_path]
path = "/opt/forge"
type = "DirectoryOrCreate"
[[results]]
mount_path = "/etc/localtime"
volume_id = "ef4be476-79c4-4b76-a9ba-e6dccf2a16db"
volumename = "timezone"
[results.volume_description.host_path]
path = "/etc/localtime"
type = "FileOrCreate"
Print out the list in YAML format.
ncn-m001-pit# cray uas admin config volumes list --format yaml
- mount_path: /lus
volume_description:
host_path:
path: /lus
type: DirectoryOrCreate
volume_id: 2b23a260-e064-4f3e-bee5-3da8e3664f29
volumename: lustre
- mount_path: /etc/slurm
volume_description:
config_map:
name: slurm-map
volume_id: 53ea3f18-b202-455f-a8ec-79f9463aeb7b
volumename: slurm-config
- mount_path: /root/slurm_config/munge
volume_description:
secret:
secret_name: munge-secret
volume_id: 656aed94-fb5a-4b94-bcb7-19607bd8670f
volumename: munge-key
- mount_path: /etc/pbs
volume_description:
config_map:
name: pbs-config
volume_id: 7ee2bbe9-6428-43c8-b626-0d2316f3aff8
volumename: pbs-config
- mount_path: /opt/forge_license
volume_description:
host_path:
path: /opt/forge_license
type: DirectoryOrCreate
volume_id: 99e705a2-9bde-48cf-934d-ae721403d8fa
volumename: optforgelicense
- mount_path: /opt/forge
volume_description:
host_path:
path: /opt/forge
type: DirectoryOrCreate
volume_id: de224953-f5de-42f4-9d18-638855799dba
volumename: opt-forge
- mount_path: /etc/localtime
volume_description:
host_path:
path: /etc/localtime
type: FileOrCreate
volume_id: ef4be476-79c4-4b76-a9ba-e6dccf2a16db
volumename: timezone
Print out the list in JSON format.
ncn-m001-pit# cray uas admin config volumes list --format json
[
{
"mount_path": "/lus",
"volume_description": {
"host_path": {
"path": "/lus",
"type": "DirectoryOrCreate"
}
},
"volume_id": "2b23a260-e064-4f3e-bee5-3da8e3664f29",
"volumename": "lustre"
},
{
"mount_path": "/etc/slurm",
"volume_description": {
"config_map": {
"name": "slurm-map"
}
},
"volume_id": "53ea3f18-b202-455f-a8ec-79f9463aeb7b",
"volumename": "slurm-config"
},
{
"mount_path": "/root/slurm_config/munge",
"volume_description": {
"secret": {
"secret_name": "munge-secret"
}
},
"volume_id": "656aed94-fb5a-4b94-bcb7-19607bd8670f",
"volumename": "munge-key"
},
{
"mount_path": "/etc/pbs",
"volume_description": {
"config_map": {
"name": "pbs-config"
}
},
"volume_id": "7ee2bbe9-6428-43c8-b626-0d2316f3aff8",
"volumename": "pbs-config"
},
{
"mount_path": "/opt/forge_license",
"volume_description": {
"host_path": {
"path": "/opt/forge_license",
"type": "DirectoryOrCreate"
}
},
"volume_id": "99e705a2-9bde-48cf-934d-ae721403d8fa",
"volumename": "optforgelicense"
},
{
"mount_path": "/opt/forge",
"volume_description": {
"host_path": {
"path": "/opt/forge",
"type": "DirectoryOrCreate"
}
},
"volume_id": "de224953-f5de-42f4-9d18-638855799dba",
"volumename": "opt-forge"
},
{
"mount_path": "/etc/localtime",
"volume_description": {
"host_path": {
"path": "/etc/localtime",
"type": "FileOrCreate"
}
},
"volume_id": "ef4be476-79c4-4b76-a9ba-e6dccf2a16db",
"volumename": "timezone"
}
]
The JSON formatted output can help guide administrators to construct the volume descriptions required to add or update a volume description in UAS. JSON is the required input format for volume descriptions in UAS. Refer to Elements of a UAI for descriptions of mount_path, volume_description, volume_id, and volumename.
Looking at the above output, each volume has a mount_path, volume_description, volume_name and volume_id entry. The mount_path specifies where in the UAI the volume will be mounted.
NOTE: While it is acceptable to have multiple volumes configured in UAS with the same mount_path, any given UAI will fail creation if it has more than one volume specified for a given mount path. If multiple volumes with the same mount path exist in the UAS configuration, all UAIs must be created using UAI classes that specify a workable subset of volumes. A UAI created without a UAI Class under such a UAS configuration will try to use all configured volumes and creation will fail.
The volume_description is the JSON description of the volume, specified as a dictionary with one entry, whose key identifies the kind of Kubernetes volume is described (i.e. host_path, configmap, secret, etc.) whose value is another dictionary containing the Kubernetes volume description itself. See Kubernetes documentation for details on what goes in various kinds of volume descriptions.
The volumename is a string the creator of the volume may chose to describe or name the volume. It must be comprised of only lower case alphanumeric characters and dashes (’-’) and must begin and end with an alphanumeric character. It is used inside the UAI pod specification to identify the volume that is mounted in a given location in a container. It is required and administrators are free to use any name that meets the requirements. Volume names do need to be unique within any given UAI and are far more useful when searching for a volume if they are unique across the UAS configuration.
The volume_id is a unique identifier used to identify the UAS volume when examining, updating or deleting a volume and when linking a volume to a UAI class.