Quick Start v2.0
Thomas Stromberg
parent
527bbcd4e6
commit
7a9ce4fe52
|
|
@ -3,6 +3,7 @@
|
|||
// minikube colors, taken from the logo
|
||||
$mk-dark: #306EE5;
|
||||
$mk-medium: #1FC3CF;
|
||||
$mk-midlight: #e8f3f3;
|
||||
$mk-light:#C7EAEC;
|
||||
$mk-verydark: darken($mk-dark, 15%);
|
||||
|
||||
|
|
@ -10,9 +11,9 @@ $mk-verydark: darken($mk-dark, 15%);
|
|||
$dark: #403F4C !default;
|
||||
$blue: #72A1E5 !default;
|
||||
$orange: #BA5A31 !default;
|
||||
$gray-100: #f8f9fa !default;
|
||||
$gray-100: #f6f6f8 !default;
|
||||
$gray-200: #eee !default;
|
||||
$gray-300: #dee2e6 !default;
|
||||
$gray-300: #dedeef !default;
|
||||
$gray-400: #ccc !default;
|
||||
$gray-500: #adb5bd !default;
|
||||
$gray-600: #888 !default;
|
||||
|
|
@ -31,7 +32,30 @@ $danger: #ED6A5A !default;
|
|||
$white: #fff !default;
|
||||
$light: $mk-light;
|
||||
$medium: $mk-medium;
|
||||
$spacer: 0.5em;
|
||||
|
||||
body, p {
|
||||
font-family: 'Lora', serif !important;
|
||||
}
|
||||
|
||||
|
||||
h1,h2,h3,h4,h5 {
|
||||
font-family: 'Open Sans', sans-serif !important;
|
||||
}
|
||||
|
||||
.step {
|
||||
margin-top: 2em;
|
||||
font-family: 'Open Sans', sans-serif !important;
|
||||
|
||||
.text-primary {
|
||||
color: $mk-dark !important;
|
||||
}
|
||||
|
||||
.fa-stack {
|
||||
color: $mk-midlight !important;
|
||||
margin-right: 0.4em;
|
||||
}
|
||||
}
|
||||
|
||||
// Navigation bar
|
||||
$navbar-dark-color: $mk-dark;
|
||||
|
|
@ -151,21 +175,35 @@ section.td-box--height-auto {
|
|||
}
|
||||
|
||||
|
||||
|
||||
// Allow code tags to span most of a window length (default is 80%)
|
||||
pre {
|
||||
max-width: 99% !important;
|
||||
font-family: 'Inconsolata', monospace !important;
|
||||
font-size: 12px !important;
|
||||
}
|
||||
|
||||
div.td-content {
|
||||
// Allow code tags to span most of a window length (default is 80%)
|
||||
pre {
|
||||
max-width: 99% !important;
|
||||
}
|
||||
h2 {
|
||||
font-size: 1.4rem !important;
|
||||
font-size: 1.6rem !important;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.3rem !important;
|
||||
}
|
||||
|
||||
.highlight {
|
||||
padding: 0.5em !important;
|
||||
margin-top: 1.25em;
|
||||
margin-bottom: 1.25em;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
// make search bar wider https://www.docsy.dev/docs/adding-content/navigation/#configure-local-search-with-lunr
|
||||
.popover.offline-search-result {
|
||||
background-color: $gray-200 !important;
|
||||
max-width: 460px;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
---
|
||||
title: "Troubleshooting"
|
||||
linkTitle: "Troubleshoot"
|
||||
weight: 20
|
||||
date: 2019-08-01
|
||||
description: >
|
||||
How to troubleshoot minikube issues
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,8 +1,190 @@
|
|||
---
|
||||
title: "Get Started!"
|
||||
title: "minikube start"
|
||||
linkTitle: "Get Started!"
|
||||
weight: 1
|
||||
description: >
|
||||
How to install minikube
|
||||
aliases:
|
||||
- /docs/start
|
||||
---
|
||||
|
||||
minikube is local Kubernetes, focusing on making it easy to learn and develop for Kubernetes.
|
||||
|
||||
All you need is Docker (or similarly compatible) container or a Virtual Machine environment, and Kubernetes is a single command away: `minikube start`
|
||||
|
||||
|
||||
## What you’ll need
|
||||
|
||||
* 2GB of free memory
|
||||
* 20GB of free disk space
|
||||
* Internet connection
|
||||
* Container or virtual machine manager, such as: [Docker]({{<ref "/docs/drivers/docker">}}), [Hyperkit]({{<ref "/docs/drivers/hyperkit">}}), [Hyper-V]({{<ref "/docs/drivers/hyperv">}}), [KVM]({{<ref "/docs/drivers/kvm2">}}), [Parallels]({{<ref "/docs/drivers/parallels">}}), [Podman]({{<ref "/docs/drivers/podman">}}), [VirtualBox]({{<ref "/docs/drivers/virtualbox">}}), or [VMWare]({{<ref "/docs/drivers/vmware">}})
|
||||
|
||||
<h2 class="step"><span class="fa-stack fa-1x"><i class="fa fa-circle fa-stack-2x"></i><strong class="fa-stack-1x text-primary">1</strong></span>Installation</h2>
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Linux" %}}
|
||||
|
||||
For Linux users, we provide 3 easy download options:
|
||||
|
||||
### Binary download
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64
|
||||
sudo install minikube-linux-amd64 /usr/local/bin/minikube
|
||||
```
|
||||
|
||||
### Debian package
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_{{< latest >}}-0_amd64.deb
|
||||
sudo dpkg -i minikube_{{< latest >}}-0_amd64.deb
|
||||
```
|
||||
|
||||
### RPM package
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-{{< latest >}}-0.x86_64.rpm
|
||||
sudo rpm -ivh minikube-{{< latest >}}-0.x86_64.rpm
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
{{% tab "macOS" %}}
|
||||
|
||||
If the [Brew Package Manager](https://brew.sh/) installed:
|
||||
|
||||
```shell
|
||||
brew install minikube
|
||||
```
|
||||
|
||||
Otherwise, download minikube directly:
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64
|
||||
sudo install minikube-darwin-amd64 /usr/local/bin/minikube
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
{{% tab "Windows" %}}
|
||||
|
||||
If the [Chocolatey Package Manager](https://chocolatey.org/) is installed, use it to install minikube:
|
||||
|
||||
```shell
|
||||
choco install minikube
|
||||
```
|
||||
|
||||
Otherwise, download and run the [Windows installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe)
|
||||
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
<h2 class="step"><span class="fa-stack fa-1x"><i class="fa fa-circle fa-stack-2x"></i><strong class="fa-stack-1x text-primary">2</strong></span>Start your cluster</h2>
|
||||
|
||||
From a terminal with administrator access (but not logged in as root), run:
|
||||
|
||||
```shell
|
||||
minikube start
|
||||
```
|
||||
|
||||
If minikube fails to start, see the [drivers page]({{<ref "/docs/drivers">}}) for help setting up a compatible container or virtual-machine manager.
|
||||
|
||||
<h2 class="step"><span class="fa-stack fa-1x"><i class="fa fa-circle fa-stack-2x"></i><strong class="fa-stack-1x text-primary">3</strong></span>Interact with your cluster</h2>
|
||||
|
||||
If you already have kubectl installed, you can now use it to access your shiny new cluster:
|
||||
|
||||
```shell
|
||||
kubectl get po -A
|
||||
```
|
||||
|
||||
Alternatively, minikube can download the appropriate version of kubectl, if you don't mind the double-dashes in the command-line:
|
||||
|
||||
```shell
|
||||
minikube kubectl -- get po -A
|
||||
```
|
||||
|
||||
minikube bundles the Kubernetes Dashboard, allowing you to get easily acclimated to your new environment:
|
||||
|
||||
```shell
|
||||
minikube dashboard
|
||||
```
|
||||
|
||||
<h2 class="step"><span class="fa-stack fa-1x"><i class="fa fa-circle fa-stack-2x"></i><strong class="fa-stack-1x text-primary">4</strong></span>Deploy applications</h2>
|
||||
|
||||
Create a sample deployment and expose it on port 8080:
|
||||
|
||||
```shell
|
||||
kubectl create deployment hello-minikube --image=k8s.gcr.io/echoserver:1.4
|
||||
kubectl expose deployment hello-minikube --type=NodePort --port=8080
|
||||
```
|
||||
|
||||
Find your cluster IP:
|
||||
|
||||
```shell
|
||||
minikube ip
|
||||
```
|
||||
|
||||
Either navigate to <your ip>:8080 in your web browser, or let minikube do it for you:
|
||||
|
||||
```shell
|
||||
minikube service hello-minikube
|
||||
```
|
||||
|
||||
To access a LoadBalancer application, use the "minikube tunnel" feature. Here is an example deployment:
|
||||
|
||||
```shell
|
||||
kubectl create deployment balanced --image=k8s.gcr.io/echoserver:1.4
|
||||
kubectl expose deployment balanced --type=LoadBalancer --port=8081
|
||||
```
|
||||
|
||||
In another window, start the tunnel to create a routable IP for the deployment:
|
||||
|
||||
```shell
|
||||
minikube tunnel
|
||||
```
|
||||
|
||||
Access the application using the "service" command, or your web browser. If you are using macOS, minikube will also forward DNS requests for you: [http://balanced.default.svc.cluster.local:8081/](http://balanced.default.svc.cluster.local:8081/)
|
||||
|
||||
<h2 class="step"><span class="fa-stack fa-1x"><i class="fa fa-circle fa-stack-2x"></i><strong class="fa-stack-1x text-primary">5</strong></span>Manage your cluster</h2>
|
||||
|
||||
Pause Kubernetes without impacting deployed applications:
|
||||
|
||||
```shell
|
||||
minikube pause
|
||||
```
|
||||
|
||||
Halt the cluster:
|
||||
|
||||
```shell
|
||||
minikube stop
|
||||
```
|
||||
|
||||
Increase the default memory limit (requires a restart):
|
||||
|
||||
```shell
|
||||
minikube config set memory 16384
|
||||
```
|
||||
|
||||
Browse the catalog of easily installed Kubernetes services:
|
||||
|
||||
```shell
|
||||
minikube addons list
|
||||
```
|
||||
|
||||
Create a second cluster running an older Kubernetes release:
|
||||
|
||||
```shell
|
||||
minikube start -p aged --kubernetes-version=v1.16.1
|
||||
```
|
||||
|
||||
Delete all of the minikube clusters:
|
||||
|
||||
|
||||
```shell
|
||||
minikube delete --all
|
||||
```
|
||||
|
||||
## Take the next step
|
||||
|
||||
* [The minikube handbook]({{<ref "/docs/handbook">}})
|
||||
* [Community-contributed tutorials]({{<ref "/docs/tutorials">}})
|
||||
* [minikube command reference]({{<ref "/docs/commands">}})
|
||||
* [Contributors guide]({{<ref "/docs/contrib">}})
|
||||
* Take our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A) to share your thoughts 🙏
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
## Getting to know Kubernetes
|
||||
|
||||
Once started, you can use any regular Kubernetes command to interact with your minikube cluster. For example, you can see the pod states by running:
|
||||
|
||||
```shell
|
||||
kubectl get po -A
|
||||
```
|
||||
|
||||
## Increasing memory allocation
|
||||
|
||||
minikube auto-selects the memory size based on your system up to 6000mb. For larger
|
||||
deployments, increase the memory allocation using the `--memory` flag, or make the setting persistent using:
|
||||
|
||||
```shell
|
||||
minikube config set memory 8096
|
||||
```
|
||||
|
||||
## Where to go next?
|
||||
|
||||
Visit the [examples](/docs/examples) page to get an idea of what you can do with minikube.
|
||||
|
||||
📣😀 **Please fill out our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A)** so that we can learn how & why you use minikube, and what improvements we should make. Thank you! 💃🏽🎉
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
---
|
||||
title: "Linux"
|
||||
linkTitle: "Linux"
|
||||
weight: 1
|
||||
aliases:
|
||||
- /docs/start/linux/
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Direct" %}}
|
||||
|
||||
Download and install minikube to /usr/local/bin:
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 \
|
||||
&& sudo install minikube-linux-amd64 /usr/local/bin/minikube
|
||||
```
|
||||
{{% /tab %}}
|
||||
{{% tab "Debian/Ubuntu (deb)" %}}
|
||||
|
||||
Download and install minikube:
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube_{{< latest >}}-0_amd64.deb \
|
||||
&& sudo dpkg -i minikube_{{< latest >}}-0_amd64.deb
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
|
||||
{{% tab "Fedora/Red Hat (rpm)" %}}
|
||||
|
||||
Download and install minikube:
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-{{< latest >}}-0.x86_64.rpm \
|
||||
&& sudo rpm -ivh minikube-{{< latest >}}-0.x86_64.rpm
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
## Driver Setup
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Docker" %}}
|
||||
## Check container support
|
||||
{{% readfile file="/docs/drivers/includes/docker_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% tab "KVM" %}}
|
||||
## Check virtualization support
|
||||
{{% readfile file="/docs/drivers/includes/check_virtualization_linux.inc" %}}
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/kvm2_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "VirtualBox" %}}
|
||||
## Check virtualization support
|
||||
{{% readfile file="/docs/drivers/includes/check_virtualization_linux.inc" %}}
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/virtualbox_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "None (bare-metal)" %}}
|
||||
## Check baremetal support
|
||||
{{% readfile file="/docs/drivers/includes/check_baremetal_linux.inc" %}}
|
||||
|
||||
If you are already running minikube from inside a VM, it is possible to skip the creation of an additional VM layer by using the `none` driver.
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/none_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Podman (experimental)" %}}
|
||||
{{% readfile file="/docs/drivers/includes/podman_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
|
||||
|
||||
{{% /tabs %}}
|
||||
|
||||
{{% readfile file="/docs/start/includes/post_install.inc" %}}
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
---
|
||||
title: "macOS"
|
||||
linkTitle: "macOS"
|
||||
weight: 2
|
||||
aliases:
|
||||
- /docs/start/macos/
|
||||
---
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* macOS 10.12 (Sierra)
|
||||
* A hypervisor such as Hyperkit, Parallels, VirtualBox, or VMware Fusion
|
||||
|
||||
### Installation
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Brew" %}}
|
||||
|
||||
If the [Brew Package Manager](https://brew.sh/) is installed, use it to download and install minikube:
|
||||
|
||||
```shell
|
||||
brew install minikube
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
{{% tab "Direct" %}}
|
||||
|
||||
Download and install minikube to /usr/local/bin:
|
||||
|
||||
```shell
|
||||
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 \
|
||||
&& sudo install minikube-darwin-amd64 /usr/local/bin/minikube
|
||||
```
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
### Upgrading minikube
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Brew" %}}
|
||||
|
||||
If the [Brew Package Manager](https://brew.sh/) is installed, use it to download and upgrade minikube:
|
||||
|
||||
```shell
|
||||
brew update
|
||||
brew upgrade minikube
|
||||
```
|
||||
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
## Hypervisor Setup
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Docker" %}}
|
||||
{{% readfile file="/docs/drivers/includes/docker_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Hyperkit" %}}
|
||||
{{% readfile file="/docs/drivers/includes/hyperkit_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "VirtualBox" %}}
|
||||
{{% readfile file="/docs/drivers/includes/virtualbox_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Parallels" %}}
|
||||
{{% readfile file="/docs/drivers/includes/parallels_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "VMware" %}}
|
||||
{{% readfile file="/docs/drivers/includes/vmware_macos_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "Podman (experimental)" %}}
|
||||
{{% readfile file="/docs/drivers/includes/podman_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% /tabs %}}
|
||||
|
||||
{{% readfile file="/docs/start/includes/post_install.inc" %}}
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
---
|
||||
title: "Windows"
|
||||
linkTitle: "Windows"
|
||||
weight: 3
|
||||
aliases:
|
||||
- /docs/start/windows/
|
||||
---
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* Windows 8 or above
|
||||
* 4GB of RAM
|
||||
|
||||
### Installation
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Direct" %}}
|
||||
Download and run the [minikube installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe)
|
||||
{{% /tab %}}
|
||||
|
||||
{{% tab "Chocolatey" %}}
|
||||
|
||||
If the [Chocolatey Package Manager](https://chocolatey.org/) is installed, use it to install minikube:
|
||||
|
||||
```shell
|
||||
choco install minikube
|
||||
```
|
||||
|
||||
After it has installed, close the current CLI session and reopen it. minikube should have been added to your path automatically.
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
{{% tabs %}}
|
||||
{{% tab "Docker" %}}
|
||||
{{% readfile file="/docs/drivers/includes/docker_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% tab "Hyper-V" %}}
|
||||
|
||||
## Check Hypervisor
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/check_virtualization_windows.inc" %}}
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/hyperv_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% tab "VirtualBox" %}}
|
||||
|
||||
## Check Hypervisor
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/check_virtualization_windows.inc" %}}
|
||||
|
||||
{{% readfile file="/docs/drivers/includes/virtualbox_usage.inc" %}}
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
{{% readfile file="/docs/start/includes/post_install.inc" %}}
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
<!-- start: minikube override head-end partial -->
|
||||
<link href="https://fonts.googleapis.com/css2?family=Inconsolata&family=Lora&family=Open+Sans:wght@600;700&display=swap" rel="stylesheet">
|
||||
<link href="/css/tabs.css" rel="stylesheet">
|
||||
<script src="/js/tabs.js"></script>
|
||||
<!-- end: minikube override head-end partial -->
|
||||
<!-- end: minikube override head-end partial -->
|
||||
|
|
@ -12,25 +12,26 @@ div.code-tabs li.nav-tab {
|
|||
float: left;
|
||||
text-align: center;
|
||||
text-decoration: none;
|
||||
color: #666;
|
||||
color: #444;
|
||||
font-size: 14px;
|
||||
font-family: 'Open Sans', sans-serif;
|
||||
|
||||
border-top: 1px solid #C7EAEC;
|
||||
border-left: 1px solid #C7EAEC;
|
||||
border-right: 1px solid #C7EAEC;
|
||||
border-top: 1px solid #ccc;
|
||||
border-left: 1px solid #ccc;
|
||||
border-right: 1px solid #ccc;
|
||||
margin-right: 0.5em;
|
||||
|
||||
border-top-left-radius: 4px;
|
||||
border-top-right-radius: 4px;
|
||||
background-color: #c7eaec;
|
||||
background-color: #dededf;
|
||||
}
|
||||
|
||||
div.code-tabs li.active {
|
||||
color: #f2771a;
|
||||
border-top: 1px solid #C7EAEC;
|
||||
border-left: 1px solid #C7EAEC;
|
||||
border-right: 1px solid #C7EAEC;
|
||||
background: rgb(244, 255, 255);
|
||||
border-top: 1px solid #ccc;
|
||||
border-left: 1px solid #ccc;
|
||||
border-right: 1px solid #ccc;
|
||||
background: #f6f6f8;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
|
|
@ -39,6 +40,11 @@ div.code-tabs a.nav-tab {
|
|||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.code-tabs div.highlight {
|
||||
border: 1px solid #ccc;
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
div.tab-pane {
|
||||
display: none;
|
||||
margin-bottom: 3rem;
|
||||
|
|
@ -47,8 +53,8 @@ div.tab-pane {
|
|||
div.tab-pane.active {
|
||||
display: block;
|
||||
padding: 2em;
|
||||
background: rgb(244, 255, 255);
|
||||
border: 1px solid #C7EAEC;
|
||||
background: #f6f6f8;
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
div.code-tabs code {
|
||||
|
|
|
|||
Loading…
Reference in New Issue