Documentation
¶
Index ¶
Constants ¶
const DefaultTarget = ""
DefaultTarget is the unnamed default target for the traffic.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // Group of traffic splits. Un-named targets are grouped together // under the key `DefaultTarget`, and named target are under the respective // name. This is used to configure network configuration to // realize a route's setting. Targets map[string]RevisionTargets // Visibility of the traffic targets. Visibility map[string]netv1alpha1.IngressVisibility // The referred `Configuration`s and `Revision`s. Configurations map[string]*v1.Configuration Revisions map[string]*v1.Revision // MissingTargets are references to Configurations or Revisions // that are missing MissingTargets []corev1.ObjectReference // contains filtered or unexported fields }
Config encapsulates details of our traffic so that we don't need to make API calls, or use details of the route beyond its ObjectMeta to make routing changes.
func BuildTrafficConfiguration ¶
func BuildTrafficConfiguration(configLister listers.ConfigurationLister, revLister listers.RevisionLister, r *v1.Route) (*Config, error)
BuildTrafficConfiguration consolidates and flattens the Route.Spec.Traffic to the Revision-level. It also provides a complete lists of Configurations and Revisions referred by the Route, directly or indirectly. These referred targets are keyed by name for easy access.
In the case that some target is missing, an error of type TargetError will be returned.
func (*Config) BuildRollout ¶ added in v0.19.0
BuildRollout builds the current rollout state. It is expected to be invoked after applySpecTraffic. Returned Rollout will be sorted by tag and within tag by configuration (only default tag can have more than configuration object attached). TODO(vagababov): actually deal with rollouts, vs just report desired state.
func (*Config) GetRevisionTrafficTargets ¶
func (cfg *Config) GetRevisionTrafficTargets(ctx context.Context, r *v1.Route) ([]v1.TrafficTarget, error)
GetRevisionTrafficTargets returns a list of TrafficTarget flattened to the RevisionName, and having ConfigurationName cleared out.
type ConfigurationRollout ¶ added in v0.19.0
type ConfigurationRollout struct { // Name + tag pair uniquely identifies the rollout target. // `tag` will be empty, if this is the `DefaultTarget`. ConfigurationName string `json:"configurationName"` Tag string `json:"tag,omitempty"` // Percent denotes the total percentage for this configuration. // The individual percentages of the Revisions below will sum to this // number. Percent int `json:"percent"` // The revisions in the rollout. In steady state this should // contain 0 (no revision is ready) or 1 (rollout done). // During the actual rollout it will contain N revisions // ordered from oldest to the newest. // At the end of the rollout the latest (the tail of the list) // will receive 100% of the traffic sent to the key. // Note: that it is not 100% of the route traffic, in more complex cases. Revisions []RevisionRollout `json:"revisions,omitempty"` }
ConfigurationRollout describes the rollout state for a given config+tag pair.
type RevisionRollout ¶ added in v0.19.0
type RevisionRollout struct { // Name of the revision. RevisionName string `json:"revisionName"` // How much traffic is routed to the revision. This is a share // of total Route traffic, not the relative share of configuration // target percentage. Percent int `json:"percent"` }
RevisionRollout describes the revision in the config rollout.
type RevisionTarget ¶
type RevisionTarget struct { v1.TrafficTarget Protocol net.ProtocolType ServiceName string // Revision service name. }
A RevisionTarget adds the transport protocol and the service name of a Revision to a flattened TrafficTarget.
type RevisionTargets ¶
type RevisionTargets []RevisionTarget
RevisionTargets is a collection of revision targets.
type Rollout ¶ added in v0.19.0
type Rollout struct { // Configurations are sorted by tag first and within same tag, by configuration name. Configurations []ConfigurationRollout `json:"configurations,omitempty"` }
Rollout encapsulates the current rollout state of the system. Since the route might reference more than one configuration.
There may be several rollouts going on at the same time for the same configuration if there is a tag configured traffic target.
type TargetError ¶
type TargetError interface { error // MarkBadTrafficTarget marks a RouteStatus with Condition corresponding // to the error case of the traffic target. MarkBadTrafficTarget(rs *v1.RouteStatus) // IsFailure returns whether a TargetError is a true failure, e.g. // a Configuration fails to become ready. IsFailure() bool }
TargetError gives details about an invalid traffic target.