kraken-hpc / krakenctl

krakenctl is a command-line tool for viewing and manipulating running kraken instances.

krakenctl

krakenctl is a command-line tool for viewing and manipulating running kraken instances.

Running

krakenctl is Python3 based. It requires Python >= 3.7.

1. Verify python version (must be >= 3.7):

   $ python3 --version
   Python 3.9.2

2. Install dependencies:

   $ pip3 install pyyaml requests rich
   ...

3. Run

   ./krakenctl.py -h
   usage: krakenctl.py [-h] [-v] [-d] [-i IP_ADDRESS] action ...
   
   positional arguments:
     action                Desired action to perform
       node                Get node details and manipulate node config
       sme                 Control the kraken SME
       runtime             Change kraken runtime settings
   
   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         Provides more details (default: False)
     -d, --debug           Provides details of what krakenctl is doing (default: False)
     -i IP_ADDRESS, --ip IP_ADDRESS
                           IP address of Kraken instance (default: 127.0.0.1:3141)

Running with podman (or docker)

Note: instructions are for podman, but should work for docker as well.

1. Make sure podman is installed and functional.

2. podman pull docker.io/krakenhpc/krakenctl:latest

3. alias krakenctl="podman run --rm -it --network=host krakenctl -i 127.0.0.1:3141"

   Replace 127.0.0.1:3141 with the IP/port for your kraken restapi if it's not running on localhost.

4. Now run it!

      $ krakenctl -h
   usage: krakenctl.py [-h] [-v] [-d] [-i IP_ADDRESS] action ...
   
   positional arguments:
     action                Desired action to perform
       node                Get node details and manipulate node config
       sme                 Control the kraken SME
       runtime             Change kraken runtime settings
   
   optional arguments:
     -h, --help            show this help message and exit
     -v, --verbose         Provides more details (default: False)
     -d, --debug           Provides details of what krakenctl is doing (default: False)
     -i IP_ADDRESS, --ip IP_ADDRESS
                           IP address of Kraken instance (default: 127.0.0.1:3141)

krakenctl's Issues

krakenctl node info only uses IDs instead of nodename

It would be nice if I could query a node's info by its nodename as well as the id.
Currently only id works.

For example krakenctl node info compute01

Add a spec file for RPM building

Add a Dockerfile

This would allow us to deploy on, e.g. RHEL7 systems without worrying about python dependencies.

krakenctl node info <non-existent-id> crashes

When you run krakenctl node info on an ID that does not exist, the tool crashes instead of cleanly telling me that ID is invalid.

Example:
krakenctl node info fake-id123

Traceback (most recent call last):
  File "/krakenctl/krakenctl.py", line 335, in <module>
    main()
  File "/krakenctl/krakenctl.py", line 32, in main
    argument_manager.parse_args()
  File "/krakenctl/argument_manager.py", line 342, in parse_args
    args.func(non_defaults)
  File "/krakenctl/krakenctl.py", line 104, in node_list
    dsc_json = get_url(dsc_url, debug, verbose)
  File "/krakenctl/krakenctl.py", line 169, in get_url
    json = r.json()
  File "/usr/local/lib/python3.8/site-packages/requests/models.py", line 900, in json
    return complexjson.loads(self.text, **kwargs)
  File "/usr/local/lib/python3.8/json/__init__.py", line 357, in loads
    return _default_decoder.decode(s)
  File "/usr/local/lib/python3.8/json/decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/local/lib/python3.8/json/decoder.py", line 355, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Implement updates for single nodes

Implement sme freeze/thaw

Consider restructuring as a python module + krakenctl command?

A multi-file script is hard to install...