-
Notifications
You must be signed in to change notification settings - Fork 74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Optimize cleangateway docs #3704
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no default route will be generated
还是有点歧义 。尽量是如下意思,
当打开 本开关时,无论本网卡的 IP 地址池 中是否设置了 网关ip, 本网关上 最终都 不会生效任何的网关路由
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
Signed-off-by: ty-dc <tao.yang@daocloud.io>
72ce99f
to
8e96ee2
Compare
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about another missing annotation defualt-route
in the document
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are multiple issues. To facilitate tracking, default-route is added in other PRs.
Optimize cleangateway docs Signed-off-by: robot <tao.yang@daocloud.io>
Optimize cleangateway docs Signed-off-by: robot <tao.yang@daocloud.io>
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: