Optimize cleangateway docs #3704
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ty-dc
added
release/none
weizhoublue
reviewed
Jul 9, 2024
docs/reference/annotation.md
Outdated
| @@ -95,7 +95,7 @@ ipam.spidernet.io/ippools: |- | |||
| - `interface` (string, required): Since the CNI request only carries the information of one interface, the field `interface` shall be specified to distinguish in the case of multiple interfaces. | |||
| - `ipv4` (array, optional): Specify which IPPool is used to allocate the IPv4 address. When `enableIPv4` in the ConfigMap `spiderpool-conf` is set to true, this field is required. | |||
| - `ipv6` (array, optional): Specify which IPPool is used to allocate the IPv6 address. When `enableIPv6` in the ConfigMap `spiderpool-conf` is set to true, this field is required. | |||
| - `cleangateway` (bool, optional): If set to true, the IPAM plugin will not return the default route (generated by `spec.gateway`) recorded in the IPPool. | |||
| - `cleangateway` (bool, optional): If set to true, the gateway specified for the NIC via the IPv4 or IPv6 Subnet/IPPool will be ignored and no default route will be generated. | |||
There was a problem hiding this comment.
no default route will be generated
还是有点歧义 。尽量是如下意思，
当打开 本开关时，无论本网卡的 IP 地址池 中是否设置了 网关ip， 本网关上 最终都 不会生效任何的网关路由
Signed-off-by: ty-dc <tao.yang@daocloud.io>
ty-dc
force-pushed
the
fix-docs/clean-gateway
branch
from
72ce99f
to
8e96ee2
Compare
weizhoublue
reviewed
Jul 11, 2024
| @@ -95,7 +95,7 @@ ipam.spidernet.io/ippools: |- | |||
| - `interface` (string, required): Since the CNI request only carries the information of one interface, the field `interface` shall be specified to distinguish in the case of multiple interfaces. | |||
| - `ipv4` (array, optional): Specify which IPPool is used to allocate the IPv4 address. When `enableIPv4` in the ConfigMap `spiderpool-conf` is set to true, this field is required. | |||
| - `ipv6` (array, optional): Specify which IPPool is used to allocate the IPv6 address. When `enableIPv6` in the ConfigMap `spiderpool-conf` is set to true, this field is required. | |||
| - `cleangateway` (bool, optional): If set to true, the IPAM plugin will not return the default route (generated by `spec.gateway`) recorded in the IPPool. | |||
| - `cleangateway` (bool, optional): If set to true, no gateway routing will take effect on this network card, regardless of whether a gateway IP is set in the IPPool of this network card. | |||
There was a problem hiding this comment.
how about another missing annotation defualt-route in the document
There was a problem hiding this comment.
There are multiple issues. To facilitate tracking, default-route is added in other PRs.
weizhoublue
added
cherrypick-release-v0.8
weizhoublue
approved these changes
Jul 21, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Jul 21, 2024
Optimize cleangateway docs Signed-off-by: robot <tao.yang@daocloud.io>
github-actions bot
pushed a commit
that referenced
this pull request
Jul 21, 2024
Optimize cleangateway docs Signed-off-by: robot <tao.yang@daocloud.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thanks for contributing!
What type of PR is this?
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #3701
Special notes for your reviewer: