Add Antrea architecture doc #1
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
|
Great to see our first PR! |
antoninbas
approved these changes
Nov 1, 2019
abhiraut
reviewed
Nov 1, 2019
| Antrea Agent includes two Kubernetes controllers: | ||
| - The Node controller watches the Kubernetes API server for new Nodes, and | ||
| creates an OVS (VXLAN or Geneve) tunnel to each remote Node. | ||
| - The NetworkPolicy controller watches the computed NetworkPolicies from the |
There was a problem hiding this comment.
should we call this a client ? because we say NetworkPolicy controller is in Antrea Controller and it makes sense there... need to differentiate between the two to avoid confusion.
There was a problem hiding this comment.
But it is indeed a K8s controller and called NetworkPolicyController in code.
There was a problem hiding this comment.
lets call it Antrea NetworkPolicy Controller?.. because technically it is not syncing the networkingv1.NetworkPolicy objects but Antrea NetworkPolicy Object disseminated by antrea-controller. do you agree?
There was a problem hiding this comment.
From this perspective, the k8s DeploymentController is also not syncing the Deployment itself but the pods/replica rets managed by it. Maybe it's fine as long as people can get a brief idea about what's the controller for from the name?
What I'm worrying more is the name of NodeController, it's a little hard to get what's it without reading the documentation. I'd propose to rename the package to noderoute and the controller NodeRouteController, what do you think? (mapping to k8s nodeipam and nodelifecycle controllers). Of course, this is out of this PR's scope, just want to discuss here.
There was a problem hiding this comment.
I feel the current description is fine. Like @tnqn said, we explained what the controllers are doing.
I support to rename NodeController to NoteRouteController, but let us change the code first.
There was a problem hiding this comment.
i just feel like the network policy object and network policy crd for controller are different .. the latter is more specific to antrea controller.. but if you guys believe it sounds clear to the readers.. then no need to change
NodeRouteController does convey the correct message
jianjuns
force-pushed
the
jianjuns/architecture-doc
branch
2 times, most recently
from
433588e to
dd2fad0
Compare
tnqn
reviewed
Nov 2, 2019
| Antrea Agent includes two Kubernetes controllers: | ||
| - The Node controller watches the Kubernetes API server for new Nodes, and | ||
| creates an OVS (VXLAN or Geneve) tunnel to each remote Node. | ||
| - The NetworkPolicy controller watches the computed NetworkPolicies from the |
There was a problem hiding this comment.
From this perspective, the k8s DeploymentController is also not syncing the Deployment itself but the pods/replica rets managed by it. Maybe it's fine as long as people can get a brief idea about what's the controller for from the name?
What I'm worrying more is the name of NodeController, it's a little hard to get what's it without reading the documentation. I'd propose to rename the package to noderoute and the controller NodeRouteController, what do you think? (mapping to k8s nodeipam and nodelifecycle controllers). Of course, this is out of this PR's scope, just want to discuss here.
jianjuns
force-pushed
the
jianjuns/architecture-doc
branch
from
dd2fad0 to
c3400d5
Compare
Also add links to the architecture doc from REAME.md and CONTRIBUTING.md.
jianjuns
force-pushed
the
jianjuns/architecture-doc
branch
from
c3400d5 to
05e9cb3
Compare
jayunit100
added a commit
to jayunit100/antrea
that referenced
this pull request
Feb 26, 2020
dreamtalen
referenced
this pull request
in dreamtalen/antrea
Dec 2, 2020
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: luolanzone <luola@vmware.com>
abhiraut
pushed a commit
that referenced
this pull request
Aug 12, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
aravindakidambi
pushed a commit
to aravindakidambi/antrea
that referenced
this pull request
Aug 12, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 27, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 30, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Aug 30, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Sep 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Sep 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
referenced
this pull request
in luolanzone/antrea
Sep 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Nov 4, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Nov 8, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Nov 10, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Nov 15, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Nov 22, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
Merged
luolanzone
added a commit
that referenced
this pull request
Dec 13, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Dec 22, 2021
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 16, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 18, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 18, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 19, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 19, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
luolanzone
added a commit
that referenced
this pull request
Jan 20, 2022
1. remove namespace in config/manager/manager.yaml, so we won't have a `kube-system` namespace definition in multi-cluster.yaml 2. use `KUSTOMIZE = $(shell pwd)/bin/kustomize` in Makefile, otherwise,it will do nothing if KUSTOMIZE is empty by `shell which kustomize` 3. add a common label `app: antrea` for all resources 4. other changes are auto-generated by `make manifests` Signed-off-by: Lan Luo <luola@vmware.com>
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.
Also add links to the architecture doc from REAME.md and
CONTRIBUTING.md.
Many thanks to @antoninbas for making great revisions of the doc and taking care of SVG diagrams.