mirror of
https://github.com/alibaba/higress.git
synced 2026-05-27 22:27:29 +08:00
docs: adds clean-up and make md format (#33)
Signed-off-by: bitliu <bitliu@tencent.com>
This commit is contained in:
38
README.md
38
README.md
@@ -44,7 +44,6 @@ Higress 是基于阿里内部两年多的 Envoy Gateway 实践沉淀,以开源
|
|||||||
|
|
||||||
Higress 可以作为安全防护网关, 提供 WAF 的能力,并且支持多种认证鉴权策略,例如 key-auth, hmac-auth, jwt-auth, basic-auth, oidc 等。
|
Higress 可以作为安全防护网关, 提供 WAF 的能力,并且支持多种认证鉴权策略,例如 key-auth, hmac-auth, jwt-auth, basic-auth, oidc 等。
|
||||||
|
|
||||||
|
|
||||||
## 核心优势
|
## 核心优势
|
||||||
|
|
||||||
- **生产等级**
|
- **生产等级**
|
||||||
@@ -71,18 +70,17 @@ Higress 是基于阿里内部两年多的 Envoy Gateway 实践沉淀,以开源
|
|||||||
|
|
||||||
插件支持热更新,变更插件逻辑和配置都对流量无损
|
插件支持热更新,变更插件逻辑和配置都对流量无损
|
||||||
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
- [**本地环境**](#本地环境)
|
- [**本地环境**](#本地环境)
|
||||||
- [**生产环境**](#生产环境)
|
- [**生产环境**](#生产环境)
|
||||||
|
|
||||||
|
|
||||||
### 本地环境
|
### 本地环境
|
||||||
|
|
||||||
|
|
||||||
#### 第一步、 安装 kubectl & kind
|
#### 第一步、 安装 kubectl & kind
|
||||||
|
|
||||||
**MacOS:**
|
**MacOS:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
|
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
|
||||||
# for Intel Macs
|
# for Intel Macs
|
||||||
@@ -94,6 +92,7 @@ mv ./kind ./kubectl /some-dir-in-your-PATH/
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Windows 中使用 PowerShell:**
|
**Windows 中使用 PowerShell:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl.exe -Lo kubectl.exe https://storage.googleapis.com/kubernetes-release/release/$(curl.exe -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/windows/amd64/kubectl.exe
|
curl.exe -Lo kubectl.exe https://storage.googleapis.com/kubernetes-release/release/$(curl.exe -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/windows/amd64/kubectl.exe
|
||||||
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.17.0/kind-windows-amd64
|
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.17.0/kind-windows-amd64
|
||||||
@@ -102,6 +101,7 @@ Move-Item .\kubectl.exe c:\some-dir-in-your-PATH\kubectl.exe
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Linux:**
|
**Linux:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
|
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
|
||||||
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.17.0/kind-linux-amd64
|
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.17.0/kind-linux-amd64
|
||||||
@@ -133,12 +133,16 @@ nodes:
|
|||||||
hostPort: 443
|
hostPort: 443
|
||||||
protocol: TCP
|
protocol: TCP
|
||||||
```
|
```
|
||||||
|
|
||||||
Mac & Linux 系统执行:
|
Mac & Linux 系统执行:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kind create cluster --name higress --config=cluster.conf
|
kind create cluster --name higress --config=cluster.conf
|
||||||
kubectl config use-context kind-higress
|
kubectl config use-context kind-higress
|
||||||
```
|
```
|
||||||
|
|
||||||
Windows 系统执行:
|
Windows 系统执行:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kind.exe create cluster --name higress --config=cluster.conf
|
kind.exe create cluster --name higress --config=cluster.conf
|
||||||
kubectl.exe config use-context kind-higress
|
kubectl.exe config use-context kind-higress
|
||||||
@@ -168,12 +172,26 @@ curl localhost/foo
|
|||||||
curl localhost/bar
|
curl localhost/bar
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### 卸载资源
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl delete -f https://kind.sigs.k8s.io/examples/ingress/usage.yaml
|
||||||
|
|
||||||
|
helm uninstall istio -n istio-system
|
||||||
|
|
||||||
|
helm uninstall higress -n higress-system
|
||||||
|
|
||||||
|
kubectl delete ns istio-system
|
||||||
|
|
||||||
|
kubectl delete ns higress-system
|
||||||
|
```
|
||||||
|
|
||||||
### 生产环境
|
### 生产环境
|
||||||
|
|
||||||
#### 第一步、 安装 istio
|
#### 第一步、 安装 istio
|
||||||
|
|
||||||
可以选择安装 higress 发行的 istio 版本:
|
可以选择安装 higress 发行的 istio 版本:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl create ns istio-system
|
kubectl create ns istio-system
|
||||||
helm install istio -n istio-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/istio
|
helm install istio -n istio-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/istio
|
||||||
@@ -219,6 +237,18 @@ spec:
|
|||||||
curl "$(k get svc -n higress-system higress-gateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"/foo -H 'host: foo.bar.com'
|
curl "$(k get svc -n higress-system higress-gateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"/foo -H 'host: foo.bar.com'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### 卸载资源
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm uninstall istio -n istio-system
|
||||||
|
|
||||||
|
helm uninstall higress -n higress-system
|
||||||
|
|
||||||
|
kubectl delete ns istio-system
|
||||||
|
|
||||||
|
kubectl delete ns higress-system
|
||||||
|
```
|
||||||
|
|
||||||
## 社区
|
## 社区
|
||||||
|
|
||||||
### 感谢
|
### 感谢
|
||||||
|
|||||||
43
README_EN.md
43
README_EN.md
@@ -42,22 +42,21 @@ Powered by [Istio](https://github.com/istio/istio) and [Envoy](https://github.co
|
|||||||
|
|
||||||
Higress can be used as a security gateway, supporting WAF and various authentication strategies, such as key-auth, hmac-auth, jwt-auth, basic-auth, oidc, etc.
|
Higress can be used as a security gateway, supporting WAF and various authentication strategies, such as key-auth, hmac-auth, jwt-auth, basic-auth, oidc, etc.
|
||||||
|
|
||||||
|
|
||||||
## Higress Features
|
## Higress Features
|
||||||
|
|
||||||
(TODO)
|
(TODO)
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
- [**Local Environment**](#local-environment)
|
- [**Local Environment**](#local-environment)
|
||||||
- [**Production Environment**](#production-environment)
|
- [**Production Environment**](#production-environment)
|
||||||
|
|
||||||
|
|
||||||
### Local Environment
|
### Local Environment
|
||||||
|
|
||||||
|
|
||||||
#### step 1. install kubectl & kind
|
#### step 1. install kubectl & kind
|
||||||
|
|
||||||
**On MacOS**
|
**On MacOS:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
|
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
|
||||||
# for Intel Macs
|
# for Intel Macs
|
||||||
@@ -69,6 +68,7 @@ mv ./kind ./kubectl /some-dir-in-your-PATH/
|
|||||||
```
|
```
|
||||||
|
|
||||||
**On Windows in PowerShell:**
|
**On Windows in PowerShell:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl.exe -Lo kubectl.exe https://storage.googleapis.com/kubernetes-release/release/$(curl.exe -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/windows/amd64/kubectl.exe
|
curl.exe -Lo kubectl.exe https://storage.googleapis.com/kubernetes-release/release/$(curl.exe -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/windows/amd64/kubectl.exe
|
||||||
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.17.0/kind-windows-amd64
|
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.17.0/kind-windows-amd64
|
||||||
@@ -77,6 +77,7 @@ Move-Item .\kubectl.exe c:\some-dir-in-your-PATH\kubectl.exe
|
|||||||
```
|
```
|
||||||
|
|
||||||
**On Linux:**
|
**On Linux:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
|
curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl
|
||||||
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.17.0/kind-linux-amd64
|
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.17.0/kind-linux-amd64
|
||||||
@@ -108,12 +109,16 @@ nodes:
|
|||||||
hostPort: 443
|
hostPort: 443
|
||||||
protocol: TCP
|
protocol: TCP
|
||||||
```
|
```
|
||||||
|
|
||||||
Mac & Linux:
|
Mac & Linux:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kind create cluster --name higress --config=cluster.conf
|
kind create cluster --name higress --config=cluster.conf
|
||||||
kubectl config use-context kind-higress
|
kubectl config use-context kind-higress
|
||||||
```
|
```
|
||||||
|
|
||||||
Windows:
|
Windows:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kind.exe create cluster --name higress --config=cluster.conf
|
kind.exe create cluster --name higress --config=cluster.conf
|
||||||
kubectl.exe config use-context kind-higress
|
kubectl.exe config use-context kind-higress
|
||||||
@@ -126,7 +131,7 @@ helm install istio -n istio-system oci://higress-registry.cn-hangzhou.cr.aliyunc
|
|||||||
helm install higress -n higress-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/higress-local
|
helm install higress -n higress-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/higress-local
|
||||||
```
|
```
|
||||||
|
|
||||||
#### step 4. create the ingress and test it!
|
#### step 4. create the ingress and test it
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/usage.yaml
|
kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/usage.yaml
|
||||||
@@ -141,12 +146,26 @@ curl localhost/foo
|
|||||||
curl localhost/bar
|
curl localhost/bar
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Clean-Up
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl delete -f https://kind.sigs.k8s.io/examples/ingress/usage.yaml
|
||||||
|
|
||||||
|
helm uninstall istio -n istio-system
|
||||||
|
|
||||||
|
helm uninstall higress -n higress-system
|
||||||
|
|
||||||
|
kubectl delete ns istio-system
|
||||||
|
|
||||||
|
kubectl delete ns higress-system
|
||||||
|
```
|
||||||
|
|
||||||
### Production Environment
|
### Production Environment
|
||||||
|
|
||||||
#### step 1. install istio
|
#### step 1. install istio
|
||||||
|
|
||||||
select higress istio:
|
select higress istio:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl create ns istio-system
|
kubectl create ns istio-system
|
||||||
helm install istio -n istio-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/istio
|
helm install istio -n istio-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/istio
|
||||||
@@ -163,7 +182,7 @@ kubectl create ns higress-system
|
|||||||
helm install higress -n higress-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/higress
|
helm install higress -n higress-system oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/charts/higress
|
||||||
```
|
```
|
||||||
|
|
||||||
#### step 3. create the ingress and test it!
|
#### step 3. create the ingress and test it
|
||||||
|
|
||||||
for example there is a service `test` in default namespace.
|
for example there is a service `test` in default namespace.
|
||||||
|
|
||||||
@@ -190,8 +209,18 @@ spec:
|
|||||||
curl "$(k get svc -n higress-system higress-gateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"/foo -H 'host: foo.bar.com'
|
curl "$(k get svc -n higress-system higress-gateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')"/foo -H 'host: foo.bar.com'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Clean-Up
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm uninstall istio -n istio-system
|
||||||
|
|
||||||
|
helm uninstall higress -n higress-system
|
||||||
|
|
||||||
|
kubectl delete ns istio-system
|
||||||
|
|
||||||
|
kubectl delete ns higress-system
|
||||||
|
```
|
||||||
|
|
||||||
### Thanks
|
### Thanks
|
||||||
|
|
||||||
Higress would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to Envoy and Istio.
|
Higress would not be possible without the valuable open-source work of projects in the community. We would like to extend a special thank-you to Envoy and Istio.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user