smi-spec icon indicating copy to clipboard operation
smi-spec copied to clipboard

Terminology section is missing

Open abonas opened this issue 5 years ago • 1 comments

There are many different verbs and entities mentioned through the spec. However there is no terminology section to actually define them.

For example:

  1. https://github.com/deislabs/smi-spec/blob/560631fa09e12e75d6a00a09eb2787311c0572fd/traffic-specs.md#httproutegroup "It enumerates the routes that can be served by an application." What is an application in this example?

  2. "This resource allows users to incrementally direct percentages of traffic between various services" What is a service? A Kubernetes service? the pods that have the same label that a service selects? anything else?

  3. "Integrations can use this resource to orchestrate canary releases for new versions of software" https://github.com/deislabs/smi-spec/blob/master/traffic-split.md#traffic-split Software should probably be replaced with a different word here - service/app (pending the definition for those too). But what is missing IMO is a definition for multiple versions - how SMI represents several versions of the same app/service?

  4. Define backends

  5. What are referential services mentioned in traffic split spec?

abonas avatar May 22 '19 12:05 abonas

define root service

abonas avatar Jun 05 '19 12:06 abonas