Documentation
¶
Overview ¶
+groupName=sys.bytetrade.io
Package v1alpha1 contains API Schema definitions for the sys v1alpha1 API group +kubebuilder:object:generate=true +groupName=sys.bytetrade.io
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type AppEnv
- type AppEnvList
- type AppEnvVar
- type EnvValueOptionItem
- type EnvVarSpec
- type GithubRepository
- type ReleaseServer
- type SystemEnv
- type SystemEnvList
- type Terminus
- type TerminusList
- type TerminusSpec
- type TerminusStatus
- type UserEnv
- type UserEnvList
- type ValueFrom
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "sys.bytetrade.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = GroupVersion
SchemeGroupVersion is group version used to register these objects.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Types ¶
type AppEnv ¶
type AppEnv struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
AppName string `json:"appName" yaml:"appName" validate:"required"`
AppOwner string `json:"appOwner" yaml:"appOwner" validate:"required"`
Envs []AppEnvVar `json:"envs,omitempty" yaml:"envs,omitempty"`
NeedApply bool `json:"needApply,omitempty" yaml:"needApply,omitempty"`
}
AppEnv is the Schema for the application environment variables API
func (*AppEnv) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEnv.
func (*AppEnv) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AppEnv) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AppEnvList ¶
type AppEnvList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []AppEnv `json:"items"`
}
AppEnvList contains a list of AppEnv
func (*AppEnvList) DeepCopy ¶
func (in *AppEnvList) DeepCopy() *AppEnvList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEnvList.
func (*AppEnvList) DeepCopyInto ¶
func (in *AppEnvList) DeepCopyInto(out *AppEnvList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AppEnvList) DeepCopyObject ¶
func (in *AppEnvList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AppEnvVar ¶
type AppEnvVar struct {
EnvVarSpec `json:",inline" yaml:",inline"`
ApplyOnChange bool `json:"applyOnChange,omitempty" yaml:"applyOnChange,omitempty"`
ValueFrom *ValueFrom `json:"valueFrom,omitempty" yaml:"valueFrom,omitempty"`
}
func (*AppEnvVar) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AppEnvVar.
func (*AppEnvVar) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EnvValueOptionItem ¶
type EnvValueOptionItem struct {
Title string `json:"title" yaml:"title"`
Value string `json:"value" yaml:"value"`
}
func (*EnvValueOptionItem) DeepCopy ¶
func (in *EnvValueOptionItem) DeepCopy() *EnvValueOptionItem
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EnvValueOptionItem.
func (*EnvValueOptionItem) DeepCopyInto ¶
func (in *EnvValueOptionItem) DeepCopyInto(out *EnvValueOptionItem)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EnvVarSpec ¶
type EnvVarSpec struct {
EnvName string `json:"envName" yaml:"envName" validate:"required"`
Value string `json:"value,omitempty" yaml:"value,omitempty"`
Default string `json:"default,omitempty" yaml:"default,omitempty"`
Editable bool `json:"editable,omitempty" yaml:"editable,omitempty"`
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
Title string `json:"title,omitempty" yaml:"title,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
// Options defines a finite set of allowed values for this env var
Options []EnvValueOptionItem `json:"options,omitempty" yaml:"options,omitempty"`
// +kubebuilder:validation:Pattern=`^https?://`
// RemoteOptions provides a URL (http/https) returning a JSON-encoded string array of allowed values
RemoteOptions string `json:"remoteOptions,omitempty" yaml:"remoteOptions,omitempty"`
Regex string `json:"regex,omitempty" yaml:"regex,omitempty"`
}
EnvVarSpec defines the common fields for environment variables This struct is embedded in SystemEnv, UserEnv, and AppEnvVar
func (*EnvVarSpec) DeepCopy ¶
func (in *EnvVarSpec) DeepCopy() *EnvVarSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EnvVarSpec.
func (*EnvVarSpec) DeepCopyInto ¶
func (in *EnvVarSpec) DeepCopyInto(out *EnvVarSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EnvVarSpec) GetEffectiveValue ¶
func (e *EnvVarSpec) GetEffectiveValue() string
GetEffectiveValue returns the effective value of the environment variable. If Value is not empty, it returns Value; otherwise, it returns Default.
func (*EnvVarSpec) ValidateValue ¶
func (e *EnvVarSpec) ValidateValue(value string) error
type GithubRepository ¶
type GithubRepository struct {
// github repository owner
Owner string `json:"owner"`
// github repository name
Repo string `json:"repo"`
}
GithubRepository defines github repo info
func (*GithubRepository) DeepCopy ¶
func (in *GithubRepository) DeepCopy() *GithubRepository
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GithubRepository.
func (*GithubRepository) DeepCopyInto ¶
func (in *GithubRepository) DeepCopyInto(out *GithubRepository)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReleaseServer ¶
type ReleaseServer struct {
// serverType: github or others
ServerType string `json:"serverType"`
// github defines github repo where the terminus released
Github GithubRepository `json:"github,omitempty"`
}
ReleaseServer defines the Terminus new version release server
func (*ReleaseServer) DeepCopy ¶
func (in *ReleaseServer) DeepCopy() *ReleaseServer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReleaseServer.
func (*ReleaseServer) DeepCopyInto ¶
func (in *ReleaseServer) DeepCopyInto(out *ReleaseServer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemEnv ¶
type SystemEnv struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
EnvVarSpec `json:",inline"`
}
SystemEnv is the Schema for the system environment variables API
func (*SystemEnv) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemEnv.
func (*SystemEnv) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SystemEnv) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SystemEnvList ¶
type SystemEnvList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []SystemEnv `json:"items"`
}
SystemEnvList contains a list of SystemEnv
func (*SystemEnvList) DeepCopy ¶
func (in *SystemEnvList) DeepCopy() *SystemEnvList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemEnvList.
func (*SystemEnvList) DeepCopyInto ¶
func (in *SystemEnvList) DeepCopyInto(out *SystemEnvList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SystemEnvList) DeepCopyObject ¶
func (in *SystemEnvList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Terminus ¶
type Terminus struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TerminusSpec `json:"spec,omitempty"`
Status TerminusStatus `json:"status,omitempty"`
}
Terminus is the Schema for the terminuses API
func (*Terminus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Terminus.
func (*Terminus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Terminus) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TerminusList ¶
type TerminusList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Terminus `json:"items"`
}
TerminusList contains a list of Terminus
func (*TerminusList) DeepCopy ¶
func (in *TerminusList) DeepCopy() *TerminusList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerminusList.
func (*TerminusList) DeepCopyInto ¶
func (in *TerminusList) DeepCopyInto(out *TerminusList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TerminusList) DeepCopyObject ¶
func (in *TerminusList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TerminusSpec ¶
type TerminusSpec struct {
// description from terminus
Description string `json:"description,omitempty"`
// the version name of the terminus os
Name string `json:"name"`
// the DisplayName of the terminus
DisplayName string `json:"display,omitempty"`
// the version of the terminus
Version string `json:"version"`
// the release server of the terminus
ReleaseServer ReleaseServer `json:"releaseServer"`
// the extend settings of the terminus
Settings map[string]string `json:"settings,omitempty"`
}
TerminusSpec defines the desired state of Terminus
func (*TerminusSpec) DeepCopy ¶
func (in *TerminusSpec) DeepCopy() *TerminusSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerminusSpec.
func (*TerminusSpec) DeepCopyInto ¶
func (in *TerminusSpec) DeepCopyInto(out *TerminusSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TerminusStatus ¶
type TerminusStatus struct {
// the state of the terminus: draft, submitted, passed, rejected, suspended, active
State string `json:"state"`
UpdateTime *metav1.Time `json:"updateTime,omitempty"`
StatusTime *metav1.Time `json:"statusTime,omitempty"`
}
TerminusStatus defines the observed state of Terminus
func (*TerminusStatus) DeepCopy ¶
func (in *TerminusStatus) DeepCopy() *TerminusStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TerminusStatus.
func (*TerminusStatus) DeepCopyInto ¶
func (in *TerminusStatus) DeepCopyInto(out *TerminusStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserEnv ¶
type UserEnv struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
EnvVarSpec `json:",inline"`
}
UserEnv is the Schema for the user environment variables API
func (*UserEnv) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserEnv.
func (*UserEnv) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserEnv) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserEnvList ¶
type UserEnvList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []UserEnv `json:"items"`
}
UserEnvList contains a list of UserEnv
func (*UserEnvList) DeepCopy ¶
func (in *UserEnvList) DeepCopy() *UserEnvList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserEnvList.
func (*UserEnvList) DeepCopyInto ¶
func (in *UserEnvList) DeepCopyInto(out *UserEnvList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserEnvList) DeepCopyObject ¶
func (in *UserEnvList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ValueFrom ¶
type ValueFrom struct {
EnvName string `json:"envName" validate:"required"`
Status string `json:"status,omitempty"`
}
ValueFrom defines a reference to an environment variable (UserEnv or SystemEnv)
func (*ValueFrom) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ValueFrom.
func (*ValueFrom) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.