Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the istio v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=workspace.maistra.io
Package v1alpha1 contains API Schema definitions for the istio v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=workspace.maistra.io
Index ¶
- Constants
- Variables
- func RegisterDefaults(scheme *runtime.Scheme) error
- type Condition
- type Ref
- type Route
- type Session
- func (s *Session) AddCondition(condition Condition)
- func (s *Session) AddFinalizer(finalizer string)
- func (in *Session) DeepCopy() *Session
- func (in *Session) DeepCopyInto(out *Session)
- func (in *Session) DeepCopyObject() runtime.Object
- func (s *Session) HasFinalizer(finalizer string) bool
- func (s *Session) RemoveFinalizer(finalizer string)
- type SessionList
- type SessionSpec
- type SessionState
- type SessionStatus
- type Source
- type StatusComponents
- type StatusReadiness
- type Target
Constants ¶
const ( // StateProcessing indicates that particular action related to the session is ongoing. StateProcessing SessionState = "Processing" // StateSuccess indicates that particular action related to the session has finished successfully. StateSuccess SessionState = "Success" // StateFailed indicates that particular action related to the session has failed. StateFailed SessionState = "Failed" // StatusFailed indicates that overall condition failed. StatusFailed string = "false" )
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "workspace.maistra.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is used to add go types to the scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func RegisterDefaults ¶
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
Types ¶
type Condition ¶ added in v0.4.0
type Condition struct {
// Source contains the resource involved
Source Source `json:"source"`
// Result contains the resource involved if different from Target, e.g. Create
Target *Target `json:"target,omitempty"`
// Message explains the reason for a change.
Message *string `json:"message,omitempty"`
// Reason is a programmatic reason for the change.
Reason *string `json:"reason,omitempty"`
// Status indicates success.
Status *string `json:"status,omitempty"`
// Type the type of change
Type *string `json:"type,omitempty"`
// LastTransitionTime is the last time this action was applied
LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`
}
Condition describes a step of manipulating resources within a session. +k8s:openapi-gen=true
func (*Condition) DeepCopy ¶ added in v0.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶ added in v0.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Ref ¶
type Ref struct {
// Deployment or DeploymentConfig name, could optionally contain [Kind/]Name to be specific
Name string `json:"name,omitempty"`
// How this deployment should be handled, e.g. telepresence or prepared-image
Strategy string `json:"strategy,omitempty"`
// Additional arguments to the given strategy
Args map[string]string `json:"args,omitempty"`
}
Ref defines how to target a single Deployment or DeploymentConfig. +k8s:openapi-gen=true
func (*Ref) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ref.
func (*Ref) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Route ¶
type Route struct {
// The type of route to use, e.g. header
Type string `json:"type,omitempty"`
// Name of the key, e.g. http header
Name string `json:"name,omitempty"`
// The value to use for routing
Value string `json:"value,omitempty"`
}
Route defines the strategy for how the traffic is routed to the Ref. +k8s:openapi-gen=true
func (*Route) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route.
func (*Route) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Session ¶
type Session struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the desired state
Spec SessionSpec `json:"spec,omitempty"`
// Status defines the current status of the State
Status SessionStatus `json:"status,omitempty"`
}
Session controls the creation of the specialized hidden routes.
func (*Session) AddCondition ¶ added in v0.4.0
AddCondition adds or replaces a condition based on Name, Kind and Ref as a key.
func (*Session) AddFinalizer ¶
AddFinalizer adds a finalizer to the session.
func (*Session) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Session.
func (*Session) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Session) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Session) HasFinalizer ¶
HasFinalizer checks if session has a finalizer attached to it.
func (*Session) RemoveFinalizer ¶
RemoveFinalizer removes given finalizer.
type SessionList ¶
type SessionList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Session `json:"items"`
}
SessionList contains a list of Session.
func (*SessionList) DeepCopy ¶
func (in *SessionList) DeepCopy() *SessionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionList.
func (*SessionList) DeepCopyInto ¶
func (in *SessionList) DeepCopyInto(out *SessionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SessionList) DeepCopyObject ¶
func (in *SessionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SessionSpec ¶
type SessionSpec struct {
// How to route the given Session. A header based route using x-workspace-route with the Session name as value will be used if not provided.
Route Route `json:"route,omitempty"`
// Who should participate in the given session
Refs []Ref `json:"ref,omitempty"`
}
SessionSpec defines the desired state of Session.
func (*SessionSpec) DeepCopy ¶
func (in *SessionSpec) DeepCopy() *SessionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionSpec.
func (*SessionSpec) DeepCopyInto ¶
func (in *SessionSpec) DeepCopyInto(out *SessionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SessionState ¶ added in v0.4.0
type SessionState string
type SessionStatus ¶
type SessionStatus struct {
State *SessionState `json:"state,omitempty"`
// The current configured route
Route *Route `json:"route,omitempty"`
// The combined log of changes across all refs
Conditions []*Condition `json:"conditions,omitempty"`
Hosts []string `json:"hosts,omitempty"`
// RouteExpression represents the Route object as single string expression
RouteExpression string `json:"_routeExp,omitempty"` //nolint:tagliatelle //reason intentionally prefixed with _ to distinguish as UI/CLI field.
Strategies []string `json:"_strategies,omitempty"` //nolint:tagliatelle //reason intentionally prefixed with _ to distinguish as UI/CLI field.
RefNames []string `json:"_refNames,omitempty"` //nolint:tagliatelle //reason intentionally prefixed with _ to distinguish as UI/CLI field.
Readiness StatusReadiness `json:"readiness,omitempty"`
}
SessionStatus defines the observed state of Session. +k8s:openapi-gen=true
func (*SessionStatus) DeepCopy ¶
func (in *SessionStatus) DeepCopy() *SessionStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionStatus.
func (*SessionStatus) DeepCopyInto ¶
func (in *SessionStatus) DeepCopyInto(out *SessionStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Source ¶ added in v0.4.0
type Source struct {
Name string `json:"name,omitempty"`
Namespace string `json:"namespace,omitempty"`
Ref string `json:"ref,omitempty"`
Kind string `json:"kind,omitempty"`
}
func (*Source) DeepCopy ¶ added in v0.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.
func (*Source) DeepCopyInto ¶ added in v0.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StatusComponents ¶ added in v0.5.0
type StatusComponents struct {
Pending []string `json:"pending,omitempty"`
Ready []string `json:"ready,omitempty"`
Unready []string `json:"unready,omitempty"`
}
func (*StatusComponents) DeepCopy ¶ added in v0.5.0
func (in *StatusComponents) DeepCopy() *StatusComponents
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatusComponents.
func (*StatusComponents) DeepCopyInto ¶ added in v0.5.0
func (in *StatusComponents) DeepCopyInto(out *StatusComponents)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StatusComponents) SetPending ¶ added in v0.5.0
func (s *StatusComponents) SetPending(comp string)
func (*StatusComponents) SetReady ¶ added in v0.5.0
func (s *StatusComponents) SetReady(comp string)
func (*StatusComponents) SetUnready ¶ added in v0.5.0
func (s *StatusComponents) SetUnready(comp string)
type StatusReadiness ¶ added in v0.5.0
type StatusReadiness struct {
// Status of resources deployed/modified by this Session resource
//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Resources", xDescriptors="urn:alm:descriptor:com.tectonic.ui:podStatuses"
Components StatusComponents `json:"components,omitempty"`
}
func (*StatusReadiness) DeepCopy ¶ added in v0.5.0
func (in *StatusReadiness) DeepCopy() *StatusReadiness
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatusReadiness.
func (*StatusReadiness) DeepCopyInto ¶ added in v0.5.0
func (in *StatusReadiness) DeepCopyInto(out *StatusReadiness)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Target ¶ added in v0.4.0
type Target struct {
Name string `json:"name,omitempty"`
Namespace string `json:"namespace,omitempty"`
Kind string `json:"kind,omitempty"`
}
func (*Target) DeepCopy ¶ added in v0.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Target.
func (*Target) DeepCopyInto ¶ added in v0.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.