Skip to content

Commit

Permalink
Adds a Table-form field description for EgressGateway.
Browse files Browse the repository at this point in the history 
Signed-off-by: lou-lan <loulan@loulan.me>
  • Loading branch information
@lou-lan
lou-lan committed Apr 29, 2024
1 parent e7d60c2 commit fca9431
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 0 deletions.
62 changes: 62 additions & 0 deletions docs/reference/EgressGateway.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,65 @@ status:
16. Name of the Policy using the Egress IP;
17. Namespace of the Policy using the Egress IP.


## Definition

### Metadata

| Field | Description | Schema | Validation |
|-------|-----------------------------------------|--------|------------|
| name | The name of this EgressGateway resource | string | required |

### Spec

| Field | Description | Schema | Validation | Values | Default |
|----------------|---------------------------------------|-------------------------------|------------|------------|---------|
| ippools | IP Pool of EgressGateway | [ippools](#ippools) | optional | | |
| nodeSelector | Match egress nodes by label | [nodeSelector](#nodeSelector) | require | | |
| clusterDefault | Default EgressGateway for the cluster | bool | optional | true/false | false |

#### ippools

| Field | Description | Schema | Validation | Values | Default |
|----------------|---------------------|----------|------------|-------------------------------------------------|---------|
| ipv4 | IPv4 pool | []string | optional | `10.6.0.1` `10.6.0.1-10.6.0.10` ``10.6.0.1/26`` | |
| ipv6 | IPv6 pool | []string | optional | `fd::01` `fd01::01-fd01:0a` `fd10:01/64` | |
| ipv4DefaultEIP | Default egress IPv4 | string | optional | | |
| ipv6DefaultEIP | Default egress IPv6 | string | optional | | |

### nodeSelector

| Field | Description | Schema | Validation | Values | Default |
|----------------------|-------------------|-------------------|------------|--------|---------|
| selector.matchLabels | Node match labels | map[string]string | optional | | |


### Status (subresource)

| Field | Description | Schema | Validation | Values | Default |
|----------|-----------------|-----------------------|------------|--------|---------|
| nodeList | Match node list | [nodeList](#nodeList) | optional | | |


#### nodeList

| Field | Description | Schema | Validation | Values | Default |
|--------|----------------------------|---------------|------------|---------------------|---------|
| name | Name of the node | string | optional | | |
| status | Current status of the node | string | optional | `Ready`, `NotReady` | |
| epis | List of endpoint IPs | [epis](#epis) | optional | | |

##### epis

| Field | Description | Schema | Validation | Values | Default |
|----------|--------------------------|-----------------------|------------|--------|---------|
| ipv4 | IPv4 address of the node | string | optional | | |
| ipv6 | IPv6 address of the node | string | optional | | |
| policies | Policy list of the node | [policies](#policies) | optional | | |

##### policies

| Field | Description | Schema | Validation | Values | Default |
|------------|------------------------------|------------|------------|------------|---------|
| name | Name of the policy | string | optional | | |
| namespace | Namespace of the policy | string | optional | | |
60 changes: 60 additions & 0 deletions docs/reference/EgressGateway.zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,63 @@ status:
16. 哪些策略使用此节点上的有效 Egress IP；
17. 使用 Egress IP 的策略名称；
18. 使用 Egress IP 的策略的命名空间。

## 定义

### 元数据

| 字段 | 描述 | 数据类型 | 验证 |
|------|------------------------|--------|----|
| name | 这个 EgressGateway 资源的名称 | string | 必填 |

### 规格

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|----------------|----------------------|-------------------------------|----|------------|-------|
| ippools | EgressGateway 的 IP 池 | [ippools](#ippools) | 可选 | | |
| nodeSelector | 通过标签匹配出口节点 | [nodeSelector](#nodeSelector) | 必填 | | |
| clusterDefault | 集群的默认 EgressGateway | bool | 可选 | true/false | false |

#### ippools

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|----------------|-----------|----------|----|-------------------------------------------------|-----|
| ipv4 | IPv4 池 | []string | 可选 | `10.6.0.1` `10.6.0.1-10.6.0.10` ``10.6.0.1/26`` | |
| ipv6 | IPv6 池 | []string | 可选 | `fd::01` `fd01::01-fd01:0a` `fd10:01/64` | |
| ipv4DefaultEIP | 默认出口 IPv4 | string | 可选 | | |
| ipv6DefaultEIP | 默认出口 IPv6 | string | 可选 | | |

### nodeSelector

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|----------------------|--------|-------------------|----|-----|-----|
| selector.matchLabels | 节点匹配标签 | map[string]string | 可选 | | |

### 状态（子资源）

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|----------|---------|-----------------------|----|-----|-----|
| nodeList | 匹配的节点列表 | [nodeList](#nodeList) | 可选 | | |

#### nodeList

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|--------|-------------|---------------|----|---------------------|-----|
| name | 节点的名称 | string | 可选 | | |
| status | 节点的当前状态 | string | 可选 | `Ready`, `NotReady` | |
| epis | 节点的端点 IP 列表 | [epis](#epis) | 可选 | | |

##### epis

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|----------|-------------|-----------------------|----|-----|-----|
| ipv4 | 节点的 IPv4 地址 | string | 可选 | | |
| ipv6 | 节点的 IPv6 地址 | string | 可选 | | |
| policies | 节点的策略列表 | [policies](#policies) | 可选 | | |

##### policies

| 字段 | 描述 | 数据类型 | 验证 | 可选值 | 默认值 |
|-----------|---------|--------|----|-----|-----|
| name | 策略的名称 | string | 可选 | | |
| namespace | 策略的命名空间 | string | 可选 | | |

1 comment on commit fca9431

@weizhoublue
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀 Deployed on https://662f59ff6a976290b9b37d13--egressgateway.netlify.app

Please sign in to comment.