Skip to content
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

fix isDefaultGateway wrong doc #56

Merged
merged 2 commits into from
Jan 18, 2024
Merged

Conversation

arthur-zhang
Copy link
Contributor

isDefaultGateway belongs to bridge delegate, not ipam.

the following is right:

{
  "cniVersion": "1.0.0",
  "name": "cni0",
  "type": "flannel",
  "subnetFile": "/var/run/flannel/subnet.env",
  "dataDir": "/tmp/flannel/",
  "delegate":{
          "isDefaultGateway":true
  }
}

however, if we change to ipam, it will not work

Signed-off-by: arthur-zhang <[email protected]>
@arthur-zhang arthur-zhang changed the title fix wrong doc fix isDefaultGateway wrong doc Dec 6, 2023
Copy link
Collaborator

@manuelbuil manuelbuil left a comment

Choose a reason for hiding this comment

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

Thanks

README.md Outdated
Comment on lines 93 to 95
Additionally, for the bridge plugin, `isGateway` will be set to `true`, if not present.

One use case of the `ipam` configuration is to allow adding back the routes to the cluster services and/or to the hosts when using `isDefaultGateway=false`. In that case, the bridge plugin does not install a default route and, as a result, only pod-to-pod connectivity would be available.
One use case of the `delegate` configuration is to allow adding back the routes to the cluster services and/or to the hosts when using `isDefaultGateway=false`. In that case, the bridge plugin does not install a default route and, as a result, only pod-to-pod connectivity would be available.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for contributing. You have a point but I would rephrase it because delegate configuration does not make much sense. What about this:

Additionally, for the bridge plugin, `isGateway` will be set to `true`, if not present. The bridge plugin includes ``isDefaultGateway` that when false allow adding back the routes to the cluster services and/or to the hosts. In that case, the bridge plugin does not install a default route and, as a result, only pod-to-pod connectivity would be available.

@manuelbuil manuelbuil merged commit 28a4dca into flannel-io:main Jan 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants