superinit

DISCLAIMER: superinit is a work-in-progess, anticipate issues as this utility is evolves.

superinit is a MacOS command line utility to perform the tasks necessary to interface with an HPE Cray EX Shasta system.

It's primary tasks are to:

• Install the cray and sat CLI, if not found in the $PATH
• Configure cray to initialize itself with a given friendly system name (ex: lemondrop)
• Derive the Platform CA from the API gateway and add it to the MacOS Keychain
• Authenticate cray using a stored value from the MacOS Keychain, or interactively
• Configure sat to use the active cray config and token
• Optionally print a list of Subject Alternate Names from the Platform CA (Web UIs)

Installation

Clone this project and add it to your PATH

git clone https://github.com/alanm-hpe/superinit.git
cd superinit; ./superinit.sh

Usage

To get started, run superinit.sh with no arguments to install cray and sat in python virtual environments:

./superinit.sh

Once complete, add the following to your PATH:

export PATH=${PATH}:$HOME/.config/superinit/cmds/cray_venv/bin
export PATH=${PATH}:$HOME/.config/superinit/cmds/sat_venv/bin

With cray and sat installed, run superinit.sh again and provide the name of a system:

./superinit.sh -s lemondrop

The command will prompt a couple times to approve various activies:

superinit -s lemondrop
Could not find craycli lemondrop configuration. Would you like to create one?
1) Yes
2) No
#? 1
Initialization complete.

cray command not authorized. Authorize with 'cray auth login'?
1) Yes
2) No
#? 1
Read Keychain for cray password?
1) Yes
2) No
#? 1
Success!

If you'd like to let superinit.sh use the MacOS Keychain read your cray password, be sure to add a craycli password to the Keychain. Otherwise select "No" to interactively type your password.

superinit.sh is also able to print a list of Subject Alternate Names (SANs) to list the available Web UI dashboards:

./superinit.sh -s lemondrop -u
alertmanager.cmn.lemondrop.hpc.amslabs.hpecorp.net
ara.cmn.lemondrop.hpc.amslabs.hpecorp.net
argo.cmn.lemondrop.hpc.amslabs.hpecorp.net
cmn.lemondrop.hpc.amslabs.hpecorp.net
csms.cmn.lemondrop.hpc.amslabs.hpecorp.net
grafana.cmn.lemondrop.hpc.amslabs.hpecorp.net
jaeger-istio.cmn.lemondrop.hpc.amslabs.hpecorp.net
kiali-istio.cmn.lemondrop.hpc.amslabs.hpecorp.net
opa-gpm.cmn.lemondrop.hpc.amslabs.hpecorp.net
prometheus.cmn.lemondrop.hpc.amslabs.hpecorp.net
sma-grafana.cmn.lemondrop.hpc.amslabs.hpecorp.net
sma-kibana.cmn.lemondrop.hpc.amslabs.hpecorp.net
vcs.cmn.lemondrop.hpc.amslabs.hpecorp.net

Advanced

To configure your environment further for superinit, consider adding the following to your shell startup once cray and sat are installed:

# Connect sat command to the active cray configuration and authentication.
function superinit_sat {
  export REQUESTS_CA_BUNDLE="/Users/alanm/.config/superinit/$(cat ~/.config/superinit/active_system)/platform-ca-certs.crt"
  $HOME/.config/superinit/cmds/sat_venv/bin/sat --token-file ~/.config/cray/tokens/$(echo $(cray config get core.hostname) | sed -e 's/https:\/\///' -e 's/\./_/g' -e "s/$/.$USER/g") $@
}
alias sat=superinit_sat

# Update PS1 with the active HPE Cray EX Shasta system
parse_supercomputer() {
     active_super=~/.config/superinit/active_system
     if [[ -f $active_super ]]; then cat $active_super 2> /dev/null | sed 's/.*/ (&)/'; fi
}
# Example: \[\033[35m\]\$(parse_supercomputer)\[\033[00m\]

# Auto complete cray and sat command
eval "$(_CRAY_COMPLETE=source_bash cray)"
eval "$(register-python-argcomplete sat)"

# Use json instead of toml for default cray output
export CRAY_FORMAT=json

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is copyrighted by Hewlett Packard Enterprise Development LP and is under the MIT license. See the LICENSE file for details.