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

FQDN up to 25 characters #4900

Merged
merged 2 commits into from
Apr 6, 2021
Merged

FQDN up to 25 characters #4900

merged 2 commits into from
Apr 6, 2021

Conversation

kagarmoe
Copy link

@kagarmoe kagarmoe commented Apr 1, 2021

Signed-off-by: kagarmoe kgarmoe@chef.io

🔩 Description: What code changed, and why?

Define the length of the FQDN in the configurations doc.
Includes some linting cleanup.

⛓️ Related Resources

#4890

👍 Definition of Done

👟 How to Build and Test the Change

✅ Checklist

All PRs must tick these:

With occasional exceptions, all PRs from Progress employees must tick these:

  • Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
  • Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
  • Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
  • Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
  • Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

  • Tests added/updated? (all new code needs new tests)
  • Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

Signed-off-by: kagarmoe <kgarmoe@chef.io>
@kagarmoe kagarmoe requested a review from SEAjamieD April 1, 2021 23:04
@netlify
Copy link

netlify bot commented Apr 1, 2021

Deploy preview for chef-automate ready!

Built with commit 112f00c

https://deploy-preview-4900--chef-automate.netlify.app

@@ -31,7 +31,7 @@ This section describes those settings and how to change them on an existing Chef

#### Chef Automate FQDN

To change the fully qualified domain name (FQDN) of your Chef Automate installation, create a TOML file that contains the partial configuration:
The maximum size of a customized fully qualified domain name (FQDN) is 25 characters. To change the of your Chef Automate installation, create a TOML file that contains the partial configuration:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lost a subject in there.

Suggested change
The maximum size of a customized fully qualified domain name (FQDN) is 25 characters. To change the of your Chef Automate installation, create a TOML file that contains the partial configuration:
The maximum size of a customized fully qualified domain name (FQDN) is 25 characters. To change the FQDN of your Chef Automate installation, create a TOML file that contains the partial configuration:

@@ -31,7 +31,7 @@ This section describes those settings and how to change them on an existing Chef

#### Chef Automate FQDN

To change the fully qualified domain name (FQDN) of your Chef Automate installation, create a TOML file that contains the partial configuration:
The maximum size of a customized fully qualified domain name (FQDN) is 25 characters. To change the of your Chef Automate installation, create a TOML file that contains the partial configuration:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good guess, but, well, not so much. There is no limit on the size of the whole FQDN string.
The 25-character limit is only after the final dot, so something like this is invalid:
http://www.foo.this-portion-is-probably-too-long

Copy link
Author

@kagarmoe kagarmoe Apr 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SEAjamieD So 25 characters for the top-level domain?

http://www.foo.this-portion-is-probably-too-long
<scheme>://<subdomain>.<second-level domain>.<top-level domain>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kagarmoe - Correct, thank you!

Copy link
Contributor

@SEAjamieD SEAjamieD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pending and update for @msorens comment below, this is good for our needs. Thanks so much!

There is no limit on the size of the whole FQDN string.
The 25-character limit is only after the final dot, so something like this is invalid:
http://www.foo.this-portion-is-probably-too-long

Signed-off-by: kagarmoe <kgarmoe@chef.io>
@kalroy kalroy merged commit e80cb98 into master Apr 6, 2021
@kalroy kalroy deleted the kg/FQDN25 branch April 6, 2021 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants