Documentation ¶
Overview ¶
Package v1 contains API Schema definitions for the task v1 API group +kubebuilder:object:generate=true +groupName=task.operator.kube-stager.io
Index ¶
- Variables
- type EnvironmentConfig
- type MongoDatabase
- func (in *MongoDatabase) DeepCopy() *MongoDatabase
- func (in *MongoDatabase) DeepCopyInto(out *MongoDatabase)
- func (in *MongoDatabase) DeepCopyObject() runtime.Object
- func (r *MongoDatabase) Matches(other MongoDatabase) bool
- func (r *MongoDatabase) PopulateFomSite(site *sitev1.StagingSite, config *configv1.ServiceConfig, ...) error
- func (r *MongoDatabase) UpdateFromExpected(expected MongoDatabase)
- type MongoDatabaseList
- type MongoDatabaseSpec
- type MysqlDatabase
- func (in *MysqlDatabase) DeepCopy() *MysqlDatabase
- func (in *MysqlDatabase) DeepCopyInto(out *MysqlDatabase)
- func (in *MysqlDatabase) DeepCopyObject() runtime.Object
- func (r *MysqlDatabase) Matches(other MysqlDatabase) bool
- func (r *MysqlDatabase) PopulateFomSite(site *sitev1.StagingSite, config *configv1.ServiceConfig, ...) error
- func (r *MysqlDatabase) UpdateFromExpected(expected MysqlDatabase)
- type MysqlDatabaseList
- type MysqlDatabaseSpec
- type RedisDatabase
- func (in *RedisDatabase) DeepCopy() *RedisDatabase
- func (in *RedisDatabase) DeepCopyInto(out *RedisDatabase)
- func (in *RedisDatabase) DeepCopyObject() runtime.Object
- func (r *RedisDatabase) Matches(other RedisDatabase) bool
- func (r *RedisDatabase) PopulateFomSite(site *sitev1.StagingSite, config *configv1.ServiceConfig, ...) error
- func (r *RedisDatabase) UpdateFromExpected(expected RedisDatabase)
- type RedisDatabaseList
- type RedisDatabaseSpec
- type TaskState
- type TaskStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "task.operator.kube-stager.io", Version: "v1"} // 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 )
Functions ¶
This section is empty.
Types ¶
type EnvironmentConfig ¶
type EnvironmentConfig struct { // Name of the service for this database. Empty for the main app //+optional ServiceName string `json:"serviceName,omitempty"` //+kubebuilder:validation:MinLength=1 // Name of the site this database is associated with SiteName string `json:"siteName"` //+kubebuilder:validation:MinLength=1 // Name of the environment used Environment string `json:"environment"` }
func (*EnvironmentConfig) DeepCopy ¶
func (in *EnvironmentConfig) DeepCopy() *EnvironmentConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EnvironmentConfig.
func (*EnvironmentConfig) DeepCopyInto ¶
func (in *EnvironmentConfig) DeepCopyInto(out *EnvironmentConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (EnvironmentConfig) GetEnvironment ¶
func (r EnvironmentConfig) GetEnvironment() string
func (EnvironmentConfig) GetServiceName ¶
func (r EnvironmentConfig) GetServiceName() string
func (EnvironmentConfig) GetSiteName ¶
func (r EnvironmentConfig) GetSiteName() string
type MongoDatabase ¶
type MongoDatabase struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MongoDatabaseSpec `json:"spec,omitempty"` Status TaskStatus `json:"status,omitempty"` }
MongoDatabase is the Schema for the mongodatabases API
func (*MongoDatabase) DeepCopy ¶
func (in *MongoDatabase) DeepCopy() *MongoDatabase
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDatabase.
func (*MongoDatabase) DeepCopyInto ¶
func (in *MongoDatabase) DeepCopyInto(out *MongoDatabase)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MongoDatabase) DeepCopyObject ¶
func (in *MongoDatabase) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MongoDatabase) Matches ¶
func (r *MongoDatabase) Matches(other MongoDatabase) bool
func (*MongoDatabase) PopulateFomSite ¶
func (r *MongoDatabase) PopulateFomSite( site *sitev1.StagingSite, config *configv1.ServiceConfig, environmentName string, ) error
TODO make the username and dbname fields immutable
func (*MongoDatabase) UpdateFromExpected ¶
func (r *MongoDatabase) UpdateFromExpected(expected MongoDatabase)
type MongoDatabaseList ¶
type MongoDatabaseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MongoDatabase `json:"items"` }
MongoDatabaseList contains a list of MongoDatabase
func (*MongoDatabaseList) DeepCopy ¶
func (in *MongoDatabaseList) DeepCopy() *MongoDatabaseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDatabaseList.
func (*MongoDatabaseList) DeepCopyInto ¶
func (in *MongoDatabaseList) DeepCopyInto(out *MongoDatabaseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MongoDatabaseList) DeepCopyObject ¶
func (in *MongoDatabaseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MongoDatabaseSpec ¶
type MongoDatabaseSpec struct { EnvironmentConfig EnvironmentConfig `json:"environmentConfig"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=63 // Name of the database DatabaseName string `json:"databaseName"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=16 // The username for the user Username string `json:"username"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=32 // The password for the user Password string `json:"password"` }
MongoDatabaseSpec defines the desired state of MongoDatabase
func (*MongoDatabaseSpec) DeepCopy ¶
func (in *MongoDatabaseSpec) DeepCopy() *MongoDatabaseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDatabaseSpec.
func (*MongoDatabaseSpec) DeepCopyInto ¶
func (in *MongoDatabaseSpec) DeepCopyInto(out *MongoDatabaseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MysqlDatabase ¶
type MysqlDatabase struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MysqlDatabaseSpec `json:"spec,omitempty"` Status TaskStatus `json:"status,omitempty"` }
MysqlDatabase is the Schema for the mysqldatabases API
func (*MysqlDatabase) DeepCopy ¶
func (in *MysqlDatabase) DeepCopy() *MysqlDatabase
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MysqlDatabase.
func (*MysqlDatabase) DeepCopyInto ¶
func (in *MysqlDatabase) DeepCopyInto(out *MysqlDatabase)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MysqlDatabase) DeepCopyObject ¶
func (in *MysqlDatabase) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MysqlDatabase) Matches ¶
func (r *MysqlDatabase) Matches(other MysqlDatabase) bool
func (*MysqlDatabase) PopulateFomSite ¶
func (r *MysqlDatabase) PopulateFomSite( site *sitev1.StagingSite, config *configv1.ServiceConfig, environmentName string, ) error
func (*MysqlDatabase) UpdateFromExpected ¶
func (r *MysqlDatabase) UpdateFromExpected(expected MysqlDatabase)
type MysqlDatabaseList ¶
type MysqlDatabaseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MysqlDatabase `json:"items"` }
MysqlDatabaseList contains a list of MysqlDatabase
func (*MysqlDatabaseList) DeepCopy ¶
func (in *MysqlDatabaseList) DeepCopy() *MysqlDatabaseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MysqlDatabaseList.
func (*MysqlDatabaseList) DeepCopyInto ¶
func (in *MysqlDatabaseList) DeepCopyInto(out *MysqlDatabaseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MysqlDatabaseList) DeepCopyObject ¶
func (in *MysqlDatabaseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MysqlDatabaseSpec ¶
type MysqlDatabaseSpec struct { EnvironmentConfig EnvironmentConfig `json:"environmentConfig"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=63 // Name of the database DatabaseName string `json:"databaseName"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=16 // The username for the user Username string `json:"username"` //+kubebuilder:validation:Pattern=[_a-zA-Z0-9]+ //+kubebuilder:validation:MinLength=1 //+kubebuilder:validation:MaxLength=32 // The password for the user Password string `json:"password"` }
MysqlDatabaseSpec defines the desired state of MysqlDatabase
func (*MysqlDatabaseSpec) DeepCopy ¶
func (in *MysqlDatabaseSpec) DeepCopy() *MysqlDatabaseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MysqlDatabaseSpec.
func (*MysqlDatabaseSpec) DeepCopyInto ¶
func (in *MysqlDatabaseSpec) DeepCopyInto(out *MysqlDatabaseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RedisDatabase ¶
type RedisDatabase struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RedisDatabaseSpec `json:"spec,omitempty"` Status TaskStatus `json:"status,omitempty"` }
RedisDatabase is the Schema for the redisdatabases API
func (*RedisDatabase) DeepCopy ¶
func (in *RedisDatabase) DeepCopy() *RedisDatabase
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RedisDatabase.
func (*RedisDatabase) DeepCopyInto ¶
func (in *RedisDatabase) DeepCopyInto(out *RedisDatabase)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RedisDatabase) DeepCopyObject ¶
func (in *RedisDatabase) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*RedisDatabase) Matches ¶
func (r *RedisDatabase) Matches(other RedisDatabase) bool
func (*RedisDatabase) PopulateFomSite ¶
func (r *RedisDatabase) PopulateFomSite( site *sitev1.StagingSite, config *configv1.ServiceConfig, environmentName string, ) error
func (*RedisDatabase) UpdateFromExpected ¶
func (r *RedisDatabase) UpdateFromExpected(expected RedisDatabase)
type RedisDatabaseList ¶
type RedisDatabaseList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []RedisDatabase `json:"items"` }
RedisDatabaseList contains a list of RedisDatabase
func (*RedisDatabaseList) DeepCopy ¶
func (in *RedisDatabaseList) DeepCopy() *RedisDatabaseList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RedisDatabaseList.
func (*RedisDatabaseList) DeepCopyInto ¶
func (in *RedisDatabaseList) DeepCopyInto(out *RedisDatabaseList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RedisDatabaseList) DeepCopyObject ¶
func (in *RedisDatabaseList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RedisDatabaseSpec ¶
type RedisDatabaseSpec struct { EnvironmentConfig EnvironmentConfig `json:"environmentConfig"` //+kubebuilder:validation:Minimum=0 // Name of the database DatabaseNumber uint32 `json:"databaseNumber"` }
RedisDatabaseSpec defines the desired state of RedisDatabase
func (*RedisDatabaseSpec) DeepCopy ¶
func (in *RedisDatabaseSpec) DeepCopy() *RedisDatabaseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RedisDatabaseSpec.
func (*RedisDatabaseSpec) DeepCopyInto ¶
func (in *RedisDatabaseSpec) DeepCopyInto(out *RedisDatabaseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TaskStatus ¶
type TaskStatus struct { // The state of the task. Pending/Failed/Complete State TaskState `json:"state"` }
func (*TaskStatus) DeepCopy ¶
func (in *TaskStatus) DeepCopy() *TaskStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TaskStatus.
func (*TaskStatus) DeepCopyInto ¶
func (in *TaskStatus) DeepCopyInto(out *TaskStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.