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

Make minikube help output consistent #8036

Merged
merged 3 commits into from
May 7, 2020
Merged

Conversation

tstromberg
Copy link
Contributor

@tstromberg tstromberg commented May 7, 2020

  • Use proper casing of Kubernetes and minikube
  • Make sure that similar commands use similar terminology
  • Make short text more concise
  • Hide "options" subcommand (not helpful)

Fixes #7965

Old

Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows.

Basic Commands:
  start          Starts a local kubernetes cluster
  status         Gets the status of a local kubernetes cluster
  stop           Stops a running local kubernetes cluster
  delete         Deletes a local kubernetes cluster
  dashboard      Access the kubernetes dashboard running within the minikube cluster
  pause          pause containers
  unpause        unpause Kubernetes

Images Commands:
  docker-env     Sets up docker env variables; similar to '$(docker-machine env)'
  podman-env     Sets up podman env variables; similar to '$(podman-machine env)'
  cache          Add or delete an image from the local cache.

Configuration and Management Commands:
  addons         Modify minikube's kubernetes addons
  config         Modify minikube config
  profile        Profile gets or sets the current minikube profile
  update-context Verify the IP address of the running cluster in kubeconfig.

Networking and Connectivity Commands:
  service        Gets the kubernetes URL(s) for the specified service in your local cluster
  tunnel         tunnel makes services of type LoadBalancer accessible on localhost

Advanced Commands:
  mount          Mounts the specified directory into minikube
  ssh            Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'
  kubectl        Run kubectl
  node           Node operations

Troubleshooting Commands:
  ssh-key        Retrieve the ssh identity key path of the specified cluster
  ip             Retrieves the IP address of the running cluster
  logs           Gets the logs of the running instance, used for debugging minikube, not user code.
  update-check   Print current and latest version number
  version        Print the version of minikube
  options        Show a list of global command-line options (applies to all commands).

Other Commands:
  completion     Outputs minikube shell completion for the given shell (bash, zsh or fish)

Use "minikube <command> --help" for more information about a given command.

New

minikube provisions and manages local Kubernetes clusters optimized for development workflows.

Basic Commands:
  start          Starts a local Kubernetes cluster
  status         Gets the status of a local Kubernetes cluster
  stop           Stops a running local Kubernetes cluster
  delete         Deletes a local Kubernetes cluster
  dashboard      Access the Kubernetes dashboard running within the minikube cluster
  pause          pause Kubernetes
  unpause        unpause Kubernetes

Images Commands:
  docker-env     Configure environment to use minikube's Docker daemon
  podman-env     Configure environment to use minikube's Podman daemon
  cache          Add, delete, or push a local image into minikube

Configuration and Management Commands:
  addons         Enable or disable a minikube addon
  config         Modify persistent configuration values
  profile        Get or list the the current profiles (clusters)
  update-context Update kubeconfig in case of an IP or port change

Networking and Connectivity Commands:
  service        Returns a URL to connect to a service
  tunnel         Connect to LoadBalancer services

Advanced Commands:
  mount          Mounts the specified directory into minikube
  ssh            Log into the minikube environment (for debugging)
  kubectl        Run a kubectl binary matching the cluster version
  node           Add, remove, or list additional nodes

Troubleshooting Commands:
  ssh-key        Retrieve the ssh identity key path of the specified cluster
  ip             Retrieves the IP address of the running cluster
  logs           Returns logs to debug a local Kubernetes cluster
  update-check   Print current and latest version number
  version        Print the version of minikube

Other Commands:
  completion     Generate command completion for a shell

Use "minikube <command> --help" for more information about a given command.

Diff

-Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows.
+minikube provisions and manages local Kubernetes clusters optimized for development workflows.
 
 Basic Commands:
-  start          Starts a local kubernetes cluster
-  status         Gets the status of a local kubernetes cluster
-  stop           Stops a running local kubernetes cluster
-  delete         Deletes a local kubernetes cluster
-  dashboard      Access the kubernetes dashboard running within the minikube cluster
-  pause          pause containers
+  start          Starts a local Kubernetes cluster
+  status         Gets the status of a local Kubernetes cluster
+  stop           Stops a running local Kubernetes cluster
+  delete         Deletes a local Kubernetes cluster
+  dashboard      Access the Kubernetes dashboard running within the minikube cluster
+  pause          pause Kubernetes
   unpause        unpause Kubernetes
 
 Images Commands:
-  docker-env     Sets up docker env variables; similar to '$(docker-machine env)'
-  podman-env     Sets up podman env variables; similar to '$(podman-machine env)'
-  cache          Add or delete an image from the local cache.
+  docker-env     Configure environment to use minikube's Docker daemon
+  podman-env     Configure environment to use minikube's Podman daemon
+  cache          Add, delete, or push a local image into minikube
 
 Configuration and Management Commands:
-  addons         Modify minikube's kubernetes addons
-  config         Modify minikube config
-  profile        Profile gets or sets the current minikube profile
-  update-context Verify the IP address of the running cluster in kubeconfig.
+  addons         Enable or disable a minikube addon
+  config         Modify persistent configuration values
+  profile        Get or list the the current profiles (clusters)
+  update-context Update kubeconfig in case of an IP or port change
 
 Networking and Connectivity Commands:
-  service        Gets the kubernetes URL(s) for the specified service in your local cluster
-  tunnel         tunnel makes services of type LoadBalancer accessible on localhost
+  service        Returns a URL to connect to a service
+  tunnel         Connect to LoadBalancer services
 
 Advanced Commands:
   mount          Mounts the specified directory into minikube
-  ssh            Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'
-  kubectl        Run kubectl
-  node           Node operations
+  ssh            Log into the minikube environment (for debugging)
+  kubectl        Run a kubectl binary matching the cluster version
+  node           Add, remove, or list additional nodes
 
 Troubleshooting Commands:
   ssh-key        Retrieve the ssh identity key path of the specified cluster
   ip             Retrieves the IP address of the running cluster
-  logs           Gets the logs of the running instance, used for debugging minikube, not user code.
+  logs           Returns logs to debug a local Kubernetes cluster
   update-check   Print current and latest version number
   version        Print the version of minikube
-  options        Show a list of global command-line options (applies to all commands).
 
 Other Commands:
-  completion     Outputs minikube shell completion for the given shell (bash, zsh or fish)
+  completion     Generate command completion for a shell

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 7, 2020
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 7, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tstromberg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 7, 2020
@codecov-io
Copy link

Codecov Report

Merging #8036 into master will not change coverage.
The diff coverage is 46.66%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #8036   +/-   ##
=======================================
  Coverage   35.78%   35.78%           
=======================================
  Files         143      143           
  Lines        9171     9171           
=======================================
  Hits         3282     3282           
  Misses       5489     5489           
  Partials      400      400           
Impacted Files Coverage Δ
cmd/minikube/cmd/cache.go 22.22% <ø> (ø)
cmd/minikube/cmd/completion.go 0.00% <ø> (ø)
cmd/minikube/cmd/config/addons.go 0.00% <ø> (ø)
cmd/minikube/cmd/config/config.go 10.41% <ø> (ø)
cmd/minikube/cmd/config/profile.go 0.00% <ø> (ø)
cmd/minikube/cmd/dashboard.go 1.98% <ø> (ø)
cmd/minikube/cmd/delete.go 22.13% <ø> (ø)
cmd/minikube/cmd/docker-env.go 49.47% <ø> (ø)
cmd/minikube/cmd/kubectl.go 0.00% <ø> (ø)
cmd/minikube/cmd/logs.go 18.51% <ø> (ø)
... and 28 more

@medyagh medyagh merged commit 294a5c3 into kubernetes:master May 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

root help text inconsistent terminology/capitalization
4 participants