dtaas-cli 0.1.5

DTaaS CLI

DTaaS Command Line Interface

This is a command line tool for the INTO-CPS-Association Digital Twins as a Service.

Prerequisite

Please visit and download the DTaaS Software.

The DTaaS service with base users and essential containers should be up and running before using the CLI.

Installation

Simply install using:

We recommend installing this in a virutal environment.

Steps to install:

• Change the working folder:

cd <DTaaS-directory>/cli

• Recommended (for windows) to install this in a virtual environment

python -m venv env
env\Scripts\activate

• To install, simply:

pip install dtaas-cli

Usage

Setup

Setup the dtaas.toml file in the cli directory, edit the fields appropriately.

Add users

To add new users using the CLI, fill in the users.add list in dtaas.toml with the Gitlab instance usernames of the users to be added

Then simply:

dtaas admin user add

Delete users

To delete existing users, fill in the users.delete list in dtaas.toml_ with the Gitlab instance usernames of the users to be deleted.

Then simply:

dtaas admin user delete

Additional Points to Remember

• The base DTaaS system should be up and running before adding/deleting users with the CLI

• The user add CLI will add and start a container for a new user. It can also start a container for an existing user if that container was somehow stopped. It shows a Running status for existing user containers that are already up and running, it doesn't restart them.

• Configure the server-dns in the dtaas.toml file with the domain name of your server. If you want to bring up the server locally, please set this to "localhost".

• user add and user delete CLIs return an error if the add and delete lists in dtaas.toml are empty, respectively.

• Currently the email fields for each user in dtaas.toml are not in use, and are not necessary to fill in. These emails must be configured manually for each user in the docker/