-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
Allow changing subnet/kube annotation prefix #997
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // Copyright 2018 flannel authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package kube | ||
|
|
||
| import ( | ||
| "errors" | ||
| "regexp" | ||
| "strings" | ||
| ) | ||
|
|
||
| type annotations struct { | ||
| SubnetKubeManaged string | ||
| BackendData string | ||
| BackendType string | ||
| BackendPublicIP string | ||
| BackendPublicIPOverwrite string | ||
| } | ||
|
|
||
| func newAnnotations(prefix string) (annotations, error) { | ||
| slashCnt := strings.Count(prefix, "/") | ||
| if slashCnt > 1 { | ||
| return annotations{}, errors.New("subnet/kube: prefix can contain at most single slash") | ||
| } | ||
| if slashCnt == 0 { | ||
| prefix += "/" | ||
| } | ||
| if !strings.HasSuffix(prefix, "/") && !strings.HasSuffix(prefix, "-") { | ||
| prefix += "-" | ||
| } | ||
|
|
||
| // matches is a regexp matching the format used by the kubernetes for | ||
| // annotations. Following rules apply: | ||
| // | ||
| // - must start with FQDN - must contain at most one slash "/" | ||
| // - must contain only lowercase letters, nubers, underscores, | ||
| // hyphens, dots and slash | ||
| matches, err := regexp.MatchString(`(?:[a-z0-9_-]+\.)+[a-z0-9_-]+/(?:[a-z0-9_-]+-)?$`, prefix) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| if !matches { | ||
| return annotations{}, errors.New("subnet/kube: prefix must be in a format: fqdn/[0-9a-z-_]*") | ||
| } | ||
|
|
||
| a := annotations{ | ||
| SubnetKubeManaged: prefix + "kube-subnet-manager", | ||
| BackendData: prefix + "backend-data", | ||
| BackendType: prefix + "backend-type", | ||
| BackendPublicIP: prefix + "public-ip", | ||
| BackendPublicIPOverwrite: prefix + "public-ip-overwrite", | ||
| } | ||
|
|
||
| return a, nil | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| // Copyright 2018 flannel authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package kube | ||
|
|
||
| import "testing" | ||
|
|
||
| func Test_newAnnotations(t *testing.T) { | ||
| testCases := []struct { | ||
| prefix string | ||
| expectedBackendType string | ||
| hasError bool | ||
| }{ | ||
| { | ||
| prefix: "flannel.alpha.coreos.com", | ||
| expectedBackendType: "flannel.alpha.coreos.com/backend-type", | ||
| }, | ||
| { | ||
| prefix: "flannel.alpha.coreos.com/", | ||
| expectedBackendType: "flannel.alpha.coreos.com/backend-type", | ||
| }, | ||
| { | ||
| prefix: "flannel.alpha.coreos.com/prefix", | ||
| expectedBackendType: "flannel.alpha.coreos.com/prefix-backend-type", | ||
| }, | ||
| { | ||
| prefix: "flannel.alpha.coreos.com/prefix-", | ||
| expectedBackendType: "flannel.alpha.coreos.com/prefix-backend-type", | ||
| }, | ||
| { | ||
| prefix: "org.com", | ||
| expectedBackendType: "org.com/backend-type", | ||
| }, | ||
| { | ||
| prefix: "org9.com", | ||
| expectedBackendType: "org9.com/backend-type", | ||
| }, | ||
| { | ||
| prefix: "org.com/9", | ||
| expectedBackendType: "org.com/9-backend-type", | ||
| }, | ||
| { | ||
| // Not a fqdn. | ||
| prefix: "org", | ||
| hasError: true, | ||
| }, | ||
| { | ||
| // Not a fqdn before /. | ||
| prefix: "org/", | ||
| hasError: true, | ||
| }, | ||
| { | ||
| // Not a fqdn before /. | ||
| prefix: "org/prefix", | ||
| hasError: true, | ||
| }, | ||
| { | ||
| // Uppercase letters. | ||
| prefix: "org.COM", | ||
| hasError: true, | ||
| }, | ||
| { | ||
| // Uppercase letters. | ||
| prefix: "org.com/PREFIX", | ||
| hasError: true, | ||
| }, | ||
| } | ||
|
|
||
| for i, tc := range testCases { | ||
| as, err := newAnnotations(tc.prefix) | ||
|
|
||
| if err != nil && !tc.hasError { | ||
| t.Errorf("#%d: error = %s, want nil", i, err) | ||
| continue | ||
| } | ||
| if err == nil && tc.hasError { | ||
| t.Errorf("#%d: error = nil, want non-nil", i) | ||
| continue | ||
| } | ||
|
|
||
| if as.BackendType != tc.expectedBackendType { | ||
| t.Errorf("#%d: BackendType = %s, want %s", i, as.BackendType, tc.expectedBackendType) | ||
| } | ||
| } | ||
| } |
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
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.
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.
What's the reasoning behind supporting both with and without a slash?
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.
My idea was to add a trailing slash if the annotation doesn't contain any. Please check test cases I copied here. They show how the flag value is transformed to the final annotation name.
This would be useful for us. We'd like to to have prefixes like
flannel.alpha.coreos.com/some-id-. I'm fine with changing that. Let me know what is your preference.