v1alpha1

type Policy struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds info about the desired traffic behavior
	// +optional
	Spec PolicySpec `json:"spec,omitempty"`

	// Status holds info about the current traffic behavior
	// +optional
	Status PolicyStatus `json:"status,omitempty"`
}

type PolicyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Policy `json:"items"`
}

type PolicySpec struct {
	// Mode specifies the metric that the policy is based on
	// Possible values are: "time", "request", "error"
	Mode string `json:"mode"`

	// DefaultThreshold is the threshold value that is used when a rollout stage doesn't specify
	// a threshold of its own; this can be useful when the threshold is a constant value across
	// all rollout stages, in which case there is no need to copy paste the same value in all entries
	// The interpretation of DefaultThreshold depends on the value of Mode
	DefaultThreshold int `json:"defaultThreshold"`

	// Stages specifies the traffic percentages that the NEW Revision is expected to have
	// at successive rollout stages; the list of integers must start at 0
	// all entries must be in the range [0, 100), and must be sorted in increasing order
	// Technically the final rollout percentage is 100, but this is implicitly understood,
	// and should NOT be explicitly specified in Stages
	// In addition to the traffic percentages, each stage can OPTIONALLY specify its own threshold
	// this gives greater flexibility to policy design
	// The threshold value for stage N is the value that must be achieved BEFORE moving to stage N+1
	Stages []Stage `json:"stages,omitempty"`
}

type PolicyState struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds info about what the routing state SHOULD be
	// +optional
	Spec PolicyStateSpec `json:"spec,omitempty"`

	// Status holds info about what routing state has been written by the webhook
	// +optional
	Status PolicyStateStatus `json:"status,omitempty"`
}

type PolicyStateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []PolicyState `json:"items"`
}

type PolicyStateSpec struct {
	// Traffic specifies how to distribute traffic over a collection of
	// revisions and configurations.
	Traffic []v1.TrafficTarget `json:"traffic,omitempty"`
}

type PolicyStateStatus struct {
	duckv1.Status `json:",inline"`

	PolicyStateStatusFields `json:",inline"`
}

type PolicyStateStatusFields struct {
	// NextUpdateTimestamp specifies the next time when this PolicyState spec should be updated
	// it is used in conjunction with EnqueueAfter to help reconciler enforce time-based policies
	// it also helps prevent unexpected rollout behavior when controller restarts, etc.
	// optional because when a rollout is completed there is no more future updates to be done
	NextUpdateTimestamp *metav1.Time `json:"nextUpdateTimestamp,omitempty"`

	// Traffic describes the current routing spec that the webhook has enforced
	// If this doesn't agree with Spec.Traffic, then the webhook SetDefaults must set them to agree with each other
	Traffic []v1.TrafficTarget `json:"traffic,omitempty"`
}

type PolicyStatus struct {
	duckv1.Status `json:",inline"`

	PolicyStatusFields `json:",inline"`
}

type PolicyStatusFields struct{}

type Stage struct {
	// Percent is the percentage of traffic that should go to the new Revision at this stage
	Percent int `json:"percent"`

	// Threshold tells the condition for progressing to the next rollout stage
	// This field is optional; if not specified, then the threshold value defaults to PolicySpec.DefaultThreshold
	Threshold *int `json:"threshold,omitempty"`
}