-
Notifications
You must be signed in to change notification settings - Fork 15
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: align kubernetes cluster name validation with EKS #64
Open
cartermckinnon
wants to merge
2
commits into
bottlerocket-os:develop
Choose a base branch
from
cartermckinnon:develop
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -311,14 +311,20 @@ mod test_kubernetes_taint_value { | |||||
|
||||||
/// KubernetesClusterName represents a string that contains a valid Kubernetes cluster name. It | ||||||
/// stores the original string and makes it accessible through standard traits. | ||||||
// Note: I was unable to find the rules for cluster naming. We know they have to fit into label | ||||||
// values, because of the common cluster-name label, but they also can't be empty. This combines | ||||||
// those two characteristics into a new type, until we find an explicit syntax. | ||||||
// Note: this uses the EKS rules for cluster naming. | ||||||
#[derive(Debug, Clone, Eq, PartialEq, Hash)] | ||||||
pub struct KubernetesClusterName { | ||||||
inner: String, | ||||||
} | ||||||
|
||||||
lazy_static! { | ||||||
pub(crate) static ref KUBERNETES_CLUSTER_NAME: Regex = Regex::new( | ||||||
// follow EKS cluster name requirements: https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html#API_CreateCluster_RequestSyntax | ||||||
r"^[0-9A-Za-z][A-Za-z0-9\-_]{0,99}$" | ||||||
) | ||||||
.unwrap(); | ||||||
} | ||||||
|
||||||
impl TryFrom<&str> for KubernetesClusterName { | ||||||
type Error = error::Error; | ||||||
|
||||||
|
@@ -331,13 +337,12 @@ impl TryFrom<&str> for KubernetesClusterName { | |||||
} | ||||||
); | ||||||
ensure!( | ||||||
KubernetesLabelValue::try_from(input).is_ok(), | ||||||
error::InvalidClusterNameSnafu { | ||||||
name: input, | ||||||
msg: "cluster names must be valid Kubernetes label values" | ||||||
KUBERNETES_CLUSTER_NAME.is_match(input), | ||||||
error::BigPatternSnafu { | ||||||
thing: "Kubernetes cluster name", | ||||||
input | ||||||
} | ||||||
); | ||||||
|
||||||
Ok(KubernetesClusterName { | ||||||
inner: input.to_string(), | ||||||
}) | ||||||
|
@@ -353,14 +358,14 @@ mod test_kubernetes_cluster_name { | |||||
|
||||||
#[test] | ||||||
fn good_cluster_names() { | ||||||
for ok in &["more-chars_here.now", &"a".repeat(63)] { | ||||||
for ok in &["more-chars_here-123", &"a".repeat(100)] { | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: maybe a couple more test cases since we now allow trailing dashes and underscores:
Suggested change
|
||||||
KubernetesClusterName::try_from(*ok).unwrap(); | ||||||
} | ||||||
} | ||||||
|
||||||
#[test] | ||||||
fn bad_values() { | ||||||
for err in &["", ".bad", "bad.", &"a".repeat(64)] { | ||||||
for err in &["", "bad.", "-bad", "_bad", "very bad", &"a".repeat(101)] { | ||||||
KubernetesClusterName::try_from(*err).unwrap_err(); | ||||||
} | ||||||
} | ||||||
|
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.
.
no longer being an allowed character is the only notable change in this PR, I think