v1

package
v0.43.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 23, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1 contains the Serving v1 API types.

Index

Constants

View Source 
const (
	// SOConditionReady is set when the Service Orchestrator has accomplished the transitional upgrade
	// from the old to the new revision.
	SOConditionReady = apis.ConditionReady

	// SOStageReady is set to True, when the current stage of the transition is finished.
	SOStageReady apis.ConditionType = "StageReady"

	// SOLastStageComplete is set to True, when the last stage of the transition is finished.
	SOLastStageComplete apis.ConditionType = "LastStageReady"

	// SOStageScaleUpReady is set to True, when scaling up phase is finished for the current stage of the transition.
	SOStageScaleUpReady apis.ConditionType = "StageScaleUpReady"

	// SOStageScaleDownReady is set to True, when scaling down phase is finished for the current stage of the transition.
	SOStageScaleDownReady apis.ConditionType = "StageScaleDownReady"

	// DirectionUp is the indicator indicating the revision scaling up.
	DirectionUp = "up"

	// DirectionDown is the indicator indicating the revision scaling down.
	DirectionDown = "down"
)
View Source 
const (
	SPAReady apis.ConditionType = "PodAutoscalerStageReady"
)

Variables

View Source 
var (
	// SchemeBuilder registers the addKnownTypes function.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var (
	RevisionRollingInProgress = "RevisionRollingInProgress"
	LastStageNotReached       = "Still in the progress of rolling the new revision."
	StageRevisionStart        = "StageRevisionStart"
	RolloutNewStage           = "Rolling out a new stage."
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: serving.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects.

Functions

func IsRolloutOrchestratorCondition 

func IsRolloutOrchestratorCondition(conditionType apis.ConditionType) bool

IsRolloutOrchestratorCondition returns true if the given ConditionType is a RolloutOrchestratorCondition.

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

Types

type RolloutOrchestrator 

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

	// +optional
	Spec RolloutOrchestratorSpec `json:"spec,omitempty"`

	// +optional
	Status RolloutOrchestratorStatus `json:"status,omitempty"`
}

RolloutOrchestrator represents the orchestrator to launch the new revision and direct the traffic in an incremental way.

func (*RolloutOrchestrator) DeepCopy 

func (in *RolloutOrchestrator) DeepCopy() *RolloutOrchestrator

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RolloutOrchestrator.

func (*RolloutOrchestrator) DeepCopyInto 

func (in *RolloutOrchestrator) DeepCopyInto(out *RolloutOrchestrator)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RolloutOrchestrator) DeepCopyObject 

func (in *RolloutOrchestrator) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*RolloutOrchestrator) GetConditionSet 

func (*RolloutOrchestrator) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*RolloutOrchestrator) GetGroupVersionKind 

func (*RolloutOrchestrator) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*RolloutOrchestrator) GetStatus 

func (so *RolloutOrchestrator) GetStatus() *duckv1.Status

GetStatus retrieves the status of the RolloutOrchestrator. Implements the KRShaped interface.

func (*RolloutOrchestrator) IsFailed 

func (so *RolloutOrchestrator) IsFailed() bool

IsFailed returns true if the resource has observed the latest generation and ready is false.

func (*RolloutOrchestrator) IsInProgress 

func (so *RolloutOrchestrator) IsInProgress() bool

func (*RolloutOrchestrator) IsLastStageComplete added in v0.40.4 

func (so *RolloutOrchestrator) IsLastStageComplete() bool

func (*RolloutOrchestrator) IsNotConvertToOneUpgrade 

func (so *RolloutOrchestrator) IsNotConvertToOneUpgrade() bool

func (*RolloutOrchestrator) IsReady 

func (so *RolloutOrchestrator) IsReady() bool

IsReady returns true if the Status condition SOConditionReady is true and the latest spec has been observed.

func (*RolloutOrchestrator) IsStageFailed 

func (so *RolloutOrchestrator) IsStageFailed() bool

func (*RolloutOrchestrator) IsStageInProgress 

func (so *RolloutOrchestrator) IsStageInProgress() bool

func (*RolloutOrchestrator) IsStageReady 

