A top-level wrapper command for convenience

[ossdhaval]

The most frequent commands used by Janssen Server users/admins involve commands which needs users to either remember the path or parameters. This can be greatly simplified if we add few wrapper commands which are easy to invoke.

For instance,

• to invoke jans-cli, the admin has to remember where the script is: /opt/jans/jans-cli/config-cli.py. It would be a lot simpler to invoke something like jans cli
• to get the status of services, the command is sudo systemctl list-units --all "jans*". Instead, it is much simpler to invoke jans status

I propose to add a jans command as a top level command using which other subcommand can be easily invoked.

For example:

Simply invoking jans would show help content like below:

Usage:  jans [OPTIONS] COMMAND

Common Commands:
  status      Show status of Janssen Server module services
  cli            invokes jans-cli
  tui           invokes jans text based user interface
  version   shows version of currently installed Janssen Server
  logs        Shows the log file paths for various Janssen Server modules
  start        Starts services for Janssen Server ( -service=<service-name> if you want to start just one specific service)
  stop        Stops services for Janssen Server ( -service=<service-name> if you want to stop just one specific service)
  restart     restarts services for Janssen Server ( -service=<service-name> if you want to restart just one specific service)
  health     gets output from Janssen `health-check` endpoint
  info         lists important URLs (like .well-known, Casa etc)

jans command basically makes information available on users finger tips. And all they have to remember is one command jans.

What do you think?

[manojs1978]

it will be good if we have such shorts/commands from users perspective.

[devrimyatar]

I like the idea. May be other developers can help extending the list.

[moabu]

The wrapper is meant to be for the linux based installation only.

[ossdhaval]

@moabu You mean it'll be only useful on vm installs and not in cloud native?

[moabu]

yes. This has no meaning in Cloud installations. If people install using kubernetes they already have kubectl. Plus this is more suited for a one setup structure.

[ossdhaval]

Hi @devrimyatar I think we all agree that this feature is going to be useful if implemented. I am creating an issue to track it.