Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@pixiake
pixiake committed Aug 15, 2019
1 parent d12a003 commit 2b84fd4
Showing 1 changed file with 42 additions and 28 deletions.
70 changes: 42 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
# KubeSphere Installer

    该项目支持在已有kubernetes集群之上部署[KubeSphere](https://kubesphere.io/)。

Requirements
------------
- **kubernetes version > 1.13.0**
- **helm version > 2.10.0**
- **kubernetes version: 1.13.0+**
- **helm version: 2.10.0+**
- **a default storage class must be in kubernetes cluster**
> 注：请确保集群中剩余可用内存 >16G
> 注：请确保集群中剩余可用内存 >10G
Deploy
------------
1. 集群中创建名为kubesphere-system和kubesphere-monitoring-system的namespace
```
kubectl create ns kubesphere-system
kubectl create ns kubesphere-monitoring-system
cat <<EOF | kubectl create -f -
---
apiVersion: v1
kind: Namespace
metadata:
name: kubesphere-system
---
apiVersion: v1
kind: Namespace
metadata:
name: kubesphere-monitoring-system
EOF
```
2. 创建集群ca证书secret
>注：按照当前集群ca.crt和ca.key证书路径创建（kubeadm创建集群的证书路径一般为/etc/kubernetes/pki）
```
kubectl -n kubesphere-system create secret generic kubesphere-ca \
--from-file=ca.crt=/etc/kubernetes/ssl/ca.crt \
--from-file=ca.key=/etc/kubernetes/ssl/ca.key
--from-file=ca.crt=/etc/kubernetes/pki/ca.crt \
--from-file=ca.key=/etc/kubernetes/pki/ca.key
```
3. 创建etcd证书secret
>注：以集群实际etcd证书位置创建；若etcd没有配置证书，则创建空secret
Expand All @@ -34,19 +46,38 @@ Deploy
kubectl -n kubesphere-monitoring-system create secret generic kube-etcd-client-certs
```

4. 部署installer job
4. 部署
```
cd deploy
vim kubesphere-installer.yaml ## 根据参数说明编辑kubesphere-installer.yaml中kubesphere-config为当前集群参数信息。（若etcd无证书，设置etcd_tls_enable: False）
vim kubesphere.yaml ## 根据参数说明编辑kubesphere.yaml中kubesphere-config为当前集群参数信息。（若etcd无证书，设置etcd_tls_enable: False）
kubectl apply -f kubesphere-installer.yaml
kubectl apply -f kubesphere.yaml
```
5. 部署日志查看
```
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l job-name=kubesphere-installer -o jsonpath='{.items[0].metadata.name}') -f
```


Configuration
------------
| Parameter | Description | Default |
| ------------------------------------ | ------------------------------------------------ |---------------------------------------- |
| kube_apiserver_host | 当前集群kube-apiserver地址（ip:port） | |
| etcd_tls_enable | 是否开启etcd TLS证书认证（True / False） | True |
| etcd_endpoint_ips | etcd地址，如etcd为集群，地址以逗号分离（如：192.168.0.7,192.168.0.8,192.168.0.9） | |
| etcd_port | etcd端口 (默认2379，如使用其它端口，请配置此参数) | 2379 |
| disableMultiLogin | 是否关闭多点登录 （True / False） | True |
| elk_prefix | 日志索引 | logstash |
| keep_log_days | 日志留存时间（天） | 7 |
| metrics_server_enable | 是否安装metrics_server （True / False） | True
| istio_enable | 是否安装istio （True / False） | True
| containersLogMountedPath（可选） | 容器日志挂载路径 | “”
| external_es_url（可选） | 外部es地址，支持对接外部es用 | |
| external_es_port（可选） | 外部es端口，支持对接外部es用 | |
| local_registry (离线部署使用) | 离线部署时，对接本地仓库 （使用该参数需将安装镜像使用scripts/download-docker-images.sh导入本地仓库中） | |

离线部署
------------
1. 下载镜像包并解压
Expand All @@ -73,21 +104,4 @@ Deploy
```
sed -i 's|kubespheredev/ks-installer:advanced-2.0.2|192.168.1.2:5000/kubespheredev/ks-installer:advanced-2.0.2|g' deploy/kubesphere-installer.yaml
```
5. 按Deploy中步骤执行安装

Configuration
------------
| Parameter | Description | Default |
| ------------------------------------ | ------------------------------------------------ | ------------------------------------------------------- |
| kube_apiserver_host | 当前集群kube-apiserver地址（ip:port） | |
| etcd_tls_enable | 是否开启etcd TLS证书认证（True / False） | True |
| etcd_endpoint_ips | etcd地址，如etcd为集群，地址以逗号分离（如：192.168.0.7,192.168.0.8,192.168.0.9） | |
| disableMultiLogin | 是否关闭多点登录 （True / False） | True |
| elk_prefix | 日志索引 | logstash |
| keep_log_days | 日志留存时间（天） | 7 |
| metrics_server_enable | 是否安装metrics_server （True / False） | True
| istio_enable | 是否安装istio （True / False） | True
| containersLogMountedPath（可选） | 容器日志挂载路径 | “”
| external_es_url（可选） | 外部es地址，支持对接外部es用 | |
| external_es_port（可选） | 外部es端口，支持对接外部es用 | |
| local_registry (离线部署使用) | 离线部署时，对接本地仓库 （使用该参数需将安装镜像使用scripts/download-docker-images.sh导入本地仓库中） | |
5. 按Deploy中步骤执行安装

0 comments on commit 2b84fd4

Please sign in to comment.