func (so *RolloutOrchestrator) IsStageReady() bool

func (*RolloutOrchestrator) IsStageScaleUpInProgress 

func (so *RolloutOrchestrator) IsStageScaleUpInProgress() bool

func (*RolloutOrchestrator) IsStageScaleUpReady 

func (so *RolloutOrchestrator) IsStageScaleUpReady() bool

type RolloutOrchestratorList 

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

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

RolloutOrchestratorList is a list of RolloutOrchestrator resources

func (*RolloutOrchestratorList) DeepCopy 

func (in *RolloutOrchestratorList) DeepCopy() *RolloutOrchestratorList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RolloutOrchestratorList.

func (*RolloutOrchestratorList) DeepCopyInto 

func (in *RolloutOrchestratorList) DeepCopyInto(out *RolloutOrchestratorList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RolloutOrchestratorList) DeepCopyObject 

func (in *RolloutOrchestratorList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RolloutOrchestratorSpec 

type RolloutOrchestratorSpec struct {
	// StageTarget holds the information of all revisions during the transition for the current stage.
	StageTarget `json:",inline"`

	// InitialRevisions holds the information of the initial revisions in the initial stage.
	// These entries will always contain RevisionName references.
	// +optional
	InitialRevisions []TargetRevision `json:"initialRevisions,omitempty"`

	// TargetRevisions holds the information of the target revisions in the final stage.
	// These entries will always contain RevisionName references.
	// +optional
	TargetRevisions []TargetRevision `json:"targetRevisions,omitempty"`
}

RolloutOrchestratorSpec holds the desired state of the RolloutOrchestrator (from the client).

func (*RolloutOrchestratorSpec) DeepCopy 

func (in *RolloutOrchestratorSpec) DeepCopy() *RolloutOrchestratorSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RolloutOrchestratorSpec.

func (*RolloutOrchestratorSpec) DeepCopyInto 

func (in *RolloutOrchestratorSpec) DeepCopyInto(out *RolloutOrchestratorSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RolloutOrchestratorStatus 

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

	RolloutOrchestratorStatusFields `json:",inline"`
}

RolloutOrchestratorStatus communicates the observed state of the RolloutOrchestrator (from the controller).

func (*RolloutOrchestratorStatus) DeepCopy 

func (in *RolloutOrchestratorStatus) DeepCopy() *RolloutOrchestratorStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RolloutOrchestratorStatus.

func (*RolloutOrchestratorStatus) DeepCopyInto 

func (in *RolloutOrchestratorStatus) DeepCopyInto(out *RolloutOrchestratorStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RolloutOrchestratorStatus) InitializeConditions 

func (sos *RolloutOrchestratorStatus) InitializeConditions()

InitializeConditions sets the initial values to the conditions.

func (*RolloutOrchestratorStatus) LaunchNewStage 

func (sos *RolloutOrchestratorStatus) LaunchNewStage()

func (*RolloutOrchestratorStatus) MarkLastStageRevisionComplete 

func (sos *RolloutOrchestratorStatus) MarkLastStageRevisionComplete()

MarkLastStageRevisionComplete marks the RolloutOrchestratorLastStageComplete condition to indicate that the revision rollout succeeded for the last stage.

func (*RolloutOrchestratorStatus) MarkLastStageRevisionInComplete 

func (sos *RolloutOrchestratorStatus) MarkLastStageRevisionInComplete()

func (*RolloutOrchestratorStatus) MarkStageRevisionFailed 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionFailed(message string)

MarkStageRevisionFailed marks the RolloutOrchestratorStageReady condition to indicate that the revision rollout failed for the current stage.

func (*RolloutOrchestratorStatus) MarkStageRevisionInProgress 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionInProgress(reason, message string)

func (*RolloutOrchestratorStatus) MarkStageRevisionReady 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionReady()

MarkStageRevisionReady marks the RolloutOrchestratorStageReady condition to indicate that the revision rollout succeeded for the current stage.

func (*RolloutOrchestratorStatus) MarkStageRevisionScaleDownInProgress 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionScaleDownInProgress(reason, message string)

func (*RolloutOrchestratorStatus) MarkStageRevisionScaleDownReady 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionScaleDownReady()

func (*RolloutOrchestratorStatus) MarkStageRevisionScaleUpInProgress 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionScaleUpInProgress(reason, message string)

func (*RolloutOrchestratorStatus) MarkStageRevisionScaleUpReady 

func (sos *RolloutOrchestratorStatus) MarkStageRevisionScaleUpReady()

func (*RolloutOrchestratorStatus) SetStageRevisionStatus 

func (sos *RolloutOrchestratorStatus) SetStageRevisionStatus(stageRevisionStatus []TargetRevision)

type RolloutOrchestratorStatusFields 

type RolloutOrchestratorStatusFields struct {
	// StageRevisionStatus holds the traffic split.
	// +optional
	StageRevisionStatus []TargetRevision `json:"stageRevisionStatus,omitempty"`
}

RolloutOrchestratorStatusFields holds the fields of RolloutOrchestrator's status that are not generally shared. This is defined separately and inlined so that other types can readily consume these fields via duck typing.

func (*RolloutOrchestratorStatusFields) DeepCopy 

func (in *RolloutOrchestratorStatusFields) DeepCopy() *RolloutOrchestratorStatusFields

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RolloutOrchestratorStatusFields.

func (*RolloutOrchestratorStatusFields) DeepCopyInto 

func (in *RolloutOrchestratorStatusFields) DeepCopyInto(out *RolloutOrchestratorStatusFields)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StagePodAutoscaler 

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

	// Spec holds the desired state of the StagePodAutoscaler (from the client).
	// +optional
	Spec StagePodAutoscalerSpec `json:"spec,omitempty"`

	// Status holds the desired state of the StagePodAutoscaler (from the client).
	// +optional
	Status StagePodAutoscalerStatus `json:"status,omitempty"`
}

StagePodAutoscaler is a Knative abstraction that encapsulates the interface.

func (*StagePodAutoscaler) DeepCopy 

func (in *StagePodAutoscaler) DeepCopy() *StagePodAutoscaler

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StagePodAutoscaler.

func (*StagePodAutoscaler) DeepCopyInto 

func (in *StagePodAutoscaler) DeepCopyInto(out *StagePodAutoscaler)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StagePodAutoscaler) DeepCopyObject 

func (in *StagePodAutoscaler) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*StagePodAutoscaler) GetConditionSet 

func (*StagePodAutoscaler) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*StagePodAutoscaler) GetGroupVersionKind 

func (spa *StagePodAutoscaler) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GVK for the PodAutoscaler.

func (*StagePodAutoscaler) GetStatus 

func (spa *StagePodAutoscaler) GetStatus() *duckv1.Status

GetStatus retrieves the status of the StagePodAutoscaler. Implements the KRShaped interface.

func (*StagePodAutoscaler) IsStageScaleInProgress 

func (spa *StagePodAutoscaler) IsStageScaleInProgress() bool

func (*StagePodAutoscaler) IsStageScaleInReady 

func (spa *StagePodAutoscaler) IsStageScaleInReady() bool

func (*StagePodAutoscaler) ScaleBounds 

func (spa *StagePodAutoscaler) ScaleBounds() (*int32, *int32)

type StagePodAutoscalerList 

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

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

StagePodAutoscalerList is a list of StagePodAutoscaler resources

func (*StagePodAutoscalerList) DeepCopy 

func (in *StagePodAutoscalerList) DeepCopy() *StagePodAutoscalerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StagePodAutoscalerList.

func (*StagePodAutoscalerList) DeepCopyInto 

func (in *StagePodAutoscalerList) DeepCopyInto(out *StagePodAutoscalerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StagePodAutoscalerList) DeepCopyObject 

