Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(jans-linux-setup): add a top-level wrapper command for convenience #8697

Closed
ossdhaval opened this issue Jun 12, 2024 Discussed in #8616 · 0 comments · Fixed by #8737
Closed

feat(jans-linux-setup): add a top-level wrapper command for convenience #8697

ossdhaval opened this issue Jun 12, 2024 Discussed in #8616 · 0 comments · Fixed by #8737
Assignees
Labels
area-documentation Documentation needs to change as part of issue or PR comp-jans-cli-tui Component affected by issue or PR comp-jans-linux-setup Component affected by issue or PR kind-enhancement Issue or PR is an enhancement to an existing functionality kind-feature Issue or PR is a new feature request

Comments

@ossdhaval
Copy link
Contributor

Discussed in #8616

Originally posted by ossdhaval May 31, 2024
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?

@ossdhaval ossdhaval added kind-enhancement Issue or PR is an enhancement to an existing functionality area-documentation Documentation needs to change as part of issue or PR comp-jans-cli-tui Component affected by issue or PR labels Jun 12, 2024
@ossdhaval ossdhaval changed the title A top-level wrapper command for convenience feat(jand-cli): add a top-level wrapper command for convenience Jun 12, 2024
@mo-auto mo-auto added the kind-feature Issue or PR is a new feature request label Jun 12, 2024
@devrimyatar devrimyatar changed the title feat(jand-cli): add a top-level wrapper command for convenience feat(jans-linux-setup): add a top-level wrapper command for convenience Jun 19, 2024
@mo-auto mo-auto added the comp-jans-linux-setup Component affected by issue or PR label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-jans-cli-tui Component affected by issue or PR comp-jans-linux-setup Component affected by issue or PR kind-enhancement Issue or PR is an enhancement to an existing functionality kind-feature Issue or PR is a new feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants