Add ADR and appnote specifying get_urls label format #72
Conversation
j616
force-pushed
the
jamessa-getUrlLabels
branch
from
03c07a2
to
36aaecd
Compare
Co-authored-by: Sam Mesterton-Gibbons <sam.mesterton-gibbons@bbc.co.uk>
j616
force-pushed
the
jamessa-getUrlLabels
branch
from
56878ba
to
c20602a
Compare
| ``` | ||
|
|
||
| The parameters `provider`, `region`, `availabilityZone`, and `storeType` should use the machine readable values as provided by the cloud/storage vendor. | ||
| The intention of this approach is to allow consistent values to be used without enumerating common/possible values in TAMS. |
There was a problem hiding this comment.
Sadly I think a level of enumeration is going to be necessary somewhere for consistency. For example is AWS listed as 'amazon' or 'aws'? Regions is probably the simplest for public clouds as you can take their naming convention, eg 'eu-west-1', however the same will be necessary at the storage product level for example to describe S3 Express One Zone in a common way.
These probably will ultimately need to end up in an app note somewhere similar to the tags list, so not part of the API spec or validation
There was a problem hiding this comment.
Hm. Is there no consistency in the likes of ARN's for aws? I'd expected inconsistency in documentation, but hoped for consistency in configuration.
There was a problem hiding this comment.
Apologies, I missed the line directly above stating where the values should come from. While the AWS ARN structure is well defined there are some oddities that stand out like s3 buckets not having the region defined. Similarly while the majority of services define the AZ in the format eu-west-1a, I have seen some exceptions to this. Ultimately it might be worth either pointing to where the enumerations come from, or alternatively giving some examples for a few of the most common storage platforms.
There was a problem hiding this comment.
I've expanded explanations and added examples in c46f8c3
Co-authored-by: Sam Mesterton-Gibbons <sam.mesterton-gibbons@bbc.co.uk>
Details
Add ADR and appnote specifying get_urls label format
Pivotal Story (if relevant)
Story URL: https://www.pivotaltracker.com/story/show/187593257
Related PRs
Where appropriate. Indicate order to be merged.
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.