Skip to content

Commit

Permalink
Merge pull request #3468 from ty-dc/release-v0.9
Browse files Browse the repository at this point in the history 
[Docs] Fix links to anchors in /docs/reference
  • Loading branch information
@ty-dc
ty-dc authored May 7, 2024
2 parents 26cb36d + 2dc8698 commit 5c640f8
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/reference/crd-spiderendpoint.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The IPPool status is a subresource that processed automatically by the system to
| Field | Description | Schema | Validation |
|---------------------|----------------------------------------------------|------------------------------------------------------------|------------|
| current | the IP allocation details of the corresponding pod | [PodIPAllocation](./crd-spiderendpoint.md#PodIPAllocation) | required |
| current | the IP allocation details of the corresponding pod | [PodIPAllocation](./crd-spiderendpoint.md#podipallocation) | required |
| ownerControllerType | the corresponding pod top owner controller type | string | required |
| ownerControllerName | the corresponding pod top owner controller name | string | required |
Expand All @@ -53,7 +53,7 @@ This property describes the SpiderEndpoint corresponding pod details.
|-------|-------------------------------------|--------------------------------------------------------------------------|------------|
| uid | corresponding pod uid | string | required |
| node | total IP counts of this pool to use | string | required |
| ips | current allocated IP counts | list of [IPAllocationDetail](./crd-spiderendpoint.md#IPAllocationDetail) | required |
| ips | current allocated IP counts | list of [IPAllocationDetail](./crd-spiderendpoint.md#podipallocation) | required |
#### IPAllocationDetail
Expand All @@ -70,4 +70,4 @@ This property describes single Interface allocation details.
| ipv4Gateway | the IPv4 gateway IP address | string | optional | |
| ipv6Gateway | the IPv6 gateway IP address | string | optional | |
| cleanGateway | a flag to choose whether need default route by the gateway | boolean | optional | |
| routes | the allocation routes | list if [Route](./crd-spiderippool.md#Route) | optional | |
| routes | the allocation routes | list if [Route](./crd-spiderippool.md#route) | optional | |
2 changes: 1 addition & 1 deletion docs/reference/crd-spiderippool.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This is the IPPool spec for users to configure.
| excludeIPs | isolated IP ranges for this pool to filter | list of strings | optional | array of IP ranges and single IP address | |
| gateway | gateway for this pool | string | optional | an IP address | |
| vlan | vlan ID(deprecated) | int | optional | [0,4094] | 0 |
| routes | custom routes in this pool (please don't set default route `0.0.0.0/0` if property `gateway` exists) | list of [route](./crd-spiderippool.md#Route) | optional | | |
| routes | custom routes in this pool (please don't set default route `0.0.0.0/0` if property `gateway` exists) | list of [route](./crd-spiderippool.md#route) | optional | | |
| podAffinity | specify which pods can use this pool | [labelSelector](https://github.com/kubernetes/kubernetes/blob/v1.27.0/staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go#L1195) | optional | kubernetes LabelSelector | |
| namespaceAffinity | specify which namespaces pods can use this pool | [labelSelector](https://github.com/kubernetes/kubernetes/blob/v1.27.0/staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/types.go#L1195) | optional | kubernetes LabelSelector | |
| namespaceName | specify which namespaces pods can use this pool (The priority is higher than property `namespaceAffinity`) | list of strings | optional | | |
Expand Down
32 changes: 16 additions & 16 deletions docs/reference/crd-spidermultusconfig.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ This is the SpiderReservedIP spec for users to configure.
| Field | Description | Schema | Validation | Values | Default |
|-------------------|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------|-----------------------------------------------|---------|
| cniType | expected main CNI type | string | require | macvlan, ipvlan, sriov, ovs, ib-sriov, custom | |
| macvlan | macvlan CNI configuration | [SpiderMacvlanCniConfig](./crd-spidermultusconfig.md#SpiderMacvlanCniConfig) | optional | | |
| ipvlan | ipvlan CNI configuration | [SpiderIPvlanCniConfig](./crd-spidermultusconfig.md#SpiderIPvlanCniConfig) | optional | | |
| sriov | sriov CNI configuration | [SpiderSRIOVCniConfig](./crd-spidermultusconfig.md#SpiderSRIOVCniConfig) | optional | | |
| ibsriov | infiniband ib-sriov CNI configuration | [SpiderIBSRIOVCniConfig](./crd-spidermultusconfig.md#SpiderIBSRIOVCniConfig) | optional | | |
| ipoib | infiniband ipoib CNI configuration | [SpiderIpoibCniConfig](./crd-spidermultusconfig.md#SpiderIpoibCniConfig) | optional | | |
| ovs | ovs CNI configuration | [SpiderOvsCniConfig](./crd-spidermultusconfig.md#SpiderOvsCniConfig) | optional | | |
| macvlan | macvlan CNI configuration | [SpiderMacvlanCniConfig](./crd-spidermultusconfig.md#spidermacvlancniconfig) | optional | | |
| ipvlan | ipvlan CNI configuration | [SpiderIPvlanCniConfig](./crd-spidermultusconfig.md#spideripvlancniconfig) | optional | | |
| sriov | sriov CNI configuration | [SpiderSRIOVCniConfig](./crd-spidermultusconfig.md#spidersriovcniconfig) | optional | | |
| ibsriov | infiniband ib-sriov CNI configuration | [SpiderIBSRIOVCniConfig](./crd-spidermultusconfig.md#spideribsriovcniconfig) | optional | | |
| ipoib | infiniband ipoib CNI configuration | [SpiderIpoibCniConfig](./crd-spidermultusconfig.md#spideripoibcniconfig) | optional | | |
| ovs | ovs CNI configuration | [SpiderOvsCniConfig](./crd-spidermultusconfig.md#spiderovscniconfig) | optional | | |
| enableCoordinator | enable coordinator or not | boolean | optional | true,false | true |
| disableIPAM | disable IPAM. when set to be true, any configuration of CNI's ippools field will be ignored | boolean | optional | true,false | false |
| coordinator | coordinator CNI configuration | [CoordinatorSpec](./crd-spidercoordinator.md#Spec) | optional | | |
| coordinator | coordinator CNI configuration | [CoordinatorSpec](./crd-spidercoordinator.md#spec) | optional | | |
| customCNI | a string that represents custom CNI configuration | string | optional | | |

#### SpiderMacvlanCniConfig
Expand All @@ -69,17 +69,17 @@ This is the SpiderReservedIP spec for users to configure.
|---------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------|----------|
| master | the Interfaces on your master, you could specify a single one Interface<br/> or multiple Interfaces to generate one bond Interface | list of strings | required | |
| vlanID | vlan ID | int | optional | [0,4094] |
| bond | expected bond Interface configurations | [BondConfig](./crd-spidermultusconfig.md#BondConfig) | optional | |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional | |
| bond | expected bond Interface configurations | [BondConfig](./crd-spidermultusconfig.md#bondconfig) | optional | |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional | |

#### SpiderIPvlanCniConfig

| Field | Description | Schema | Validation | Values |
|---------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------|----------|
| master | the Interfaces on your master, you could specify a single one Interface<br/> or multiple Interfaces to generate one bond Interface | list of strings | required | |
| vlanID | vlan ID | int | optional | [0,4094] |
| bond | expected bond Interface configurations | [BondConfig](./crd-spidermultusconfig.md#BondConfig) | optional | |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional | |
| bond | expected bond Interface configurations | [BondConfig](./crd-spidermultusconfig.md#bondconfig) | optional | |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional | |

#### SpiderSRIOVCniConfig

Expand All @@ -90,7 +90,7 @@ This is the SpiderReservedIP spec for users to configure.
| minTxRateMbps | change the allowed minimum transmit bandwidth, in Mbps, for the VF. Setting this to 0 disables rate limiting. The min_tx_rate value should be <= max_tx_rate. Support of this feature depends on NICs and drivers | int | optional |
| maxTxRateMbps | change the allowed maximum transmit bandwidth, in Mbps, for the VF. Setting this to 0 disables rate limiting | int | optional |
| enableRdma | enable rdma chain cni to isolate the rdma device | bool | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional |

#### SpiderIBSRIOVCniConfig

Expand All @@ -101,24 +101,24 @@ This is the SpiderReservedIP spec for users to configure.
| linkState | Enforces link state for the VF. Allowed values: auto, enable [default], disable | string | optional |
| rdmaIsolation | Enable RDMA network namespace isolation for RDMA workloads, default to true | bool | optional |
| ibKubernetesEnabled | Enforces ib-sriov-cni to work with [ib-kubernetes](https://github.com/Mellanox/ib-kubernetes) , default to false | bool | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional |

#### SpiderIpoibCniConfig

| Field | Description | Schema | Validation |
|---------|-----------------------------------------------|----------------------------------------------------------------|------------|
| master | master interface name | string | required |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional |

#### SpiderOvsCniConfig

| Field | Description | Schema | Validation |
|--------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------|
| bridge | name of the bridge to use | string | required |
| vlan | vlan ID of attached port. Trunk port if not specified | int | optional |
| trunk | List of VLAN ID's and/or ranges of accepted VLAN ID's | [Trunk](./crd-spidermultusconfig.md#Trunk) | optional |
| trunk | List of VLAN ID's and/or ranges of accepted VLAN ID's | [Trunk](./crd-spidermultusconfig.md#trunk) | optional |
| deviceID | PCI address of a VF in valid sysfs format | string | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#SpiderpoolPools) | optional |
| ippools | the default IPPools in your CNI configurations | [SpiderpoolPools](./crd-spidermultusconfig.md#spiderpoolpools) | optional |

#### BondConfig

Expand Down
Loading

0 comments on commit 5c640f8

Please sign in to comment.