TapisCL-ICICLE 0.2.2

Provide good performance command line user interface for Tapis services hosted on HPC clusters

TapisCLI

Please remember to create an issue in this repository if you encounter any bugs, we will do our best to fix it quick!

Overview

Tapis CLI is designed to provide a simple to use, versatile way to interface with Tapis services hosted on HPC resources. User can either start the app and use it as a traditional command line applications, or pass commands directly from bash. Allows you to work with all major Tapis services: Pods, Systems, Files, and Apps in one place. It can also interface directly with services being hosted on Tapis pods, like Neo4j. Although currently Neo4j is the only 3rd party application it can work with, adding support for Postgres and the like will not be difficult.

Dependencies

• Dependencies are listed here

Installation

Using PyPi

1. pip install TapisCL-ICICLE. Current version 0.0.24
2. python -m TapisCLICICLE

Running Python Code Directly

1. Clone the repository to local machine.
2. python -m pip install -r requirements.txt
3. python cli.py

Operations

Full Terminal Interface:

1. run python -m TapisCLICICLE
2. You will be promted to enter a Tapis service link. You can find this on the Tapis service provider's wesbite usually. If you are working with icicle, this should be icicle.tapis.io
3. the application will then prompt you to choose your authentication method, password, federated, or device code. Which ones are avaiable depends on the tenant in question. If you choose either the 2nd or 3rd option, you will be asked to create a session password to authenticate secure operations.
4. if all went well the console should open. You can run help to see command options
5. to exit the application, run exit. To shut it down, run shutdown. The server automatically shuts down after 25 minutes of inactivity

Bash Command Line:

Alternatively, if you do not want to enter the actual command line environment of the TapisCL-ICICLE application, you can run commands directly from the command line like this:

python -m TapisCLICICLE help -v

this may still ask you for authentication, however once you are logged in once, you do not need to enter your credentials again unless the 5 minute timeout period passes, in which case the application shuts itself off.

Known Issues

Since the application relies heavily on sockets to run properly, when they fail so does the application. If the application crashes frequently, or doesnt start, you should restart your computer, this should fix the issue. If it doesnt however, check the logs.log file, and create an issue on the github repo. The application has known compatibility issues with the WSL vpn due to its reliance on sockets. If you intend to use the application with WSL turn off your VPN. If the application doesnt work and you have a VPN on, turn it off just to make sure.