Skip to content

Commit a39f7ae

Browse files
committed
[N/A] feat: fix pre install document.
1 parent e30857a commit a39f7ae

2 files changed

Lines changed: 78 additions & 43 deletions

File tree

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ k8s 作为云原生时代的操作系统,学习它的必要性不言而喻,
2828
- [kubernetes tutorials](#kubernetes-tutorials)
2929
- [准备工作](#准备工作)
3030
- [安装 docker](#安装-docker)
31+
- [推荐安装方法](#推荐安装方法)
32+
- [其它安装方法](#其它安装方法)
3133
- [安装 minikube](#安装-minikube)
32-
- [安装 k8s CLI 和 Terminal based UI](#安装-k8s-cli-和-terminal-based-ui)
34+
- [启动 minikube](#启动-minikube)
35+
- [安装 kubectl](#安装-kubectl)
3336
- [注册 docker hub 账号登录](#注册-docker-hub-账号登录)
3437
- [Container](#container)
3538
- [Pod](#pod)
@@ -62,35 +65,49 @@ k8s 作为云原生时代的操作系统,学习它的必要性不言而喻,
6265

6366
## 准备工作
6467

65-
由于我本地环境是 MacOS 11.6.2 Intel 版本,教程也是在本地环境进行。windows 或 linux 环境的小伙伴需要自行安装 docker 和 minikube
68+
在开始本教程之前,需要配置好本地环境,以下是需要安装的依赖和包
6669

6770
### 安装 docker
6871

69-
因为 docker desktop 各种协议和法律问题,已经不建议大家直接安装 desktop 使用,建议只安装 CLI。注意:如果本地已经安装了 docker desktop,那么可以忽略这一步,下一步也可以简化
72+
首先我们需要安装 `docker` 来打包镜像,如果你本地已经安装了 `docker`,那么你可以选择跳过这一小节
7073

71-
```bash
72-
# Install Docker CLI
73-
brew install docker
74-
brew install docker-compose
75-
```
74+
#### 推荐安装方法
75+
76+
目前使用 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 来安装 docker 还是最简单的方案,打开官网下载对应你电脑操作系统的包即可 (https://www.docker.com/products/docker-desktop/),
77+
78+
当安装完成后,可以通过 `docker run hello-world` 来快速校验是否安装成功!
79+
80+
#### 其它安装方法
81+
82+
目前 Docker 公司宣布 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 只对个人开发者或者小型团体免费 (2021年起对大型公司不再免费),所以如果你不能通过 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 的方式下载安装 `docker`,可以参考 [这篇文章](https://dhwaneetbhatt.com/blog/run-docker-without-docker-desktop-on-macos) 只安装 [Docker CLI](https://github.com/docker/cli)
7683

7784
### 安装 minikube
7885

79-
[minikube](https://minikube.sigs.k8s.io/docs/) 用于在本地环境中运行 Kubernetes 集群。在 macOS 上,minikube 可以基于多种虚拟化技术上,可以选择[hyperkit](https://minikube.sigs.k8s.io/docs/drivers/hyperkit/),这里因为我本地之前已经安装过 virtualbox (brew install --cask virtualbox),所以我用的是 virtualbox 虚拟化技术。而且如果你本地之前已经安装了 docker desktop 的话,可以不需要下载 `hyperkit` 或者 `virtualbox`
86+
我们还需要搭建一套 k8s 本地集群 (使用云厂商或者其它 k8s 集群都可) 。本地搭建 k8s 集群的方式推荐使用 [minikube](https://minikube.sigs.k8s.io/docs/)
8087

81-
>注意:如果本地已经安装了 docker desktop,那么可以使用 minikube start --vm-driver docker --container-runtime=docker 来快速启动 minikube
88+
可以根据 [minikube 快速安装](https://minikube.sigs.k8s.io/docs/start/) 来进行下载安装,这里简单列举 MacOS 的安装方式,Linux & Windows 操作系统可以参考[官方文档](https://minikube.sigs.k8s.io/docs/start/) 快速安装。
8289

83-
```bash
84-
# Install hyperkit and minikube (check which vm-driver to use, if install docker desktop already, you can just use vm-driver=docker instead of install hyperkiy)
85-
brew install hyperkit
90+
```shell
8691
brew install minikube
8792
```
8893

89-
```bash
90-
# Start minikube
94+
#### 启动 minikube
95+
96+
因为 minikube 支持很多容器和虚拟化技术 ([Docker](https://minikube.sigs.k8s.io/docs/drivers/docker/), [Hyperkit](https://minikube.sigs.k8s.io/docs/drivers/hyperkit/), [Hyper-V](https://minikube.sigs.k8s.io/docs/drivers/hyperv/), [KVM](https://minikube.sigs.k8s.io/docs/drivers/kvm2/), [Parallels](https://minikube.sigs.k8s.io/docs/drivers/parallels/), [Podman](https://minikube.sigs.k8s.io/docs/drivers/podman/), [VirtualBox](https://minikube.sigs.k8s.io/docs/drivers/virtualbox/), or [VMware Fusion/Workstation](https://minikube.sigs.k8s.io/docs/drivers/vmware/)),也是问题出现比较多的地方,所以这里还是稍微说明一下。
97+
98+
如果你使用 `docker` 的方案是上面推荐的 [Docker Desktop](https://www.docker.com/products/docker-desktop/) ,那么你以下面的命令启动 minikube 即可,需要耐心等待下载依赖。
99+
100+
```shell
101+
minikube start --vm-driver docker --container-runtime=docker
102+
```
103+
104+
启动完成后,运行 `minikube status` 查看当前状态确定是否启动成功!
105+
106+
如果你本地只有 Docker CLI,判断标准如果执行 `docker ps` 等命令,返回错误 `Cannot connect to the Docker daemon at unix:///Users/xxxx/.colima/docker.sock. Is the docker daemon running?` 那么就需要操作下面的命令。
107+
108+
```shell
109+
brew install hyperkit
91110
minikube start --vm-driver hyperkit --container-runtime=docker
92-
# minikube start --vm-driver virtualbox --container-runtime=docker
93-
# minikube start --vm-driver docker --container-runtime=docker
94111

95112
# Tell Docker CLI to talk to minikube's VM
96113
eval $(minikube docker-env)
@@ -102,19 +119,21 @@ echo "`minikube ip` docker.local" | sudo tee -a /etc/hosts > /dev/null
102119
docker run hello-world
103120
```
104121

105-
**minikube Cheatsheet**
122+
**minikube 命令速查**
106123

107124
`minikube stop` 不会删除任何数据,只是停止 VM 和 k8s 集群。
108125

109126
`minikube delete` 删除所有 minikube 启动后的数据。
110127

111-
`minikube ip` 集群和 docker enginer 运行的 IP 地址。
128+
`minikube ip` 查看集群和 docker enginer 运行的 IP 地址。
112129

113-
`minikube pause` 暂停当前的资源和集群
130+
`minikube pause` 暂停当前的资源和 k8s 集群
114131

115132
`minikube status` 查看当前集群状态
116133

117-
### 安装 k8s CLI 和 Terminal based UI
134+
### 安装 kubectl
135+
136+
这一步是可选的,如果不安装的话,后续所有 `kubectl` 相关的命令,使用 `minikube kubectl` 命令替代即可。
118137

119138
如果你不想使用 `minikube kubectl` 或者配置相关环境变量来进行下面的教学的话,可以考虑直接安装 `kubectl`
120139

@@ -124,7 +143,7 @@ brew install kubectl
124143

125144
### 注册 docker hub 账号登录
126145

127-
docker hun(https://hub.docker.com/) 中注册账号,并且使用 login 登录账号
146+
因为默认 minikube 使用的镜像地址是 DockerHub,所以我们还需要在 docker hun(https://hub.docker.com/) 中注册账号,并且使用 login 命令登录账号
128147

129148
```shell
130149
docker login

docs/pre.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,48 @@
11
## 准备工作
22

3-
由于我本地环境是 MacOS 11.6.2 Intel 版本,教程也是在本地环境进行。windows 或 linux 环境的小伙伴需要自行安装 docker 和 minikube
3+
在开始本教程之前,需要配置好本地环境,以下是需要安装的依赖和包
44

55
### 安装 docker
66

7-
因为 docker desktop 各种协议和法律问题,已经不建议大家直接安装 desktop 使用,建议只安装 CLI。注意:如果本地已经安装了 docker desktop,那么可以忽略这一步,下一步也可以简化
7+
首先我们需要安装 `docker` 来打包镜像,如果你本地已经安装了 `docker`,那么你可以选择跳过这一小节
88

9-
```bash
10-
# Install Docker CLI
11-
brew install docker
12-
brew install docker-compose
13-
```
9+
#### 推荐安装方法
10+
11+
目前使用 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 来安装 docker 还是最简单的方案,打开官网下载对应你电脑操作系统的包即可 (https://www.docker.com/products/docker-desktop/),
12+
13+
当安装完成后,可以通过 `docker run hello-world` 来快速校验是否安装成功!
14+
15+
#### 其它安装方法
16+
17+
目前 Docker 公司宣布 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 只对个人开发者或者小型团体免费 (2021年起对大型公司不再免费),所以如果你不能通过 [Docker Desktop](https://www.docker.com/products/docker-desktop/) 的方式下载安装 `docker`,可以参考 [这篇文章](https://dhwaneetbhatt.com/blog/run-docker-without-docker-desktop-on-macos) 只安装 [Docker CLI](https://github.com/docker/cli)
1418

1519
### 安装 minikube
1620

17-
[minikube](https://minikube.sigs.k8s.io/docs/) 用于在本地环境中运行 Kubernetes 集群。在 macOS 上,minikube 可以基于多种虚拟化技术上,可以选择[hyperkit](https://minikube.sigs.k8s.io/docs/drivers/hyperkit/),这里因为我本地之前已经安装过 virtualbox (brew install --cask virtualbox),所以我用的是 virtualbox 虚拟化技术。而且如果你本地之前已经安装了 docker desktop 的话,可以不需要下载 `hyperkit` 或者 `virtualbox`
21+
我们还需要搭建一套 k8s 本地集群 (使用云厂商或者其它 k8s 集群都可) 。本地搭建 k8s 集群的方式推荐使用 [minikube](https://minikube.sigs.k8s.io/docs/)
1822

19-
>注意:如果本地已经安装了 docker desktop,那么可以使用 minikube start --vm-driver docker --container-runtime=docker 来快速启动 minikube
23+
可以根据 [minikube 快速安装](https://minikube.sigs.k8s.io/docs/start/) 来进行下载安装,这里简单列举 MacOS 的安装方式,Linux & Windows 操作系统可以参考[官方文档](https://minikube.sigs.k8s.io/docs/start/) 快速安装。
2024

21-
```bash
22-
# Install hyperkit and minikube (check which vm-driver to use, if install docker desktop already, you can just use vm-driver=docker instead of install hyperkiy)
23-
brew install hyperkit
25+
```shell
2426
brew install minikube
2527
```
2628

27-
```bash
28-
# Start minikube
29+
#### 启动 minikube
30+
31+
因为 minikube 支持很多容器和虚拟化技术 ([Docker](https://minikube.sigs.k8s.io/docs/drivers/docker/), [Hyperkit](https://minikube.sigs.k8s.io/docs/drivers/hyperkit/), [Hyper-V](https://minikube.sigs.k8s.io/docs/drivers/hyperv/), [KVM](https://minikube.sigs.k8s.io/docs/drivers/kvm2/), [Parallels](https://minikube.sigs.k8s.io/docs/drivers/parallels/), [Podman](https://minikube.sigs.k8s.io/docs/drivers/podman/), [VirtualBox](https://minikube.sigs.k8s.io/docs/drivers/virtualbox/), or [VMware Fusion/Workstation](https://minikube.sigs.k8s.io/docs/drivers/vmware/)),也是问题出现比较多的地方,所以这里还是稍微说明一下。
32+
33+
如果你使用 `docker` 的方案是上面推荐的 [Docker Desktop](https://www.docker.com/products/docker-desktop/) ,那么你以下面的命令启动 minikube 即可,需要耐心等待下载依赖。
34+
35+
```shell
36+
minikube start --vm-driver docker --container-runtime=docker
37+
```
38+
39+
启动完成后,运行 `minikube status` 查看当前状态确定是否启动成功!
40+
41+
如果你本地只有 Docker CLI,判断标准如果执行 `docker ps` 等命令,返回错误 `Cannot connect to the Docker daemon at unix:///Users/xxxx/.colima/docker.sock. Is the docker daemon running?` 那么就需要操作下面的命令。
42+
43+
```shell
44+
brew install hyperkit
2945
minikube start --vm-driver hyperkit --container-runtime=docker
30-
# minikube start --vm-driver virtualbox --container-runtime=docker
31-
# minikube start --vm-driver docker --container-runtime=docker
3246

3347
# Tell Docker CLI to talk to minikube's VM
3448
eval $(minikube docker-env)
@@ -40,19 +54,21 @@ echo "`minikube ip` docker.local" | sudo tee -a /etc/hosts > /dev/null
4054
docker run hello-world
4155
```
4256

43-
**minikube Cheatsheet**
57+
**minikube 命令速查**
4458

4559
`minikube stop` 不会删除任何数据,只是停止 VM 和 k8s 集群。
4660

4761
`minikube delete` 删除所有 minikube 启动后的数据。
4862

49-
`minikube ip` 集群和 docker enginer 运行的 IP 地址。
63+
`minikube ip` 查看集群和 docker enginer 运行的 IP 地址。
5064

51-
`minikube pause` 暂停当前的资源和集群
65+
`minikube pause` 暂停当前的资源和 k8s 集群
5266

5367
`minikube status` 查看当前集群状态
5468

55-
### 安装 k8s CLI 和 Terminal based UI
69+
### 安装 kubectl
70+
71+
这一步是可选的,如果不安装的话,后续所有 `kubectl` 相关的命令,使用 `minikube kubectl` 命令替代即可。
5672

5773
如果你不想使用 `minikube kubectl` 或者配置相关环境变量来进行下面的教学的话,可以考虑直接安装 `kubectl`
5874

@@ -62,7 +78,7 @@ brew install kubectl
6278

6379
### 注册 docker hub 账号登录
6480

65-
docker hun(https://hub.docker.com/) 中注册账号,并且使用 login 登录账号
81+
因为默认 minikube 使用的镜像地址是 DockerHub,所以我们还需要在 docker hun(https://hub.docker.com/) 中注册账号,并且使用 login 命令登录账号
6682

6783
```shell
6884
docker login

0 commit comments

Comments
 (0)