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

Shorter cluster service CLI commands #278

Open
sagikazarmark opened this issue Jul 17, 2020 · 0 comments
Open

Shorter cluster service CLI commands #278

sagikazarmark opened this issue Jul 17, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@sagikazarmark
Copy link
Member

Is your feature request related to a problem? Please describe.
Enabling integrated services on a cluster requires long commands:

banzai cluster service monitoring enable

It's also not really visible in the cluster command help: banzai cluster --help

Manage clusters

Usage:
  banzai cluster [command]

Aliases:
  cluster, clusters, c, cl

Available Commands:
  config      Get K8S config
  create      Create a cluster
  delete      Delete a cluster
  get         Get cluster details
  import      Import an existing cluster (EXPERIMENTAL)
  list        List clusters
  node        Work with cluster nodes
  nodepool    Manage node pools
  service     Manage cluster integrated services
  shell       Start a shell or run a command with the cluster configured as kubectl context

Describe the solution you'd like to see
Consider creating an alias for commands, so they can be enabled on the cluster level:

banzai cluster monitoring enable

Describe alternatives you've considered
We could improve the documentation of the cluster command independently:

Manage clusters

Usage:
  banzai cluster [command]

Aliases:
  cluster, clusters, c, cl

Available Cluster Management Commands:
  config      Get K8S config
  create      Create a cluster
  delete      Delete a cluster
  get         Get cluster details
  import      Import an existing cluster (EXPERIMENTAL)
  list        List clusters
  shell       Start a shell or run a command with the cluster configured as kubectl context

Additional Commands:
  node        Work with cluster nodes
  nodepool    Manage node pools
  service     Manage cluster integrated services

Available `service` Commands:
  dns          Manage cluster DNS service
  expiry       Manage cluster Expiry service
  ingress      Manage cluster Ingress service
  list         List active (and pending) integrated services of a cluster
  logging      Manage cluster Logging service
  monitoring   Manage cluster Monitoring service
  securityscan Manage cluster Security scan service
  vault        Manage cluster Vault service

If we decide to move service commands one level up, we should probably separate the documentation similarly.

Additional context

I don't recall the reason why we introduced a new layer for integrated services, could be that we wanted to avoid any possible collision between integrated services and cluster level commands.

@sagikazarmark sagikazarmark added the enhancement New feature or request label Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant