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

Meta issue for research resource naming restrictions in each cloud provider #1257

Closed
viniciusdc opened this issue Apr 21, 2022 · 4 comments
Closed
Labels
needs: discussion 💬 Needs discussion with the rest of the team

Comments

@viniciusdc
Copy link
Contributor

This is needed to reassure some of our project naming conventions and update any missing constraint present on #761

@viniciusdc
Copy link
Contributor Author

viniciusdc commented Apr 25, 2022

Naming convention

When you create a new resource on each one of the cloud providers, you will have to provide properties such as a name, project id, bucket, etc... for the resource. As Qhub mainly uses the project name from config to populate those attributes, we must ensure that for such cases, the resource attribute/name meets the following conventions (unless specified differently in the documentation for creating that resource):

Provider Merged Convention Source
AWS - Must be between 3-47 characters in length;
- Must begin with an alphanumeric character, and must only contain alphanumeric lowercase characters, dashes, and underscores;
- The name cannot start with AWS or aws.
- EKS cluster name
- AWS resource group name
- S3 bucket
GCP - Be 1-63 characters in length;
- Comply with RFC 1035 conventions;
- The first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
- google service account id;
- google compute network name
- google compute subnetwork name
Azure - Between 3 and 16 characters long;
- Start and end with alphanumeric;
- lowercase alphanumerics
- AKS cluster name
- Storage Account name
- Resource Group name
- container registry name
DO - Could not find any conventions. - NA

@viniciusdc viniciusdc added the needs: discussion 💬 Needs discussion with the rest of the team label Apr 25, 2022
@iameskild
Copy link
Member

@viniciusdc thanks a lot for the detailed table!!

I think it might be worth including the following restrictions as well:

  • AWS
    • "Bucket names must not start with the prefix xn--."
    • "Bucket names must not end with the suffix -s3alias."

Otherwise this looks great :)

@viniciusdc
Copy link
Contributor Author

@viniciusdc thanks a lot for the detailed table!!

I think it might be worth including the following restrictions as well:

  • AWS

    • "Bucket names must not start with the prefix xn--."
    • "Bucket names must not end with the suffix -s3alias."

Otherwise this looks great :)

Hi @iameskild thanks!!! I only looked for the terraform state bucket but didn't check this one. I will add those to the PR directly. 😄

@viniciusdc
Copy link
Contributor Author

The only thing that ended up not being added was the restriction for AWS that @iameskild suggested above, once we work on #1267 we can add the missing conventions. For now, I will let this as a comment on the mentioned issue and close this one as the research was used to update #761

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: discussion 💬 Needs discussion with the rest of the team
Projects
None yet
Development

No branches or pull requests

2 participants