Skip to content

Commit

Permalink
chore(docs): update docs for cilium (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
@muzi502
muzi502 authored Sep 13, 2021
1 parent a42994f commit 03e3896
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 22 deletions.
36 changes: 25 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
| autoscaler | 1.8.3 | DNS auto scaling |
| coredns | v1.8.0 | cluster DNS service |
| flannel | v0.14.0 | flannel |
| cilium | v1.9.10 | cilium |
| nginx | 1.19 | reverse proxy of APIserver |
| canal | calico/flannel | calico and flannel intergration |
| helm | v3.6.3 | helm CLI tool |
Expand Down Expand Up @@ -304,17 +305,21 @@ inventory: |

The following default parameters are not recommended to be modified without special requirements, just leave them as default. Unmodified `ntp_server` value will be overrided by `internal_ip` from compose section; `registry_ip` and `offline_resources_url` are automatically generated based on the parameters in compose section thus not need to modify.

| parameter | description | example |
| ------------------------- | ------------------------------------------------------------ | :-----: |
| ntp_server | ntp clock synchronization server domain or IP | - |
| registry_ip | registry IP | - |
| offline_resources_url | URL address for downloading offline resources | - |
| offline_resources_enabled | whether to deploy offline | true |
| generate_domain_crt | whether to generate self-signed certificate for mirror repository domain | true |
| image_repository | repo or project of image registry | library |
| registry_https_port | port of registry，PUSH operation disabled | 443 |
| registry_push_port | port of registry for PUSH | 5000 |
| download_container | whether to pull images of all components under all nodes | false |
| parameter | description | example |
| ----------------------------- | ------------------------------------------------------------ | :-----: |
| ntp_server | ntp clock synchronization server domain or IP | - |
| registry_ip | registry IP | - |
| offline_resources_url | URL address for downloading offline resources | - |
| offline_resources_enabled | whether to deploy offline | true |
| generate_domain_crt | whether to generate self-signed certificate for mirror repository domain | true |
| image_repository | repo or project of image registry | library |
| registry_https_port | port of registry，PUSH operation disabled | 443 |
| registry_push_port | port of registry for PUSH | 5000 |
| download_container | whether to pull images of all components under all nodes | false |
| cilium_enable_hubble | enable support hubble in cilium | false |
| cilium_hubble_install | install hubble-relay, hubble-ui | false |
| cilium_hubble_tls_generate | install hubble-certgen and generate certificates | false |
| cilium_kube_proxy_replacement | Kube Proxy Replacement mode (strict/probe/partial) | probe |

```yaml
default:
Expand All @@ -339,6 +344,15 @@ default:
registry_push_port: 5000
# Set false to disable download all container images on all nodes
download_container: false
# enable support hubble in cilium
cilium_enable_hubble: false
# install hubble-relay, hubble-ui
cilium_hubble_install: false
# install hubble-certgen and generate certificates
cilium_hubble_tls_generate: false
# Kube Proxy Replacement mode (strict/probe/partial)
cilium_kube_proxy_replacement: probe
```

### Deploy a new cluster
Expand Down
34 changes: 23 additions & 11 deletions README_zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -296,17 +296,21 @@ inventory: |

以下几个默认的参数在没有特殊要求的情况下不建议修改，直接保持默认即可。`ntp_server` 参数为默认值时会自动替换成 compose 中的 `internal_ip` 值；`registry_ip` 和 `offline_resources_url` 这两个参数会根据 compose 中的参数自动生成无需修改。

| 参数 | 说明 | 示例 |
| ------------------------- | ---------------------------------------- | :-----: |
| ntp_server | ntp 时钟同步服务器域名或 IP | - |
| registry_ip | 镜像仓库节点 IP | - |
| offline_resources_url | 提供离线资源下载的 URL 地址 | - |
| offline_resources_enabled | 是否为离线部署 | true |
| generate_domain_crt | 是否为镜像仓库域名生成自签证书 | true |
| image_repository | 镜像仓库的 repo 或 project | library |
| registry_https_port | 镜像仓库的端口号，该端口已禁止 PUSH 镜像 | 443 |
| registry_push_port | 用于 PUSH 镜像的 registry 端口号 | 5000 |
| download_container | 是否在所有节点 pull 下所有组件的镜像 | false |
| 参数 | 说明 | 示例 |
| ----------------------------- | ---------------------------------------- | :-----: |
| ntp_server | ntp 时钟同步服务器域名或 IP | - |
| registry_ip | 镜像仓库节点 IP | - |
| offline_resources_url | 提供离线资源下载的 URL 地址 | - |
| offline_resources_enabled | 是否为离线部署 | true |
| generate_domain_crt | 是否为镜像仓库域名生成自签证书 | true |
| image_repository | 镜像仓库的 repo 或 project | library |
| registry_https_port | 镜像仓库的端口号，该端口已禁止 PUSH 镜像 | 443 |
| registry_push_port | 用于 PUSH 镜像的 registry 端口号 | 5000 |
| download_container | 是否在所有节点 pull 下所有组件的镜像 | false |
| cilium_enable_hubble | cilium 中是否开启 hubble | false |
| cilium_hubble_install | 是否安装 cilium hubble-ui | false |
| cilium_hubble_tls_generate | hubble 是否生成 tls 证书 | false |
| cilium_kube_proxy_replacement | 使用 cilium 代替 kube-proxy 的策略 | probe |

```yaml
default:
Expand All @@ -331,6 +335,14 @@ default:
registry_push_port: 5000
# Set false to disable download all container images on all nodes
download_container: false
# enable support hubble in cilium
cilium_enable_hubble: false
# install hubble-relay, hubble-ui
cilium_hubble_install: false
# install hubble-certgen and generate certificates
cilium_hubble_tls_generate: false
# Kube Proxy Replacement mode (strict/probe/partial)
cilium_kube_proxy_replacement: probe
```

### 部署集群
Expand Down

0 comments on commit 03e3896

Please sign in to comment.