Skip to content
This repository has been archived by the owner on Oct 20, 2023. It is now read-only.

rename TrafficTarget to TrafficAccess #177

Closed
1 of 5 tasks
michelleN opened this issue Jul 14, 2020 · 6 comments
Closed
1 of 5 tasks

rename TrafficTarget to TrafficAccess #177

michelleN opened this issue Jul 14, 2020 · 6 comments
Labels
proposal Propose changes to the SMI specification

Comments

@michelleN
Copy link
Contributor

Describe the proposal
rename TrafficTarget to TrafficAccess

Scope

  • New specification
  • Traffic Access Control
  • Traffic Specs
  • Traffic Metrics
  • Traffic Split

Possible use cases
This might be easier to understand and more intuitive. Would love to know the origin of the name TrafficTarget if someone has context.
@michelleN michelleN added the proposal Propose changes to the SMI specification label Jul 14, 2020
@stefanprodan
Copy link
Contributor

I think TrafficAccess better defines what the API does 👍

@patricekrakow
Copy link
Contributor

Indeed, when I started to look at SMI, I have been confused by this suffix "Target". The API is called "Traffic Access Control" in the documentation, the API Group is access.smi-spec.io, and the kind is TrafficTarget, and not (yet?) TrafficAccess.

@michelleN michelleN assigned michelleN and unassigned michelleN Sep 16, 2020
@patricekrakow
Copy link
Contributor

@michelleN I can make the PR for this one if it's OK with you.

@michelleN
Copy link
Contributor Author

That would be great. Thank you @patricekrakow

@patricekrakow
Copy link
Contributor

Before I start with the PR, I would like to summarize the possible options I see.

AS-IS

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficTarget
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

TO-BE Options

The changes will be shown in italic

Option 1

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficAccess
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 2

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access access TrafficAccess
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 3

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access-control TrafficAccessControl
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Option 4

APIs group Kind(s)
Traffic Specs specs HTTPRouteGroup, TCPRoute
Traffic Access Control access TrafficAccessControl
Traffic Split split TrafficSplit
Traffic Metrics metrics TrafficMetrics, TrafficMetricsList

Let me know if you have a preference for any of these options, or even another permutation I would have missed...

@michelleN
Copy link
Contributor Author

Hey @patricekrakow - option 2 looks the most clear to me. Would you still be able to work on this issue?

cc/ @johnsonshi

@johnsonshi johnsonshi mentioned this issue Jun 28, 2021
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
proposal Propose changes to the SMI specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename TrafficTarget to TrafficAccess.
4 participants
@michelleN @bridgetkromhout @stefanprodan @patricekrakow