func (in *StagePodAutoscalerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StagePodAutoscalerSpec 

type StagePodAutoscalerSpec struct {
	// StageMinScale sets the lower bound for the number of the replicas.
	// +optional
	StageMinScale *int32 `json:"stageMinScale,omitempty"`

	// StageMaxScale sets the upper bound for the number of the replicas.
	// +optional
	StageMaxScale *int32 `json:"stageMaxScale,omitempty"`
}

func (*StagePodAutoscalerSpec) DeepCopy 

func (in *StagePodAutoscalerSpec) DeepCopy() *StagePodAutoscalerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StagePodAutoscalerSpec.

func (*StagePodAutoscalerSpec) DeepCopyInto 

func (in *StagePodAutoscalerSpec) DeepCopyInto(out *StagePodAutoscalerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StagePodAutoscalerStatus 

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

	// DesiredScale shows the current desired number of replicas for the revision.
	DesiredScale *int32 `json:"desiredScale,omitempty"`

	// ActualScale shows the actual number of replicas for the revision.
	ActualScale *int32 `json:"actualScale,omitempty"`

	// ReplicasTerminating shows the actual number of replicas being terminated.
	ReplicasTerminating *int32 `json:"replicasTerminating,omitempty"`
}

StagePodAutoscalerStatus communicates the observed state of the StagePodAutoscaler (from the controller).

func (*StagePodAutoscalerStatus) DeepCopy 

func (in *StagePodAutoscalerStatus) DeepCopy() *StagePodAutoscalerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StagePodAutoscalerStatus.

func (*StagePodAutoscalerStatus) DeepCopyInto 

func (in *StagePodAutoscalerStatus) DeepCopyInto(out *StagePodAutoscalerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StagePodAutoscalerStatus) InitializeConditions 

func (spas *StagePodAutoscalerStatus) InitializeConditions()

InitializeConditions sets the initial values to the conditions.

func (*StagePodAutoscalerStatus) MarkPodAutoscalerStageNotReady 

func (spas *StagePodAutoscalerStatus) MarkPodAutoscalerStageNotReady(message string)

func (*StagePodAutoscalerStatus) MarkPodAutoscalerStageReady 

func (spas *StagePodAutoscalerStatus) MarkPodAutoscalerStageReady()

type StageTarget 

type StageTarget struct {
	// StageTargetRevisions holds the configured traffic distribution for the current stage.
	// These entries will always contain RevisionName references.
	// +optional
	StageTargetRevisions []TargetRevision `json:"stageTargetRevisions,omitempty"`

	// TargetFinishTime indicates target time to complete this target.
	// +optional
	TargetFinishTime apis.VolatileTime `json:"targetFinishTime,omitempty"`

	// RolloutStrategy indicates the mode to roll out the new revision progressively. It is either availability or resourceUtil.
	// +optional
	RolloutStrategy string `json:"rolloutStrategy,omitempty"`
}

StageTarget holds the information of all revisions during the transition for the current stage.

func (*StageTarget) DeepCopy 

func (in *StageTarget) DeepCopy() *StageTarget

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageTarget.

func (*StageTarget) DeepCopyInto 

func (in *StageTarget) DeepCopyInto(out *StageTarget)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TargetRevision 

type TargetRevision struct {
	// TrafficTarget includes the information of the traffic for the revision.
	servingv1.TrafficTarget `json:",inline"`

	// Direction indicates up or down.
	// +optional
	Direction string `json:"direction,omitempty"`

	// TargetReplicas indicates an estimated number of replicas.
	// +optional
	TargetReplicas *int32 `json:"targetReplicas,omitempty"`

	// MinScale sets the lower bound for the number of the replicas.
	// +optional
	MinScale *int32 `json:"minScale,omitempty"`

	// MaxScale sets the upper bound for the number of the replicas.
	// +optional
	MaxScale *int32 `json:"maxScale,omitempty"`
}

TargetRevision holds the information of the revision for the current stage.

func (*TargetRevision) DeepCopy 

func (in *TargetRevision) DeepCopy() *TargetRevision

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetRevision.

func (*TargetRevision) DeepCopyInto 

func (in *TargetRevision) DeepCopyInto(out *TargetRevision)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*TargetRevision) IsRevScalingDown 

func (tR *TargetRevision) IsRevScalingDown() bool

func (*TargetRevision) IsRevScalingUp 

func (tR *TargetRevision) IsRevScalingUp() bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.