English README

免责说明

建议测试过程中使用此方案，生产环境使用请自行考虑评估。
当您对方案需要进一步的沟通和反馈后，可以联系 [email protected] 获得更进一步的支持。
欢迎联系参与方案共建和提交方案需求, 也欢迎在 github 项目issue中留言反馈bugs。

重要通知

随着EKS在China区域的推出，本项目逐步停止维护，计划于2020年10月31日关闭本项目，相关镜像文件将删除。
各位可参考新项目container-mirror使用相关镜像。
即日起，本项目镜像地址有变更，由937788672844.dkr.ecr.cn-north-1.amazonaws.com.cn变更为048912060910.dkr.ecr.cn-north-1.amazonaws.com.cn。

kops-cn项目介绍

本项目用于指导客户使用开源自动化部署工具Kops在AWS宁夏区域或北京区域搭建K8S集群。 本项目已经将K8S集群搭建过程中需要拉取的镜像或文件拉回国内，因此您无需任何翻墙设置。

特性

• 集群创建过程中所需的docker镜像已存放在 北京 区域的Amazon ECR中。
• 集群创建过程中所需的二进制文件或配置文件已存放在 北京 区域的Amazon S3桶中 。
• 简单快速的集群搭建和部署
• 无需任何VPN代理或翻墙设置
• 如有新的Docker镜像拉取需求，您可以创建Github push or pull request,您的request会触发CodeBuild(buildspec-nwcd.yml) 去拉取镜像并存放到AWS cn-north-1 的ECR中。查看： 镜像列表.
• 一个make create-cluster命令即可创建集群

当前版本

现仅提供1.15版本

步骤

1. 下载项目到本地

$ git clone https://github.com/nwcdlabs/kops-cn
$ cd kops-cn

2. 在本机安装kops and kubectl命令行客户端： 安装指导

您也可以直接从以下链接的AWS中国区域的S3桶中下载 kops and kubectl 的二进制文件：

kops_version='1.15.2'
k8s_version='v1.15.10'
#
# for Linux Environment
#
# download kops for linux
$ curl -L https://s3.cn-northwest-1.amazonaws.com.cn/kops-file/fileRepository/kops/$kops_version/linux/amd64/kops -o kops
$ chmod +x $_

# download kubectl for linux
$ curl -L https://s3.cn-northwest-1.amazonaws.com.cn/kops-file/fileRepository/kubernetes-release/release/$k8s_version/bin/linux/amd64/kubectl -o kubectl
$ chmod +x $_

#
# for Mac OS X Environment
#

# download kops for mac os x
$ curl -L https://s3.cn-northwest-1.amazonaws.com.cn/kops-file/fileRepository/kops/$kops_version/darwin/amd64/kops -o kops
$ chmod +x $_

# download kubectl for mac os x
$ curl -L https://s3.cn-northwest-1.amazonaws.com.cn/kops-bjs/fileRepository/kubernetes-release/release/$k8s_version/bin/darwin/amd64/kubectl -o kubectl
$ chmod +x $_


#
# 将kops与kubectl放到$PATH
#
$ sudo mv ./kops /usr/local/bin/
$ sudo mv ./kubectl /usr/local/bin/

#
# 再次确认kops and kubectl是当前稳定版本
#
$ kops version
$ kubectl version

请注意

如果你之前安装过kops客户端或者曾经升级了kops，请再次使用kops version确认kops客户端是否为最新稳定版本，版本不一致可能会造成功能上的问题。

3. 编辑 Makefile文件. 您需要设置如下变量

4. 创建集群

make create-cluster

5. 编辑集群

make edit-cluster

将 spec-nwcd.yml 中内容贴到spec 下并保存退出。

6. 更新集群

make update-cluster

7. 完成

验证

集群的创建大概需要 3-5 分钟时间。之后，使用

kops validate cluster

或是

make validate-cluster

来验证集群是否是 ready状态。

查看集群对外接口信息、版本信息

恭喜您已顺利完成!

最后，您可以这样删除整个集群资源

make delete-cluster

插件安装

• Helm - https://github.com/nwcdlabs/kops-cn/blob/master/doc/Helm.md
• Istio - https://github.com/nwcdlabs/kops-cn/blob/master/doc/Istio.md

FAQ

目前使用什麼AMI，可以使用其他AMI吗？例如CentoOS, Amazon Linux 2等？

目前缺省AMI使用Debian Linux AMI，也是Kops上游的标准AMI(说明), 然而Kops官方并没有直接发布AMI到cn-west-1 and cn-northwest-1(请大家帮顶一下这个issue), 在官方AMI直接发布到这两个China regions之前，我们手动的把AMI透过这里说明的方式取回北京与宁夏Region，需要特别提醒这AMI并不是官方直接发布，建议大家也可以自行透过上面链接的说明，透过这里查找官方现在对应最新的Debian AMI自行取回国内。

除了Debian Linux之外，其他官方支持的AMI理论上也都支持，但也可能存在一些已知的问题，请参考#91 and #96。

集群验证失败?

查看 issue #5

如何SSH上master节点和worker节点 ?

查看 issue #6, 需要注意Debian AMI ssh方式为 ssh admin@IP

我可以把master nodes运行在private subnet吗？如何配置？

参考这个说明:#94

我需要的docker镜像在ECR中不存在.

aws北京区域ECR中的镜像仓库containerRegistry 中的已有镜像见required-images-mirrored.txt, (參考#105)如您在集群创建过程中需要其他镜像, 请您编辑 required-images.txt ，这将会在您的GitHub账户中 fork 一个新的分支，之后您可以提交PR（pull request）。 Merge您的PR会触发CodeBuild 去拉取 required-images.txt 中定义的镜像回ECR库。 数分钟后，您可以看到图标从in progress变为passing

当前状态：

required-images相关文档用途

如何得知required-images.txt在ECR所对应的完整路径？

参考这里

查看所有FAQs 这里