diff --git a/CHANGELOG.md b/CHANGELOG.md index dbd81b160a52..abe7938e8c92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1133,7 +1133,7 @@ Huge Thank You for this release to our contributors: * Added a `minikube dashboard` command to open the Kubernetes Dashboard. * Updated Docker to version 1.11.1. * Updated Kubernetes components to v1.3.0-alpha.5-330-g760c563. -* Generated documentation for all commands. Documentation [is here](https://github.com/kubernetes/minikube/blob/master/docs/minikube.md). +* Generated documentation for all commands. Documentation [is here](https://minikube.sigs.k8s.io/docs/). ## Version 0.2.0 - 6/3/2016 diff --git a/cmd/minikube/cmd/start.go b/cmd/minikube/cmd/start.go index 338b838b009f..2fe85c9a1b85 100644 --- a/cmd/minikube/cmd/start.go +++ b/cmd/minikube/cmd/start.go @@ -686,7 +686,7 @@ func prepareNone(vmDriver string) { out.T(out.Empty, "") out.WarningT("The 'none' driver provides limited isolation and may reduce system security and reliability.") out.WarningT("For more information, see:") - out.T(out.URL, "https://github.com/kubernetes/minikube/blob/master/docs/vmdriver-none.md") + out.T(out.URL, "https://minikube.sigs.k8s.io/docs/reference/drivers/none/") out.T(out.Empty, "") } @@ -749,7 +749,7 @@ func validateNetwork(h *host.Host) string { ipExcluded := proxy.IsIPExcluded(ip) // Skip warning if minikube ip is already in NO_PROXY k = strings.ToUpper(k) // for http_proxy & https_proxy if (k == "HTTP_PROXY" || k == "HTTPS_PROXY") && !ipExcluded && !warnedOnce { - out.WarningT("You appear to be using a proxy, but your NO_PROXY environment does not include the minikube IP ({{.ip_address}}). Please see https://github.com/kubernetes/minikube/blob/master/docs/http_proxy.md for more details", out.V{"ip_address": ip}) + out.WarningT("You appear to be using a proxy, but your NO_PROXY environment does not include the minikube IP ({{.ip_address}}). Please see https://minikube.sigs.k8s.io/docs/reference/networking/proxy/ for more details", out.V{"ip_address": ip}) warnedOnce = true } } diff --git a/hack/conformance_tests.sh b/hack/conformance_tests.sh index eb1564e58ef3..cff11af0a367 100755 --- a/hack/conformance_tests.sh +++ b/hack/conformance_tests.sh @@ -56,7 +56,7 @@ name: minikube version: ${version} website_url: https://github.com/kubernetes/minikube repo_url: https://github.com/kubernetes/minikube -documentation_url: https://github.com/kubernetes/minikube/blob/master/docs/README.md +documentation_url: https://minikube.sigs.k8s.io/docs/ product_logo_url: https://raw.githubusercontent.com/kubernetes/minikube/master/images/logo/logo.svg type: installer description: minikube runs a local Kubernetes cluster on macOS, Linux, and Windows. diff --git a/pkg/drivers/kvm/gpu.go b/pkg/drivers/kvm/gpu.go index 6c9043de5ba7..550846622e66 100644 --- a/pkg/drivers/kvm/gpu.go +++ b/pkg/drivers/kvm/gpu.go @@ -110,7 +110,7 @@ func getPassthroughableNVIDIADevices() ([]string, error) { return []string{}, fmt.Errorf("error reading %q: %v", sysKernelIOMMUGroupsPath, err) } if len(iommuGroups) == 0 { - return []string{}, fmt.Errorf("no IOMMU groups found at %q. Make sure your host supports IOMMU. See instructions at https://github.com/kubernetes/minikube/blob/master/docs/gpu.md", sysKernelIOMMUGroupsPath) + return []string{}, fmt.Errorf("no IOMMU groups found at %q. Make sure your host supports IOMMU. See instructions at https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/", sysKernelIOMMUGroupsPath) } // Get list of PCI devices @@ -146,7 +146,7 @@ func getPassthroughableNVIDIADevices() ([]string, error) { return []string{}, fmt.Errorf("no NVIDIA devices found") } if len(unboundNVIDIADevices) == 0 { - return []string{}, fmt.Errorf("some NVIDIA devices were found but none of them were unbound. See instructions at https://github.com/kubernetes/minikube/blob/master/docs/gpu.md") + return []string{}, fmt.Errorf("some NVIDIA devices were found but none of them were unbound. See instructions at https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/") } // Make sure all the unbound devices are in IOMMU groups that only contain unbound devices. @@ -161,7 +161,7 @@ func getPassthroughableNVIDIADevices() ([]string, error) { } } if len(isolatedNVIDIADevices) == 0 { - return []string{}, fmt.Errorf("some unbound NVIDIA devices were found but they had other devices in their IOMMU group that were bound. See instructoins at https://github.com/kubernetes/minikube/blob/master/docs/gpu.md") + return []string{}, fmt.Errorf("some unbound NVIDIA devices were found but they had other devices in their IOMMU group that were bound. See instructoins at https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/") } return isolatedNVIDIADevices, nil diff --git a/pkg/drivers/none/none.go b/pkg/drivers/none/none.go index dd18634d4ab6..d4078fded3bd 100644 --- a/pkg/drivers/none/none.go +++ b/pkg/drivers/none/none.go @@ -44,7 +44,7 @@ var cleanupPaths = []string{ } // Driver is a driver designed to run kubeadm w/o VM management, and assumes systemctl. -// https://github.com/kubernetes/minikube/blob/master/docs/vmdriver-none.md +// https://minikube.sigs.k8s.io/docs/reference/drivers/none/ type Driver struct { *drivers.BaseDriver *pkgdrivers.CommonDriver diff --git a/pkg/minikube/cluster/cluster.go b/pkg/minikube/cluster/cluster.go index cbf82a9947a1..0e198e0b6ea6 100644 --- a/pkg/minikube/cluster/cluster.go +++ b/pkg/minikube/cluster/cluster.go @@ -414,7 +414,7 @@ func createHost(api libmachine.API, config cfg.MachineConfig) (*host.Host, error if config.VMDriver == constants.DriverVmwareFusion && viper.GetBool(cfg.ShowDriverDeprecationNotification) { out.WarningT(`The vmwarefusion driver is deprecated and support for it will be removed in a future release. Please consider switching to the new vmware unified driver, which is intended to replace the vmwarefusion driver. - See https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver for more information. + See https://minikube.sigs.k8s.io/docs/reference/drivers/vmware/ for more information. To disable this message, run [minikube config set ShowDriverDeprecationNotification false]`) } if !localDriver(config.VMDriver) { diff --git a/pkg/minikube/constants/constants.go b/pkg/minikube/constants/constants.go index b2cbd0680d3b..eea5593fe7fd 100644 --- a/pkg/minikube/constants/constants.go +++ b/pkg/minikube/constants/constants.go @@ -424,5 +424,5 @@ const ( const ( // DriverDocumentation the documentation of the KVM driver - DriverDocumentation = "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md" + DriverDocumentation = "https://minikube.sigs.k8s.io/docs/reference/drivers/" ) diff --git a/pkg/minikube/problem/err_map.go b/pkg/minikube/problem/err_map.go index 1ef7e973654a..ac69ea3d3286 100644 --- a/pkg/minikube/problem/err_map.go +++ b/pkg/minikube/problem/err_map.go @@ -33,7 +33,7 @@ var vmProblems = map[string]match{ "HYPERKIT_NO_IP": { Regexp: re(`IP address never found in dhcp leases file Temporary Error: Could not find an IP address for`), Advice: "Install the latest minikube hyperkit driver, and run 'minikube delete'", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/hyperkit/", Issues: []int{1926, 4206}, }, "VBOX_NOT_FOUND": { @@ -89,12 +89,12 @@ var vmProblems = map[string]match{ "KVM2_NOT_FOUND": { Regexp: re(`Driver "kvm2" not found. Do you have the plugin binary .* accessible in your PATH`), Advice: "Please install the minikube kvm2 VM driver, or select an alternative --vm-driver", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/kvm2/", }, "HYPERKIT_NOT_FOUND": { Regexp: re(`Driver "hyperkit" not found. Do you have the plugin binary .* accessible in your PATH?`), Advice: "Please install the minikube hyperkit VM driver, or select an alternative --vm-driver", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/hyperkit/", }, "KVM2_RESTART_NO_IP": { Regexp: re(`Error starting stopped host: Machine didn't return an IP after 120 seconds`), @@ -104,7 +104,7 @@ var vmProblems = map[string]match{ "KVM2_START_NO_IP": { Regexp: re(`Error in driver during machine creation: Machine didn't return an IP after 120 seconds`), Advice: "Install the latest kvm2 driver and run 'virt-host-validate'", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/kvm2/", Issues: []int{4249, 3566}, }, "KVM2_NETWORK_DEFINE_XML": { @@ -127,17 +127,17 @@ var vmProblems = map[string]match{ "KVM_CONNECTION_ERROR": { Regexp: re(`error connecting to libvirt socket`), Advice: "Have you set up libvirt correctly?", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/kvm2/", }, "DRIVER_CRASHED": { Regexp: re(`Error attempting to get plugin server address for RPC`), Advice: "The VM driver exited with an error, and may be corrupt. Run 'minikube start' with --alsologtostderr -v=8 to see the error", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/", }, "DRIVER_EXITED": { Regexp: re(`Unable to start VM: create: creating: exit status 1`), Advice: "Re-run 'minikube start' with --alsologtostderr -v=8 to see the VM driver error message", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#troubleshooting", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/#troubleshooting", }, "VM_BOOT_FAILED_HYPERV_ENABLED": { Regexp: re(`VirtualBox won't boot a 64bits VM when Hyper-V is activated`), @@ -173,7 +173,7 @@ var vmProblems = map[string]match{ } // proxyDoc is the URL to proxy documentation -const proxyDoc = "https://github.com/kubernetes/minikube/blob/master/docs/http_proxy.md" +const proxyDoc = "https://minikube.sigs.k8s.io/docs/reference/networking/proxy/" // netProblems are network related problems. var netProblems = map[string]match{ @@ -262,7 +262,7 @@ var osProblems = map[string]match{ "SYSTEMCTL_EXIT_1": { Regexp: re(`Failed to enable container runtime: .*sudo systemctl start docker: exit status 1`), Advice: "If using the none driver, ensure that systemctl is installed", - URL: "https://github.com/kubernetes/minikube/blob/master/docs/vmdriver-none.md", + URL: "https://minikube.sigs.k8s.io/docs/reference/drivers/none/", Issues: []int{2704}, }, } diff --git a/site/content/en/_index.html b/site/content/en/_index.html index 12d8977f919a..fbea229abc6d 100644 --- a/site/content/en/_index.html +++ b/site/content/en/_index.html @@ -57,10 +57,10 @@

Highlights

{{< blocks/section color="white" >}} {{% blocks/feature icon="fa-star" title="Developer focused" %}} -- [LoadBalancer emulation](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md) -- [Addons Marketplace](https://github.com/kubernetes/minikube/blob/master/docs/addons.md) -- [Integrated Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md) -- [GPU support](https://github.com/kubernetes/minikube/blob/master/docs/gpu.md) +- [LoadBalancer emulation](https://minikube.sigs.k8s.io/docs/tasks/loadbalancer/) +- [Addons Marketplace](https://minikube.sigs.k8s.io/docs/tasks/addons/) +- [Integrated Dashboard](https://minikube.sigs.k8s.io/docs/tasks/dashboard/) +- [GPU support](https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/) - Reusable Docker daemon {{% /blocks/feature %}} diff --git a/site/content/en/docs/Overview/_index.md b/site/content/en/docs/Overview/_index.md index e173cd330eb7..cd04ee65be72 100644 --- a/site/content/en/docs/Overview/_index.md +++ b/site/content/en/docs/Overview/_index.md @@ -8,25 +8,25 @@ description: > minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. -minikube's [primary goals](https://github.com/kubernetes/minikube/blob/master/docs/contributors/principles.md) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. +minikube's [primary goals](https://minikube.sigs.k8s.io/docs/concepts/principles/) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like: -* [LoadBalancer](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md) - using `minikube tunnel` +* [LoadBalancer](https://minikube.sigs.k8s.io/docs/tasks/loadbalancer/) - using `minikube tunnel` * Multi-cluster - using `minikube start -p ` * NodePorts - using `minikube service` -* [Persistent Volumes](https://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md) +* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/reference/persistent_volumes/) * Ingress * RBAC -* [Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md) - `minikube dashboard` -* [Container runtimes](https://github.com/kubernetes/minikube/blob/master/docs/alternative_runtimes.md) - `start --container-runtime` -* [Configure apiserver and kubelet options](https://github.com/kubernetes/minikube/blob/master/docs/configuring_kubernetes.md) via command-line flags +* [Dashboard](https://minikube.sigs.k8s.io/docs/tasks/dashboard/) - `minikube dashboard` +* [Container runtimes](https://minikube.sigs.k8s.io/docs/reference/runtimes/) - `start --container-runtime` +* [Configure apiserver and kubelet options](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/) via command-line flags As well as developer-friendly features: -* [Addons](https://github.com/kubernetes/minikube/blob/master/docs/addons.md) - a marketplace for developers to share configurations for running services on minikube -* [GPU support](https://github.com/kubernetes/minikube/blob/master/docs/gpu.md) - for machine learning -* [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md) +* [Addons](https://minikube.sigs.k8s.io/docs/tasks/addons/) - a marketplace for developers to share configurations for running services on minikube +* [GPU support](https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/) - for machine learning +* [Filesystem mounts](https://minikube.sigs.k8s.io/docs/tasks/mount/) * Automatic failure analysis ## Why do I want it? diff --git a/site/content/en/docs/Tasks/docker_registry.md b/site/content/en/docs/Tasks/docker_registry.md index fe16b6831d03..a3c08c5ca3b4 100644 --- a/site/content/en/docs/Tasks/docker_registry.md +++ b/site/content/en/docs/Tasks/docker_registry.md @@ -11,11 +11,11 @@ As an alternative to [reusing the Docker daemon](docker_daemon.md), you may enab Steps are as follows: -For illustration purpose, we will assume that minikube VM has one of the ip from `192.168.39.0/24` subnet. If you have not overridden these subnets as per [networking guide](https://github.com/kubernetes/minikube/blob/master/docs/networking.md), you can find out default subnet being used by minikube for a specific OS and driver combination [here](https://github.com/kubernetes/minikube/blob/dfd9b6b83d0ca2eeab55588a16032688bc26c348/pkg/minikube/cluster/cluster.go#L408) which is subject to change. Replace `192.168.39.0/24` with appropriate values for your environment wherever applicable. +For illustration purpose, we will assume that minikube VM has one of the ip from `192.168.39.0/24` subnet. If you have not overridden these subnets as per [networking guide](https://minikube.sigs.k8s.io/docs/reference/networking/), you can find out default subnet being used by minikube for a specific OS and driver combination [here](https://github.com/kubernetes/minikube/blob/dfd9b6b83d0ca2eeab55588a16032688bc26c348/pkg/minikube/cluster/cluster.go#L408) which is subject to change. Replace `192.168.39.0/24` with appropriate values for your environment wherever applicable. Ensure that docker is configured to use `192.168.39.0/24` as insecure registry. Refer [here](https://docs.docker.com/registry/insecure/) for instructions. -Ensure that `192.168.39.0/24` is enabled as insecure registry in minikube. Refer [here](https://github.com/kubernetes/minikube/blob/master/docs/insecure_registry.md) for instructions.. +Ensure that `192.168.39.0/24` is enabled as insecure registry in minikube. Refer [here](https://minikube.sigs.k8s.io/docs/tasks/registry/insecure/) for instructions.. Enable minikube registry addon: diff --git a/site/content/en/docs/Tutorials/openid_connect_auth.md b/site/content/en/docs/Tutorials/openid_connect_auth.md index 121af1281ca6..46fbe28968ef 100644 --- a/site/content/en/docs/Tutorials/openid_connect_auth.md +++ b/site/content/en/docs/Tutorials/openid_connect_auth.md @@ -13,7 +13,7 @@ Read more about OpenID Connect Authentication for Kubernetes here: