Optimize package organization to reduce antctl binary size #6037
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
tnqn
added
action/release-note
tnqn
force-pushed
the
reduce-antctl-size
branch
6 times, most recently
from
9abb34a to
8735ba7
Compare
|
/test-all |
|
/test-ipv6-e2e |
antoninbas
previously approved these changes
Feb 29, 2024
|
/test-ipv6-e2e |
|
@tnqn anything blocking this? |
I was waiting for other large PRs to merge to avoid their rework, e.g. NetworkPolicyEvaluation, K8s lib upgrade. |
tnqn
force-pushed
the
reduce-antctl-size
branch
5 times, most recently
from
e1ce909 to
3c5f96c
Compare
|
/test-all |
antoninbas
previously approved these changes
Mar 27, 2024
pkg/util/k8s/name.go
Outdated
Comment on lines
59
to
64
| // GetServiceDNSNames returns the DNS names that can be used to access the given Service. | ||
| func GetServiceDNSNames(namespace, serviceName string) []string { | ||
| antreaServerName := serviceName + "." + namespace + ".svc" | ||
| // TODO: Although antrea-agent and kube-aggregator only verify the server name "antrea.<Namespace>.svc", | ||
| // We should add the whole FQDN "antrea.<Namespace>.svc.<Cluster Domain>" as an alternate DNS name when | ||
| // other clients need to access it directly with that name. | ||
| return []string{antreaServerName} | ||
| } |
There was a problem hiding this comment.
The location in this package and the name of the function make it sound like it is "generic", but then the variable name antreaServerName and the TODO comment kind of make it Antrea-specific.
It's kind of a minor comment though. Maybe we could just rename the variable to something more appropriate.
There was a problem hiding this comment.
Good catch. I missed updating it when moving the function.
Updated.
As a client, antctl needs to know some well-known resource names and the structs of the API responses. However, the code placement makes antctl import a lot of packages which are supposed to be consumed by server side code, e.g. antrea-controller, antrea-agent. This patch refactors relevant packages, extracts well-known resources names and API structs to separate common packages, mostly apis packages. It reduces antctl binary size by 10MB, from 55MB to 45MB. The placement also makes it more explicit that these constants and structs are API related and should be changed more carefully. The major changes are as follows: 1. Move well-known CRD resource names to types.go files which declare these CRD structs. 2. Move other well-known resource names to package pkg/apis. 3. Move structs of API responses to package apis of components which provide the corresponding APIs. Signed-off-by: Quan Tian <[email protected]>
tnqn
force-pushed
the
reduce-antctl-size
branch
from
3c5f96c to
4078c98
Compare
|
/test-all |
antoninbas
approved these changes
Mar 28, 2024
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.
As a client, antctl needs to know some well-known resource names and the structs of the API responses. However, the code placement makes antctl import a lot of packages which are supposed to be consumed by server side code, e.g. antrea-controller, antrea-agent.
This patch refactors relevant packages, extracts well-known resources names and API structs to separate common packages, mostly apis packages. It reduces antctl binary size by 10MB, from 55MB to 45MB. The placement also makes it more explicit that these constants and structs are API related and should be changed more carefully.
The major changes are as follows:
types.gofiles which declare these CRD structs.pkg/apis.apisof components which provide the corresponding APIs.For #5883
Before:
After: