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

Remove Traffic Router Profile name restrictions #6213

Merged
merged 9 commits into from
May 23, 2022

Conversation

ocket8888
Copy link
Contributor

@ocket8888 ocket8888 commented Sep 15, 2021

This PR removes restrictions previously placed on the names of Profiles used by Traffic Routers. From the docs:

For legacy reasons, the names of Profiles of this type must begin with CCR_ or TR_. This is not enforced by the Traffic Ops API or Traffic Portal, but certain Traffic Control operations/components expect this and will fail to work otherwise!

However, as can been seen in these changes, that's not even actually strictly true. TR_ prefixes were not supported by the /cdns/domains Traffic Ops API endpoint.

After this PR, however, TO only checks for the correct Profile type (TRAFFIC_ROUTER), not pattern-matching on the name at all.

This is potentially breaking, but only in the extremely weird scenario where Traffic Router servers were using a Profile for some other type of server (since Profile types are immutable, it's not conceivable that someone would have e.g. TRAFFIC_ROUTER_1 as a Profile type, so the Profile type must be some other valid type e.g. TRAFFIC_PORTAL). I believe Traffic Portal would disallow such an assignment anyway, but I'm not certain.

This addresses - but doesn't itself close, without #6218 - #2564.


Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Ops
  • CDN in a Box

What is the best way to verify this PR?

Make sure that all tests pass - existing tests do exercise these endpoints, which should prove that CCR_ as a prefix still works. To prove that other things still work, CiaB helps by simply being able to run without the prefix.

PR submission checklist

  • This PR has tests, of a sort, by affecting CiaB which is itself adequately tested.
  • This PR has documentation
  • This PR has a CHANGELOG.md entry
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

@ocket8888 ocket8888 added Traffic Ops related to Traffic Ops documentation related to documentation tech debt rework due to choosing easy/limited solution cdn-in-a-box related to the Docker-based CDN-in-a-Box system labels Sep 15, 2021
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 224e7ea to c600082 Compare September 16, 2021 14:06
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from c600082 to 208641b Compare October 5, 2021 15:26
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 208641b to 22ec0e8 Compare October 22, 2021 16:35
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 22ec0e8 to 00ca751 Compare November 3, 2021 14:44
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 00ca751 to 56a277a Compare February 25, 2022 23:22
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 56a277a to 31b47ce Compare March 7, 2022 22:22
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 31b47ce to 7c1b6e6 Compare May 10, 2022 18:15
@ocket8888 ocket8888 force-pushed the remove-tr-profile-name-restrictions branch from 7c1b6e6 to 752338f Compare May 20, 2022 19:43
@rawlinp rawlinp merged commit 215bb76 into apache:master May 23, 2022
@ocket8888 ocket8888 deleted the remove-tr-profile-name-restrictions branch May 23, 2022 17:17
zrhoffman pushed a commit to zrhoffman/trafficcontrol that referenced this pull request Oct 2, 2022
* Remove restriction on TR Profiles forcing them to be named like 'CCR%'

* Remove incorrect warning from the docs

* Rename CIAB Profile to not use legacy TR Acronym

* Update CHANGELOG

* Remove unnecessary, unused test function from t3c tests

* Add string constants for Profile Types to Go library

* Switch usages in Go source of raw string for ATS_PROFILE to use constant

* Switch usages in Go source of raw string for GROVE_PROFILE to use constant

* Switch usages in Go source of raw string for TR_PROFILE to use constant
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cdn-in-a-box related to the Docker-based CDN-in-a-Box system documentation related to documentation tech debt rework due to choosing easy/limited solution Traffic Ops related to Traffic Ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants