diff --git a/RELEASING.md b/RELEASING.md index fe7ef8e9cc..8d40bcab63 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -30,8 +30,6 @@ Investigate and fix any failures. ## Bump the version in the Makefile and Update Docs to reflect this See [this PR](https://github.com/kubernetes/minikube/pull/165) for an example. -Also run `make gendocs` once this change has been made - ##Send an initial commit with the Makefile change: diff --git a/docs/bash-completion b/docs/bash-completion deleted file mode 100644 index b0f9a741b9..0000000000 --- a/docs/bash-completion +++ /dev/null @@ -1,1101 +0,0 @@ - -# Copyright 2016 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# bash completion for minikube -*- shell-script -*- - -__debug() -{ - if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then - echo "$*" >> "${BASH_COMP_DEBUG_FILE}" - fi -} - -# Homebrew on Macs have version 1.3 of bash-completion which doesn't include -# _init_completion. This is a very minimal version of that function. -__my_init_completion() -{ - COMPREPLY=() - _get_comp_words_by_ref "$@" cur prev words cword -} - -__index_of_word() -{ - local w word=$1 - shift - index=0 - for w in "$@"; do - [[ $w = "$word" ]] && return - index=$((index+1)) - done - index=-1 -} - -__contains_word() -{ - local w word=$1; shift - for w in "$@"; do - [[ $w = "$word" ]] && return - done - return 1 -} - -__handle_reply() -{ - __debug "${FUNCNAME[0]}" - case $cur in - -*) - if [[ $(type -t compopt) = "builtin" ]]; then - compopt -o nospace - fi - local allflags - if [ ${#must_have_one_flag[@]} -ne 0 ]; then - allflags=("${must_have_one_flag[@]}") - else - allflags=("${flags[*]} ${two_word_flags[*]}") - fi - COMPREPLY=( $(compgen -W "${allflags[*]}" -- "$cur") ) - if [[ $(type -t compopt) = "builtin" ]]; then - [[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace - fi - - # complete after --flag=abc - if [[ $cur == *=* ]]; then - if [[ $(type -t compopt) = "builtin" ]]; then - compopt +o nospace - fi - - local index flag - flag="${cur%%=*}" - __index_of_word "${flag}" "${flags_with_completion[@]}" - if [[ ${index} -ge 0 ]]; then - COMPREPLY=() - PREFIX="" - cur="${cur#*=}" - ${flags_completion[${index}]} - if [ -n "${ZSH_VERSION}" ]; then - # zfs completion needs --flag= prefix - eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )" - fi - fi - fi - return 0; - ;; - esac - - # check if we are handling a flag with special work handling - local index - __index_of_word "${prev}" "${flags_with_completion[@]}" - if [[ ${index} -ge 0 ]]; then - ${flags_completion[${index}]} - return - fi - - # we are parsing a flag and don't have a special handler, no completion - if [[ ${cur} != "${words[cword]}" ]]; then - return - fi - - local completions - completions=("${commands[@]}") - if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then - completions=("${must_have_one_noun[@]}") - fi - if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then - completions+=("${must_have_one_flag[@]}") - fi - COMPREPLY=( $(compgen -W "${completions[*]}" -- "$cur") ) - - if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then - COMPREPLY=( $(compgen -W "${noun_aliases[*]}" -- "$cur") ) - fi - - if [[ ${#COMPREPLY[@]} -eq 0 ]]; then - declare -F __custom_func >/dev/null && __custom_func - fi - - __ltrim_colon_completions "$cur" -} - -# The arguments should be in the form "ext1|ext2|extn" -__handle_filename_extension_flag() -{ - local ext="$1" - _filedir "@(${ext})" -} - -__handle_subdirs_in_dir_flag() -{ - local dir="$1" - pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 -} - -__handle_flag() -{ - __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" - - # if a command required a flag, and we found it, unset must_have_one_flag() - local flagname=${words[c]} - local flagvalue - # if the word contained an = - if [[ ${words[c]} == *"="* ]]; then - flagvalue=${flagname#*=} # take in as flagvalue after the = - flagname=${flagname%%=*} # strip everything after the = - flagname="${flagname}=" # but put the = back - fi - __debug "${FUNCNAME[0]}: looking for ${flagname}" - if __contains_word "${flagname}" "${must_have_one_flag[@]}"; then - must_have_one_flag=() - fi - - # if you set a flag which only applies to this command, don't show subcommands - if __contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then - commands=() - fi - - # keep flag value with flagname as flaghash - if [ -n "${flagvalue}" ] ; then - flaghash[${flagname}]=${flagvalue} - elif [ -n "${words[ $((c+1)) ]}" ] ; then - flaghash[${flagname}]=${words[ $((c+1)) ]} - else - flaghash[${flagname}]="true" # pad "true" for bool flag - fi - - # skip the argument to a two word flag - if __contains_word "${words[c]}" "${two_word_flags[@]}"; then - c=$((c+1)) - # if we are looking for a flags value, don't show commands - if [[ $c -eq $cword ]]; then - commands=() - fi - fi - - c=$((c+1)) - -} - -__handle_noun() -{ - __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" - - if __contains_word "${words[c]}" "${must_have_one_noun[@]}"; then - must_have_one_noun=() - elif __contains_word "${words[c]}" "${noun_aliases[@]}"; then - must_have_one_noun=() - fi - - nouns+=("${words[c]}") - c=$((c+1)) -} - -__handle_command() -{ - __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" - - local next_command - if [[ -n ${last_command} ]]; then - next_command="_${last_command}_${words[c]//:/__}" - else - if [[ $c -eq 0 ]]; then - next_command="_$(basename "${words[c]//:/__}")" - else - next_command="_${words[c]//:/__}" - fi - fi - c=$((c+1)) - __debug "${FUNCNAME[0]}: looking for ${next_command}" - declare -F $next_command >/dev/null && $next_command -} - -__handle_word() -{ - if [[ $c -ge $cword ]]; then - __handle_reply - return - fi - __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" - if [[ "${words[c]}" == -* ]]; then - __handle_flag - elif __contains_word "${words[c]}" "${commands[@]}"; then - __handle_command - elif [[ $c -eq 0 ]] && __contains_word "$(basename "${words[c]}")" "${commands[@]}"; then - __handle_command - else - __handle_noun - fi - __handle_word -} - -_minikube_addons_configure() -{ - last_command="minikube_addons_configure" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_addons_disable() -{ - last_command="minikube_addons_disable" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_addons_enable() -{ - last_command="minikube_addons_enable" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_addons_list() -{ - last_command="minikube_addons_list" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_addons_open() -{ - last_command="minikube_addons_open" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--format=") - flags+=("--https") - local_nonpersistent_flags+=("--https") - flags+=("--url") - local_nonpersistent_flags+=("--url") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_addons() -{ - last_command="minikube_addons" - commands=() - commands+=("configure") - commands+=("disable") - commands+=("enable") - commands+=("list") - commands+=("open") - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--format=") - local_nonpersistent_flags+=("--format=") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_completion() -{ - last_command="minikube_completion" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_config_get() -{ - last_command="minikube_config_get" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_config_set() -{ - last_command="minikube_config_set" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_config_unset() -{ - last_command="minikube_config_unset" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_config_view() -{ - last_command="minikube_config_view" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--format=") - local_nonpersistent_flags+=("--format=") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_config() -{ - last_command="minikube_config" - commands=() - commands+=("get") - commands+=("set") - commands+=("unset") - commands+=("view") - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_dashboard() -{ - last_command="minikube_dashboard" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--url") - local_nonpersistent_flags+=("--url") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_delete() -{ - last_command="minikube_delete" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_docker-env() -{ - last_command="minikube_docker-env" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--no-proxy") - local_nonpersistent_flags+=("--no-proxy") - flags+=("--shell=") - local_nonpersistent_flags+=("--shell=") - flags+=("--unset") - flags+=("-u") - local_nonpersistent_flags+=("--unset") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_get-k8s-versions() -{ - last_command="minikube_get-k8s-versions" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_ip() -{ - last_command="minikube_ip" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_logs() -{ - last_command="minikube_logs" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--follow") - flags+=("-f") - local_nonpersistent_flags+=("--follow") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_mount() -{ - last_command="minikube_mount" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_service_list() -{ - last_command="minikube_service_list" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--namespace=") - two_word_flags+=("-n") - local_nonpersistent_flags+=("--namespace=") - flags+=("--alsologtostderr") - flags+=("--format=") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_service() -{ - last_command="minikube_service" - commands=() - commands+=("list") - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--format=") - flags+=("--https") - local_nonpersistent_flags+=("--https") - flags+=("--namespace=") - two_word_flags+=("-n") - local_nonpersistent_flags+=("--namespace=") - flags+=("--url") - local_nonpersistent_flags+=("--url") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_ssh() -{ - last_command="minikube_ssh" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_start() -{ - last_command="minikube_start" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--apiserver-name=") - local_nonpersistent_flags+=("--apiserver-name=") - flags+=("--container-runtime=") - local_nonpersistent_flags+=("--container-runtime=") - flags+=("--cpus=") - local_nonpersistent_flags+=("--cpus=") - flags+=("--disk-size=") - local_nonpersistent_flags+=("--disk-size=") - flags+=("--dns-domain=") - local_nonpersistent_flags+=("--dns-domain=") - flags+=("--docker-env=") - local_nonpersistent_flags+=("--docker-env=") - flags+=("--docker-opt=") - local_nonpersistent_flags+=("--docker-opt=") - flags+=("--extra-config=") - local_nonpersistent_flags+=("--extra-config=") - flags+=("--feature-gates=") - local_nonpersistent_flags+=("--feature-gates=") - flags+=("--host-only-cidr=") - local_nonpersistent_flags+=("--host-only-cidr=") - flags+=("--hyperv-virtual-switch=") - local_nonpersistent_flags+=("--hyperv-virtual-switch=") - flags+=("--insecure-registry=") - local_nonpersistent_flags+=("--insecure-registry=") - flags+=("--iso-url=") - local_nonpersistent_flags+=("--iso-url=") - flags+=("--keep-context") - local_nonpersistent_flags+=("--keep-context") - flags+=("--kubernetes-version=") - local_nonpersistent_flags+=("--kubernetes-version=") - flags+=("--kvm-network=") - local_nonpersistent_flags+=("--kvm-network=") - flags+=("--memory=") - local_nonpersistent_flags+=("--memory=") - flags+=("--network-plugin=") - local_nonpersistent_flags+=("--network-plugin=") - flags+=("--registry-mirror=") - local_nonpersistent_flags+=("--registry-mirror=") - flags+=("--vm-driver=") - local_nonpersistent_flags+=("--vm-driver=") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_status() -{ - last_command="minikube_status" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--format=") - local_nonpersistent_flags+=("--format=") - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_stop() -{ - last_command="minikube_stop" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube_version() -{ - last_command="minikube_version" - commands=() - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -_minikube() -{ - last_command="minikube" - commands=() - commands+=("addons") - commands+=("completion") - commands+=("config") - commands+=("dashboard") - commands+=("delete") - commands+=("docker-env") - commands+=("get-k8s-versions") - commands+=("ip") - commands+=("logs") - commands+=("mount") - commands+=("service") - commands+=("ssh") - commands+=("start") - commands+=("status") - commands+=("stop") - commands+=("version") - - flags=() - two_word_flags=() - local_nonpersistent_flags=() - flags_with_completion=() - flags_completion=() - - flags+=("--alsologtostderr") - flags+=("--log_backtrace_at=") - flags+=("--log_dir=") - flags+=("--logtostderr") - flags+=("--show-libmachine-logs") - flags+=("--stderrthreshold=") - flags+=("--use-vendored-driver") - flags+=("--v=") - two_word_flags+=("-v") - flags+=("--vmodule=") - - must_have_one_flag=() - must_have_one_noun=() - noun_aliases=() -} - -__start_minikube() -{ - local cur prev words cword - declare -A flaghash 2>/dev/null || : - if declare -F _init_completion >/dev/null 2>&1; then - _init_completion -s || return - else - __my_init_completion -n "=" || return - fi - - local c=0 - local flags=() - local two_word_flags=() - local local_nonpersistent_flags=() - local flags_with_completion=() - local flags_completion=() - local commands=("minikube") - local must_have_one_flag=() - local must_have_one_noun=() - local last_command - local nouns=() - - __handle_word -} - -if [[ $(type -t compopt) = "builtin" ]]; then - complete -o default -F __start_minikube minikube -else - complete -o default -o nospace -F __start_minikube minikube -fi - -# ex: ts=4 sw=4 et filetype=sh diff --git a/docs/minikube.md b/docs/minikube.md deleted file mode 100644 index 0b461d92d3..0000000000 --- a/docs/minikube.md +++ /dev/null @@ -1,41 +0,0 @@ -## minikube - -Minikube is a tool for managing local Kubernetes clusters. - -### Synopsis - - -Minikube is a CLI tool that provisions and manages single-node Kubernetes clusters optimized for development workflows. - -### Options - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons -* [minikube completion](minikube_completion.md) - Outputs minikube shell completion for the given shell (bash) -* [minikube config](minikube_config.md) - Modify minikube config -* [minikube dashboard](minikube_dashboard.md) - Opens/displays the kubernetes dashboard URL for your local cluster -* [minikube delete](minikube_delete.md) - Deletes a local kubernetes cluster. -* [minikube docker-env](minikube_docker-env.md) - sets up docker env variables; similar to '$(docker-machine env)' -* [minikube get-k8s-versions](minikube_get-k8s-versions.md) - Gets the list of available kubernetes versions available for minikube. -* [minikube ip](minikube_ip.md) - Retrieve the IP address of the running cluster. -* [minikube logs](minikube_logs.md) - Gets the logs of the running localkube instance, used for debugging minikube, not user code. -* [minikube mount](minikube_mount.md) - Mounts the specified directory into minikube. -* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster -* [minikube ssh](minikube_ssh.md) - Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' -* [minikube start](minikube_start.md) - Starts a local kubernetes cluster. -* [minikube status](minikube_status.md) - Gets the status of a local kubernetes cluster. -* [minikube stop](minikube_stop.md) - Stops a running local kubernetes cluster. -* [minikube version](minikube_version.md) - Print the version of minikube. - diff --git a/docs/minikube_addons.md b/docs/minikube_addons.md deleted file mode 100644 index 127a7513d0..0000000000 --- a/docs/minikube_addons.md +++ /dev/null @@ -1,43 +0,0 @@ -## minikube addons - -Modify minikube's kubernetes addons - -### Synopsis - - -addons modifies minikube addons files using subcommands like "minikube addons enable heapster" - -``` -minikube addons SUBCOMMAND [flags] -``` - -### Options - -``` - --format string Go template format string for the addon list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ -For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#AddonListTemplate (default "- {{.AddonName}}: {{.AddonStatus}} -") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube addons configure](minikube_addons_configure.md) - Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list -* [minikube addons disable](minikube_addons_disable.md) - Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list -* [minikube addons enable](minikube_addons_enable.md) - Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list -* [minikube addons list](minikube_addons_list.md) - Lists all available minikube addons as well as there current status (enabled/disabled) -* [minikube addons open](minikube_addons_open.md) - Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list - diff --git a/docs/minikube_addons_configure.md b/docs/minikube_addons_configure.md deleted file mode 100644 index 3582a1ca26..0000000000 --- a/docs/minikube_addons_configure.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube addons configure - -Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list - -### Synopsis - - -Configures the addon w/ADDON_NAME within minikube (example: minikube addons configure registry-creds). For a list of available addons use: minikube addons list - -``` -minikube addons configure ADDON_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - diff --git a/docs/minikube_addons_disable.md b/docs/minikube_addons_disable.md deleted file mode 100644 index 6b21fb4af6..0000000000 --- a/docs/minikube_addons_disable.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube addons disable - -Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list - -### Synopsis - - -Disables the addon w/ADDON_NAME within minikube (example: minikube addons disable dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons disable ADDON_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - diff --git a/docs/minikube_addons_enable.md b/docs/minikube_addons_enable.md deleted file mode 100644 index 0ee825e200..0000000000 --- a/docs/minikube_addons_enable.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube addons enable - -Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list - -### Synopsis - - -Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons enable ADDON_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - diff --git a/docs/minikube_addons_list.md b/docs/minikube_addons_list.md deleted file mode 100644 index 47a2d6795b..0000000000 --- a/docs/minikube_addons_list.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube addons list - -Lists all available minikube addons as well as there current status (enabled/disabled) - -### Synopsis - - -Lists all available minikube addons as well as there current status (enabled/disabled) - -``` -minikube addons list -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - diff --git a/docs/minikube_addons_open.md b/docs/minikube_addons_open.md deleted file mode 100644 index 1894cf1458..0000000000 --- a/docs/minikube_addons_open.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube addons open - -Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list - -### Synopsis - - -Opens the addon w/ADDON_NAME within minikube (example: minikube addons open dashboard). For a list of available addons use: minikube addons list - -``` -minikube addons open ADDON_NAME -``` - -### Options - -``` - --format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - --https Open the addons URL with https instead of http - --url Display the kubernetes addons URL in the CLI instead of opening it in the default browser -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube addons](minikube_addons.md) - Modify minikube's kubernetes addons - diff --git a/docs/minikube_completion.md b/docs/minikube_completion.md deleted file mode 100644 index 467cd9cca4..0000000000 --- a/docs/minikube_completion.md +++ /dev/null @@ -1,45 +0,0 @@ -## minikube completion - -Outputs minikube shell completion for the given shell (bash) - -### Synopsis - - - - Outputs minikube shell completion for the given shell (bash) - - This depends on the bash-completion binary. Example installation instructions: - OS X: - $ brew install bash-completion - $ source $(brew --prefix)/etc/bash_completion - $ minikube completion bash > ~/.minikube-completion - $ source ~/.minikube-completion - Ubuntu: - $ apt-get install bash-completion - $ source /etc/bash-completion - $ source <(minikube completion bash) - - Additionally, you may want to output completion to a file and source in your .bashrc - - -``` -minikube completion SHELL -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_config.md b/docs/minikube_config.md deleted file mode 100644 index 4b0e77313c..0000000000 --- a/docs/minikube_config.md +++ /dev/null @@ -1,59 +0,0 @@ -## minikube config - -Modify minikube config - -### Synopsis - - -config modifies minikube config files using subcommands like "minikube config set vm-driver kvm" -Configurable fields: - - * vm-driver - * v - * cpus - * disk-size - * host-only-cidr - * memory - * log_dir - * kubernetes-version - * iso-url - * WantUpdateNotification - * ReminderWaitPeriodInHours - * WantReportError - * WantReportErrorPrompt - * WantKubectlDownloadMsg - * dashboard - * addon-manager - * kube-dns - * heapster - * ingress - * registry-creds - * default-storageclass - * hyperv-virtual-switch - * use-vendored-driver - -``` -minikube config SUBCOMMAND [flags] -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube config get](minikube_config_get.md) - Gets the value of PROPERTY_NAME from the minikube config file -* [minikube config set](minikube_config_set.md) - Sets an individual value in a minikube config file -* [minikube config unset](minikube_config_unset.md) - unsets an individual value in a minikube config file -* [minikube config view](minikube_config_view.md) - Display values currently set in the minikube config file - diff --git a/docs/minikube_config_get.md b/docs/minikube_config_get.md deleted file mode 100644 index 2e203950ca..0000000000 --- a/docs/minikube_config_get.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube config get - -Gets the value of PROPERTY_NAME from the minikube config file - -### Synopsis - - -Returns the value of PROPERTY_NAME from the minikube config file. Can be overwritten at runtime by flags or environmental variables. - -``` -minikube config get PROPERTY_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube config](minikube_config.md) - Modify minikube config - diff --git a/docs/minikube_config_set.md b/docs/minikube_config_set.md deleted file mode 100644 index f6fd326b42..0000000000 --- a/docs/minikube_config_set.md +++ /dev/null @@ -1,31 +0,0 @@ -## minikube config set - -Sets an individual value in a minikube config file - -### Synopsis - - -Sets the PROPERTY_NAME config value to PROPERTY_VALUE - These values can be overwritten by flags or environment variables at runtime. - -``` -minikube config set PROPERTY_NAME PROPERTY_VALUE -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube config](minikube_config.md) - Modify minikube config - diff --git a/docs/minikube_config_unset.md b/docs/minikube_config_unset.md deleted file mode 100644 index 7fc595b36b..0000000000 --- a/docs/minikube_config_unset.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube config unset - -unsets an individual value in a minikube config file - -### Synopsis - - -unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags or environmental variables - -``` -minikube config unset PROPERTY_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube config](minikube_config.md) - Modify minikube config - diff --git a/docs/minikube_config_view.md b/docs/minikube_config_view.md deleted file mode 100644 index e5d865ad90..0000000000 --- a/docs/minikube_config_view.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube config view - -Display values currently set in the minikube config file - -### Synopsis - - -Display values currently set in the minikube config file. - -``` -minikube config view -``` - -### Options - -``` - --format string Go template format string for the config view output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ -For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}} -") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube config](minikube_config.md) - Modify minikube config - diff --git a/docs/minikube_dashboard.md b/docs/minikube_dashboard.md deleted file mode 100644 index e6a09a61a7..0000000000 --- a/docs/minikube_dashboard.md +++ /dev/null @@ -1,36 +0,0 @@ -## minikube dashboard - -Opens/displays the kubernetes dashboard URL for your local cluster - -### Synopsis - - -Opens/displays the kubernetes dashboard URL for your local cluster - -``` -minikube dashboard -``` - -### Options - -``` - --url Display the kubernetes dashboard in the CLI instead of opening it in the default browser -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_delete.md b/docs/minikube_delete.md deleted file mode 100644 index b45fb97712..0000000000 --- a/docs/minikube_delete.md +++ /dev/null @@ -1,31 +0,0 @@ -## minikube delete - -Deletes a local kubernetes cluster. - -### Synopsis - - -Deletes a local kubernetes cluster. This command deletes the VM, and removes all -associated files. - -``` -minikube delete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_docker-env.md b/docs/minikube_docker-env.md deleted file mode 100644 index e9329c5a5d..0000000000 --- a/docs/minikube_docker-env.md +++ /dev/null @@ -1,38 +0,0 @@ -## minikube docker-env - -sets up docker env variables; similar to '$(docker-machine env)' - -### Synopsis - - -sets up docker env variables; similar to '$(docker-machine env)' - -``` -minikube docker-env -``` - -### Options - -``` - --no-proxy Add machine IP to NO_PROXY environment variable - --shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect - -u, --unset Unset variables instead of setting them -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_get-k8s-versions.md b/docs/minikube_get-k8s-versions.md deleted file mode 100644 index 888b910181..0000000000 --- a/docs/minikube_get-k8s-versions.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube get-k8s-versions - -Gets the list of available kubernetes versions available for minikube. - -### Synopsis - - -Gets the list of available kubernetes versions available for minikube. - -``` -minikube get-k8s-versions -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_ip.md b/docs/minikube_ip.md deleted file mode 100644 index 5405e4d383..0000000000 --- a/docs/minikube_ip.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube ip - -Retrieve the IP address of the running cluster. - -### Synopsis - - -Retrieves the IP address of the running cluster, and writes it to STDOUT. - -``` -minikube ip -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_logs.md b/docs/minikube_logs.md deleted file mode 100644 index affd1b6ce5..0000000000 --- a/docs/minikube_logs.md +++ /dev/null @@ -1,36 +0,0 @@ -## minikube logs - -Gets the logs of the running localkube instance, used for debugging minikube, not user code. - -### Synopsis - - -Gets the logs of the running localkube instance, used for debugging minikube, not user code. - -``` -minikube logs -``` - -### Options - -``` - -f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_mount.md b/docs/minikube_mount.md deleted file mode 100644 index 2e1b9d9b49..0000000000 --- a/docs/minikube_mount.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube mount - -Mounts the specified directory into minikube. - -### Synopsis - - -Mounts the specified directory into minikube. - -``` -minikube mount [flags] MOUNT_DIRECTORY(ex:"/home") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_service.md b/docs/minikube_service.md deleted file mode 100644 index d6f1cdd238..0000000000 --- a/docs/minikube_service.md +++ /dev/null @@ -1,40 +0,0 @@ -## minikube service - -Gets the kubernetes URL(s) for the specified service in your local cluster - -### Synopsis - - -Gets the kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time - -``` -minikube service [flags] SERVICE -``` - -### Options - -``` - --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - --https Open the service URL with https instead of http - -n, --namespace string The service namespace (default "default") - --url Display the kubernetes service URL in the CLI instead of opening it in the default browser -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. -* [minikube service list](minikube_service_list.md) - Lists the URLs for the services in your local cluster - diff --git a/docs/minikube_service_list.md b/docs/minikube_service_list.md deleted file mode 100644 index 3b1b7e8108..0000000000 --- a/docs/minikube_service_list.md +++ /dev/null @@ -1,37 +0,0 @@ -## minikube service list - -Lists the URLs for the services in your local cluster - -### Synopsis - - -Lists the URLs for the services in your local cluster - -``` -minikube service list [flags] -``` - -### Options - -``` - -n, --namespace string The services namespace -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube service](minikube_service.md) - Gets the kubernetes URL(s) for the specified service in your local cluster - diff --git a/docs/minikube_ssh.md b/docs/minikube_ssh.md deleted file mode 100644 index 6a76815dd1..0000000000 --- a/docs/minikube_ssh.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube ssh - -Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' - -### Synopsis - - -Log into or run a command on a machine with SSH; similar to 'docker-machine ssh' - -``` -minikube ssh -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_start.md b/docs/minikube_start.md deleted file mode 100644 index a7260c270e..0000000000 --- a/docs/minikube_start.md +++ /dev/null @@ -1,59 +0,0 @@ -## minikube start - -Starts a local kubernetes cluster. - -### Synopsis - - -Starts a local kubernetes cluster using Virtualbox. This command -assumes you already have Virtualbox installed. - -``` -minikube start -``` - -### Options - -``` - --apiserver-name string The apiserver name which is used in the generated certificate for localkube/kubernetes. This can be used if you want to make the apiserver available from outside the machine (default "minikubeCA") - --container-runtime string The container runtime to be used - --cpus int Number of CPUs allocated to the minikube VM (default 2) - --disk-size string Disk size allocated to the minikube VM (format: [], where unit = b, k, m or g) (default "20g") - --dns-domain string The cluster dns domain name used in the kubernetes cluster - --docker-env stringArray Environment variables to pass to the Docker daemon. (format: key=value) - --docker-opt stringArray Specify arbitrary flags to pass to the Docker daemon. (format: key=value) - --extra-config ExtraOption A set of key=value pairs that describe configuration that may be passed to different components. - The key should be '.' separated, and the first part before the dot is the component to apply the configuration to. - Valid components are: kubelet, apiserver, controller-manager, etcd, proxy, scheduler. - --feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features. - --host-only-cidr string The CIDR to be used for the minikube VM (only supported with Virtualbox driver) (default "192.168.99.1/24") - --hyperv-virtual-switch string The hyperv virtual switch name. Defaults to first found. (only supported with HyperV driver) - --insecure-registry stringSlice Insecure Docker registries to pass to the Docker daemon - --iso-url string Location of the minikube iso (default "https://storage.googleapis.com/minikube/iso/minikube-v0.18.0.iso") - --keep-context This will keep the existing kubectl context and will create a minikube context. - --kubernetes-version string The kubernetes version that the minikube VM will use (ex: v1.2.3) - OR a URI which contains a localkube binary (ex: https://storage.googleapis.com/minikube/k8sReleases/v1.3.0/localkube-linux-amd64) (default "v1.6.0") - --kvm-network string The KVM network name. (only supported with KVM driver) (default "default") - --memory int Amount of RAM allocated to the minikube VM (default 2048) - --network-plugin string The name of the network plugin - --registry-mirror stringSlice Registry mirrors to pass to the Docker daemon - --vm-driver string VM driver is one of: [virtualbox vmwarefusion kvm xhyve hyperv] (default "virtualbox") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_status.md b/docs/minikube_status.md deleted file mode 100644 index 256d250f4d..0000000000 --- a/docs/minikube_status.md +++ /dev/null @@ -1,39 +0,0 @@ -## minikube status - -Gets the status of a local kubernetes cluster. - -### Synopsis - - -Gets the status of a local kubernetes cluster. - -``` -minikube status -``` - -### Options - -``` - --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ -For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "minikubeVM: {{.MinikubeStatus}} -localkube: {{.LocalkubeStatus}} -") -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_stop.md b/docs/minikube_stop.md deleted file mode 100644 index b8d9a46177..0000000000 --- a/docs/minikube_stop.md +++ /dev/null @@ -1,31 +0,0 @@ -## minikube stop - -Stops a running local kubernetes cluster. - -### Synopsis - - -Stops a local kubernetes cluster running in Virtualbox. This command stops the VM -itself, leaving all files intact. The cluster can be started again with the "start" command. - -``` -minikube stop -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/docs/minikube_version.md b/docs/minikube_version.md deleted file mode 100644 index 0fa4fb2f40..0000000000 --- a/docs/minikube_version.md +++ /dev/null @@ -1,30 +0,0 @@ -## minikube version - -Print the version of minikube. - -### Synopsis - - -Print the version of minikube. - -``` -minikube version -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory (default "") - --logtostderr log to standard error instead of files - --show-libmachine-logs Deprecated: To enable libmachine logs, set --v=3 or higher - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - --use-vendored-driver Use the vendored in drivers instead of RPC - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO -* [minikube](minikube.md) - Minikube is a tool for managing local Kubernetes clusters. - diff --git a/test.sh b/test.sh index b35e782d22..e4b600d906 100755 --- a/test.sh +++ b/test.sh @@ -67,21 +67,5 @@ if [[ ! -z ${files} ]]; then exit 1 fi -# Check that cobra docs are up to date -# This is done by generating new docs and then seeing if they are different than the committed docs -echo "Checking help documentation..." -if [[ $(git diff) ]]; then - echo "Skipping help text check because the git state is dirty." -else - make gendocs - files=$(git diff) - if [[ $files ]]; then - echo "Help text is out of date: $files \n Please run \"make gendocs\"\n and make sure that those doc changes are committed" - exit 1 - else - echo "Help text is up to date" - fi -fi - echo "Checking releases.json schema" go run deploy/minikube/schema_check.go