# safeline-helmchart

**Repository Path**: andyhau/safeline-helmchart

## Basic Information

- **Project Name**: safeline-helmchart
- **Description**: 长亭雷池WAF开源版-预览版自制HelmChart
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-07-12
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: waf, web-application-firewall, k8s-deployment, helm-chart-deployment, chaitin-waf

## README

<h4 align="center">
  SafeLine - 雷池 - 预览版本(非TLS) - 自制HelmChart
</h4>

<p align="center">
  <a target="_blank" href="https://waf-ce.chaitin.cn/">雷池官方网站</a> &nbsp; | &nbsp;
  <a target="_blank" href="https://github.com/yaencn/safeline-lts-helmchart">TLS版GIT仓库</a> &nbsp; | &nbsp;
  <a target="_blank" href="https://github.com/yaencn/safeline-helmchart">预览版GIT仓库</a> &nbsp; | &nbsp;
  <a target="_blank" href="https://github.com/yaencn/safeline-helmchart/blob/master/README_CN.md">中文文档</a>
</p>

## ----- Readme -----

从AppVersion 7.5.0开始，为了更好的管理HelmChart版本，HelmChart Version将与AppVersion独立开始计算版本。

**提醒：**

此分支为预览版本分支，此分支中的仅包含预览版本。
如需使用LTS版本，请访问如下GIT仓库：
https://github.com/yaencn/safeline-helmchart

- Github的长期支持LTS版本仓库：
https://github.com/yaencn/safeline-lts-helmchart

GIT仓库在中国大陆的加速地址：
- 预览版仓库
https://gitee.com/andyhau/safeline-helmchart.git

- LTS版仓库
https://gitee.com/andyhau/safeline-lts-helmchart.git

- 国际版本部署支持
从appVersion为8.8.2开始支持x86_64架构的国际版部署支持，如需部署国际版本，请将value.yaml文件参数修改为如下值：
`global.image.registry=chaitin`
`global.image.region="-g"`

## ----- HelmChart Install -----

- HelmChart网页地址:
https://helm.yaencn.com

- HelmChart仓库地址:

此链接将在2025年9月1日起失效:

https://g-otkk6267-helm.pkg.coding.net/Charts/safeline

最新helmchart仓库地址：

https://helm.yaencn.com/charts


- 举例：
```shell
# 添加helm仓库
helm repo add yaencn https://helm.yaencn.com/charts

# 安装中国大陆版本举例
helm install safeline --namespace safeline \
  --set global.ingress.enabled=true \
  --set global.ingress.hostname="waf.local" \
  yaencn/safeline

# 安装国际版本举例
helm install safeline --namespace safeline \
  --set global.ingress.enabled=true \
  --set global.ingress.hostname="waf.local" \
  --set global.image.registry=chaitin \
  --set global.image.region="-g" \
  yaencn/safeline

# 更新升级版本
helm -n safeline upgrade safeline yaencn/safeline
# 签出指定版本压缩包
helm fetch --version 10.0.9 yaencn/safeline
# 卸载服务
helm -n safeline uninstall safeline
```

## ----- Helm Build -----

```shell
# 检测helmchart-template是否有语法问题
cd safeline
helm template charts/ --output-dir ./result 
```

```shell
helm package ./safeline/charts/ -d ./assets/safeline

helm repo index --merge ./index.yaml --url assets assets/

rm -f ./index.yaml

mv ./assets/index.yaml ./index.yaml

cd ./assets/safeline/

helm coding-push safeline-${app-version}.tgz safeline
```

## ----- Installation Remind -----

**警告：**

该HelmChart中的任何deployment资源清单只能部署一个pod副本!
如果运行多个pod副本，整个WAF服务将出现未知错误.

## ----- Version Notes -----

**6.1.2及以后的版本:**

- 默认使用NodePort方式暴露服务。
  - 如果你想使用Ingress方式，需要将values文件中的`global.exposeServicesAsPorts.enabled`字段设置为`false`。
  - 可以通过values文件中的`global.exposeServicesAsPorts.enabled`字段的值进行控制。

**6.9.1及以后的版本:**

增加WAF控制台web界面可通过nginx-ingress绑定域名,具体参加values.yaml文件

```yaml
  # 设置雷池WAF控制台通过域名访问，如：demo.waf-ce.chaitin.cn
  global:
    ingress:
      # 是否开启雷池WAF控制通过域名访问，默认未开启
      enabled: true
      hostname: waf.local
      ingressClassName: nginx
      pathType: ImplementationSpecific
      path: /
      tls:
        # 是否加载HelmChart外部的HTTPS域名证书的Secret.
        # 如果有则请填写Secret名称，默认不填写及域名仅开启http访问.
        # 如填写如下项，请在运行该HelmChart前创建好对应的Secret。
        secretName: "waf-xxx-com-tls"
```


## ----- Configuration Description -----