Skip to content

Commit

Permalink
fix: Fix references to some legacy helm variables (#244)
Browse files Browse the repository at this point in the history
  • Loading branch information
CH3CHO committed Jul 5, 2024
1 parent 6beabbd commit 0cbf383
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ helm install higress higress.io/higress -n higress-system --create-namespace
| global.enableStatus | If `true`, Higress Controller will update the `status` field of Ingress resources.<br />When migrating from Nginx Ingress, in order to avoid `status` field of Ingress objects being overwritten, this parameter needs to be set to false, so Higress won't write the entry IP to the `status` field of the corresponding Ingress object. | true |
| global.enableIstioAPI | If `true`, Higress Controller will monitor istio resources as well | false |
| global.istioNamespace | The namespace istio is installed to | istio-system |
| global.o11y.enabled | If `true`, o11y suite (Grafana + Promethues) will be installed. | false |
| global.pvc.rwxSupported | Set to `false` when installing to a standard K8s cluster and the target cluster doesn't support the ReadWriteMany access mode of PersistentVolumeClaim. | true |
| **Core Paramters** | | |
| higress-core.gateway.replicas | Number of Higress Gateway pods | 2 |
| higress-core.controller.replicas | Number of Higress Controller pods | 1 |
| **Console Paramters** | | |
| higress-console.replicaCount | Number of Higress Console pods | 1 |
| higress-console.service.type | K8s service type used by Higress Console | ClusterIP |
| higress-console.web.login.prompt | Prompt message to be displayed on the login page | "" |
| higress-console.o11y.enabled | If `true`, o11y suite (Grafana + Promethues) will be installed. | false |
| higress-console.pvc.rwxSupported | Set to `false` when installing to a standard K8s cluster and the target cluster doesn't support the ReadWriteMany access mode of PersistentVolumeClaim. | true |

## Support Istio CRD

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m

## Use the Higress Console Built-In Monitor Suite

Higress Console has a built-in monitor suite based on Prometheus + Grafana, which isn't installed by default. When installing Higress with Helm, you can enable it by adding the following argument to the command line: `--set higress-console.o11y.enabled=true`.
Higress Console has a built-in monitor suite based on Prometheus + Grafana, which isn't installed by default. When installing Higress with Helm, you can enable it by adding the following argument to the command line: `--set global.o11y.enabled=true`.

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set higress-console.o11y.enabled=true
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.o11y.enabled=true
```

Note: When installing to a standard K8s cluster (meaning without specifying `global.local=true` or `global.kind=true`), the PersistentVolumeClaim configured in the suite uses the access mode of `ReadWriteMany` by default. If the target K8s cluster doesn't support this mode, you can add the following argument to the command line to change the access mode to `ReadWriteOnce`: `--set higress-console.pvc.rwxSupported=false`.
Note: When installing to a standard K8s cluster (meaning without specifying `global.local=true`), the PersistentVolumeClaim configured in the suite uses the access mode of `ReadWriteMany` by default. If the target K8s cluster doesn't support this mode, you can add the following argument to the command line to change the access mode to `ReadWriteOnce`: `--set global.pvc.rwxSupported=false`.

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set higress-console.o11y.enabled=true --set higress-console.pvc.rwxSupported=false
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.o11y.enabled=true --set global.pvc.rwxSupported=false
```

After installation, open Higress Console in your browser, and click "Dashboard" on the left navigation area. The built-in dashboard will be displayed on the right.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,11 @@ we can use official support to enable this function,please refer to `https://kin


##### Step 3: Install Higress
when you install `higress` in local environment, you should use `--set global.kind=true`;
in the future, we will use `--set global.local=true` for unambiguous.
when you install `higress` in local environment, you should use `--set global.local=true`.

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.local=true --set higress-console.o11y.enabled=false
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.local=true --set global.o11y.enabled=false
```

> If you'd like to enable the built-in o11y suite, please refer to the [Deploy by Helm](../ops/deploy-by-helm) document.
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-cn/docusaurus-plugin-content-blog/release-070.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ helm upgrade higress -n higress-system higress.io/higress --set higress-console.
如果希望启用 Higress 自带的 Prometheus&Grafana,可以通过下面 helm 命令进行安装:

```bash
helm upgrade higress -n higress-system higress.io/higress --set higress-console.o11y.enabled=true
helm upgrade higress -n higress-system higress.io/higress --set global.o11y.enabled=true
```

这样 Higress 控制台就可以看到自带的可观测大盘了:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ if [ "$IS_INSTALLED_CRD" = true ]; then

echo "Step3: Installing Higress "
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.enableIstioAPI=true --set global.kind=true --set higress-console.o11y.enabled=true
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.enableIstioAPI=true --set global.local=true --set global.o11y.enabled=true
echo "Step3: Installing Higress finished."
else
echo "Step2: Installing Higress "
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.enableIstioAPI=true --set global.kind=true --set higress-console.o11y.enabled=true
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.enableIstioAPI=true --set global.local=true --set global.o11y.enabled=true
echo "Step2: Installing Higress finished."
fi

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ helm install higress higress.io/higress -n higress-system --create-namespace
| global.enableIstioAPI | 若为`true`,Higress Controller 将同时监听 istio 资源 | false |
| global.enableGatewayAPI | 若为`true`,Higress Controller 将同时监听 Gateway API 资源 | false |
| global.onlyPushRouteCluster | 若为`true`,Higress Controller 将会只推送被路由关联的服务 | true |
| global.o11y.enabled | 若为 `true`,将同时安装可观测性套件(Grafana、Promethues、Loki、PromTail) | false |
| global.pvc.rwxSupported | 标识目标 K8s 集群是否支持 PersistentVolumeClaim 的 ReadWriteMany 操作方式。 | true |
| **核心组件参数** | | |
| higress-core.gateway.replicas | Higress Gateway 的 pod 数量 | 2 |
| higress-core.controller.replicas | Higress Controller 的 pod 数量 | 1 |
| **控制台参数** | | |
| higress-console.replicaCount | Higress Console 的 pod 数量 | 1 |
| higress-console.service.type | Higress Console 所使用的 K8s Service 类型 | ClusterIP |
| higress-console.web.login.prompt | 登录页面上显示的提示信息 | "" |
| higress-console.o11y.enabled | 若为 `true`,将同时安装可观测性套件(Grafana + Promethues) | false |
| higress-console.pvc.rwxSupported | 标识目标 K8s 集群是否支持 PersistentVolumeClaim 的 ReadWriteMany 操作方式。 | true |

## 支持 Istio CRD(可选)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m
| global.imagePullPolicy | 如果不希望使用默认行为,则可以指定镜像拉取策略。默认行为:最新的镜像将始终以 Always 方式拉取,否则将以 IfNotPresent 方式拉取。 | "" |
| global.imagePullSecrets | 为所有 ServiceAccount 配置 ImagePullSecrets,即在同一命名空间中列出的一组密钥,用于拉取任何引用此 ServiceAccount 的 pod 中的镜像。对于不使用 ServiceAccount 的组件(例如 grafana、servicegraph、tracing),ImagePullSecrets 将被添加到相应的 Deployment(StatefulSet)对象中。对于配置了私有 Docker Registry 的任何集群,都必须设置此项。 | [] |
| global.defaultUpstreamConcurrencyThreshold | 单个数据面实例和后端服务之间的最大并发(不同服务独立计算),注意过多并发可能导致网关内存过高,请相应调高数据面内存限制 | 10000 |
| global.o11y.enabled | 若为 true,将同时安装可观测性套件(Grafana、Promethues、Loki、PromTail 等)。 | false |
| global.pvc.rwxSupported | RwxSupported 参数用于指示是否支持读写多个 Pod,即是否支持共享卷。如果该参数设置为 true,则表明支持共享卷,多个 Pod 可以同时挂载该 PVC,进行读写操作。如果设置为 false,则表明不支持共享卷,只有一个 Pod 可以挂载该 PVC 进行读写操作。 | true |
| global.onlyPushRouteCluster | 若为`true`,Higress Controller 将会只推送被路由关联的服务 | true |

## meshConfig参数
Expand Down Expand Up @@ -66,7 +68,6 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m
| higress-core.gateway.affinity | 亲和性,用于控制 gateway容器如何调度,使其与其他 Pod 或节点保持亲和或反亲和。 | {} |
| higress-core.gateway.networkGateway | 用于指定网络网关的名称或 IP 地址。 | "" |


## Controller参数
| 参数 | 参数说明 | 默认值 |
|--------------------------------------------------------|----------------------------------------------------------------------|-----------|
Expand Down Expand Up @@ -129,16 +130,13 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m
| higress-core.pilot.configMap | 安装由values.yaml生成的 mesh config ,如果为 false ,则 Pilot 将使用默认值(默认情况下)或用户提供的值,如果为 false ,则 Pilot 将使用默认值(默认情况下)或用户提供的值 | true |
| higress-core.pilot.podLabels | 为 Pod 添加额外的标签,以用于监控和日志记录配置。 | {} |



## skywalking 参数
## SkyWalking参数
| 参数 | 参数说明 | 默认值 |
|-----------------------------------------|------------------------------|-----------|
| higress-core.skywalking.enabled | 是否启用 SkyWalking | false |
| higress-core.skywalking.service.address | SkyWalking 服务地址,如果不指定则使用默认值 | ~ |
| higress-core.skywalking.service.port | SkyWalking 服务端口,默认为 11800 | 11800 |


## 控制台参数
| 参数 | 参数说明 | 默认值 |
|------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------|------------------|
Expand All @@ -151,7 +149,6 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m
| higress-console.web.login.prompt | 登录页面上显示的提示信息,默认为空。 | "" |
| higress-console.certmanager.enabled | 指定是否启用证书管理器。 | false |
| higress-console.certmanager.replicas | Certmanage pod 的数量。 | 1 |
| higress-console.o11y.enabled | 若为 true,将同时安装可观测性套件(Grafana + Promethues)。 | false |
| higress-console.o11y.grafana.replicas | Grafana pod 的数量。 | 1 |
| higress-console.o11y.grafana.storage | 分配给 Grafana 的存储类大小。 | 1Gi |
| higress-console.o11y.grafana.pvc.storageClassName | Grafana 的存储类名称。 | "" |
Expand All @@ -160,4 +157,3 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m
| higress-console.o11y.prometheus.pvc.storageClassName | Prometheus 的存储类名称。 | "" |
| higress-console.o11y.prometheus.resources.limits.cpu | 分配给 prometheus 的 CPU 资源限制。 | 500m |
| higress-console.o11y.prometheus.resources.limits.memory | 分配给 prometheus 的内存资源限制。 | 2Gi |
| higress-console.pvc.rwxSupported | RwxSupported 参数用于指示是否支持读写多个 Pod,即是否支持共享卷。如果该参数设置为 true,则表明支持共享卷,多个 Pod 可以同时挂载该 PVC,进行读写操作。如果设置为 false,则表明不支持共享卷,只有一个 Pod 可以挂载该 PVC 进行读写操作。 | true |
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ custom_edit_url: https://github.com/higress-group/higress-group.github.io/blob/m

## 使用 Higress Console 的内置监控套件

Higress Console 内置了一套基于 Prometheus + Grafana 的监控套件,但默认不会安装。在使用 Helm 安装 Higress 时,可以通过在命令行中添加 `--set higress-console.o11y.enabled=true` 参数启用这一监控套件。
Higress Console 内置了一套基于 Prometheus + Grafana 的监控套件,但默认不会安装。在使用 Helm 安装 Higress 时,可以通过在命令行中添加 `--set global.o11y.enabled=true` 参数启用这一监控套件。

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set higress-console.o11y.enabled=true
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.o11y.enabled=true
```

注意:在安装到标准 K8s 集群(即未指定 `global.local=true` `global.kind=true` 参数)时,监控系统所配置的 PersistentVolumeClaim 默认使用 `ReadWriteMany` 访问模式。如果目标 K8s 集群不支持这一访问模式,则可以在命令行中额外添加 `--set higress-console.pvc.rwxSupported=false` 参数来将访问模式切换为 `ReadyWriteOnce`
注意:在安装到标准 K8s 集群(即未指定 `global.local=true` 参数)时,监控系统所配置的 PersistentVolumeClaim 默认使用 `ReadWriteMany` 访问模式。如果目标 K8s 集群不支持这一访问模式,则可以在命令行中额外添加 `--set global.pvc.rwxSupported=false` 参数来将访问模式切换为 `ReadyWriteOnce`

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set higress-console.o11y.enabled=true --set higress-console.pvc.rwxSupported=false
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.o11y.enabled=true --set global.pvc.rwxSupported=false
```

完成安装后,在浏览器中访问 Higress Console,点击左侧导航栏“监控面板”,页面右侧就会展示出系统内置的监控面板。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,11 @@ kubectl.exe config use-context kind-higress

##### 第三步:安装 Higress

本地安装开关: `--set global.kind=true`
为避免歧义,后面会调整属性名称为:`--set global.local=true`
本地安装开关: `--set global.local=true`

```bash
helm repo add higress.io https://higress.io/helm-charts
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.local=true --set higress-console.o11y.enabled=false
helm install higress -n higress-system higress.io/higress --create-namespace --render-subchart-notes --set global.local=true --set global.o11y.enabled=false
```

> 若要启用 Higress 内置的套件,可参阅[安装部署](../ops/deploy-by-helm.md)文档。
Expand Down

0 comments on commit 0cbf383

Please sign in to comment.