Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net
Index ¶
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func RegisterDefaults(scheme *runtime.Scheme) error
- type APIManager
- type APIManagerCommonSpec
- type APIManagerCondition
- type APIManagerConditionType
- type APIManagerList
- type APIManagerSpec
- type APIManagerStatus
- type ApicastSpec
- type BackendSpec
- type HighAvailabilitySpec
- type SystemDatabaseSpec
- type SystemFileStorageSpec
- type SystemMySQLSpec
- type SystemPVCSpec
- type SystemS3Spec
- type SystemSpec
- type WildcardRouterSpec
- type ZyncSpec
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "apps.3scale.net", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
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 APIManager ¶
type APIManager struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec APIManagerSpec `json:"spec,omitempty"`
Status APIManagerStatus `json:"status,omitempty"`
}
APIManager is the Schema for the apimanagers API +k8s:openapi-gen=true
func (*APIManager) DeepCopy ¶
func (in *APIManager) DeepCopy() *APIManager
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManager.
func (*APIManager) DeepCopyInto ¶
func (in *APIManager) DeepCopyInto(out *APIManager)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIManager) DeepCopyObject ¶
func (in *APIManager) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*APIManager) SetDefaults ¶
func (apimanager *APIManager) SetDefaults() (bool, error)
SetDefaults sets the default values for the APIManager spec and returns true if the spec was changed
type APIManagerCommonSpec ¶
type APIManagerCommonSpec struct {
ProductVersion product.Version `json:"productVersion"`
WildcardDomain string `json:"wildcardDomain"`
// +optional
AppLabel *string `json:"appLabel,omitempty"`
// +optional
TenantName *string `json:"tenantName,omitempty"`
// +optional
WildcardPolicy *string `json:"wildcardPolicy,omitempty"`
// +optional
ImageStreamTagImportInsecure *bool `json:"imageStreamTagImportInsecure,omitempty"`
// +optional
ResourceRequirementsEnabled *bool `json:"resourceRequirementsEnabled,omitempty"`
}
func (*APIManagerCommonSpec) DeepCopy ¶
func (in *APIManagerCommonSpec) DeepCopy() *APIManagerCommonSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManagerCommonSpec.
func (*APIManagerCommonSpec) DeepCopyInto ¶
func (in *APIManagerCommonSpec) DeepCopyInto(out *APIManagerCommonSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIManagerCondition ¶
type APIManagerCondition struct {
Type APIManagerConditionType `json:"type" description:"type of APIManager condition"`
Status v1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` //TODO should be a custom ConditionStatus or the core v1 one?
}
func (*APIManagerCondition) DeepCopy ¶
func (in *APIManagerCondition) DeepCopy() *APIManagerCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManagerCondition.
func (*APIManagerCondition) DeepCopyInto ¶
func (in *APIManagerCondition) DeepCopyInto(out *APIManagerCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIManagerConditionType ¶
type APIManagerConditionType string
const ( // Ready means the APIManager is available. This is, when all of its // elements are up and running APIManagerReady APIManagerConditionType = "Ready" // Progressing means the APIManager is being deployed APIManagerProgressing APIManagerConditionType = "Progressing" )
type APIManagerList ¶
type APIManagerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []APIManager `json:"items"`
}
APIManagerList contains a list of APIManager
func (*APIManagerList) DeepCopy ¶
func (in *APIManagerList) DeepCopy() *APIManagerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManagerList.
func (*APIManagerList) DeepCopyInto ¶
func (in *APIManagerList) DeepCopyInto(out *APIManagerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIManagerList) DeepCopyObject ¶
func (in *APIManagerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type APIManagerSpec ¶
type APIManagerSpec struct {
APIManagerCommonSpec `json:",inline"`
// +optional
ApicastSpec *ApicastSpec `json:"apicast,omitempty"`
// +optional
BackendSpec *BackendSpec `json:"backend,omitempty"`
// +optional
SystemSpec *SystemSpec `json:"system,omitempty"`
// +optional
ZyncSpec *ZyncSpec `json:"zync,omitempty"`
// +optional
WildcardRouterSpec *WildcardRouterSpec `json:"wildcardRouter,omitempty"`
// +optional
HighAvailabilitySpec *HighAvailabilitySpec `json:"highAvailability,omitempty"`
}
APIManagerSpec defines the desired state of APIManager
func (*APIManagerSpec) DeepCopy ¶
func (in *APIManagerSpec) DeepCopy() *APIManagerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManagerSpec.
func (*APIManagerSpec) DeepCopyInto ¶
func (in *APIManagerSpec) DeepCopyInto(out *APIManagerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type APIManagerStatus ¶
type APIManagerStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
Conditions []APIManagerCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,4,rep,name=conditions"`
}
APIManagerStatus defines the observed state of APIManager
func (*APIManagerStatus) DeepCopy ¶
func (in *APIManagerStatus) DeepCopy() *APIManagerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIManagerStatus.
func (*APIManagerStatus) DeepCopyInto ¶
func (in *APIManagerStatus) DeepCopyInto(out *APIManagerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApicastSpec ¶
type ApicastSpec struct {
// +optional
ApicastManagementAPI *string `json:"managementAPI,omitempty"`
// +optional
OpenSSLVerify *bool `json:"openSSLVerify,omitempty"`
// +optional
IncludeResponseCodes *bool `json:"responseCodes,omitempty"`
// +optional
RegistryURL *string `json:"registryURL,omitempty"`
// +optional
Image *string `json:"image,omitempty"`
}
func (*ApicastSpec) DeepCopy ¶
func (in *ApicastSpec) DeepCopy() *ApicastSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApicastSpec.
func (*ApicastSpec) DeepCopyInto ¶
func (in *ApicastSpec) DeepCopyInto(out *ApicastSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackendSpec ¶
type BackendSpec struct {
// +optional
Image *string `json:"image,omitempty"`
// +optional
RedisImage *string `json:"redisImage,omitempty"`
}
func (*BackendSpec) DeepCopy ¶
func (in *BackendSpec) DeepCopy() *BackendSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendSpec.
func (*BackendSpec) DeepCopyInto ¶
func (in *BackendSpec) DeepCopyInto(out *BackendSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HighAvailabilitySpec ¶
type HighAvailabilitySpec struct {
Enabled bool `json:"enabled,omitempty"`
}
func (*HighAvailabilitySpec) DeepCopy ¶
func (in *HighAvailabilitySpec) DeepCopy() *HighAvailabilitySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HighAvailabilitySpec.
func (*HighAvailabilitySpec) DeepCopyInto ¶
func (in *HighAvailabilitySpec) DeepCopyInto(out *HighAvailabilitySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemDatabaseSpec ¶
type SystemDatabaseSpec struct {
// Union type. Only one of the fields can be set
// +optional
MySQLSpec *SystemMySQLSpec `json:"mysql,omitempty"`
}
func (*SystemDatabaseSpec) DeepCopy ¶
func (in *SystemDatabaseSpec) DeepCopy() *SystemDatabaseSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemDatabaseSpec.
func (*SystemDatabaseSpec) DeepCopyInto ¶
func (in *SystemDatabaseSpec) DeepCopyInto(out *SystemDatabaseSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemFileStorageSpec ¶
type SystemFileStorageSpec struct {
// Union type. Only one of the fields can be set.
// +optional
PVC *SystemPVCSpec `json:"persistentVolumeClaim,omitempty"`
// +optional
S3 *SystemS3Spec `json:"amazonSimpleStorageService,omitempty"`
}
func (*SystemFileStorageSpec) DeepCopy ¶
func (in *SystemFileStorageSpec) DeepCopy() *SystemFileStorageSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemFileStorageSpec.
func (*SystemFileStorageSpec) DeepCopyInto ¶
func (in *SystemFileStorageSpec) DeepCopyInto(out *SystemFileStorageSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemMySQLSpec ¶
type SystemMySQLSpec struct {
// +optional
Image *string `json:"image,omitempty"`
}
func (*SystemMySQLSpec) DeepCopy ¶
func (in *SystemMySQLSpec) DeepCopy() *SystemMySQLSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemMySQLSpec.
func (*SystemMySQLSpec) DeepCopyInto ¶
func (in *SystemMySQLSpec) DeepCopyInto(out *SystemMySQLSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemPVCSpec ¶
type SystemPVCSpec struct {
// +optional
StorageClassName *string `json:"storageClassName,omitempty"`
}
func (*SystemPVCSpec) DeepCopy ¶
func (in *SystemPVCSpec) DeepCopy() *SystemPVCSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemPVCSpec.
func (*SystemPVCSpec) DeepCopyInto ¶
func (in *SystemPVCSpec) DeepCopyInto(out *SystemPVCSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemS3Spec ¶
type SystemS3Spec struct {
AWSBucket string `json:"awsBucket"`
AWSRegion string `json:"awsRegion"`
AWSCredentials v1.LocalObjectReference `json:"awsCredentialsSecret"`
FileUploadStorage string `json:"fileUploadStorage"`
}
func (*SystemS3Spec) DeepCopy ¶
func (in *SystemS3Spec) DeepCopy() *SystemS3Spec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemS3Spec.
func (*SystemS3Spec) DeepCopyInto ¶
func (in *SystemS3Spec) DeepCopyInto(out *SystemS3Spec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SystemSpec ¶
type SystemSpec struct {
// +optional
Image *string `json:"image,omitempty"`
// +optional
MemcachedImage *string `json:"memcachedImage,omitempty"`
// +optional
RedisImage *string `json:"redisImage,omitempty"`
// TODO should this field be optional? We have different approaches in Kubernetes.
// For example, in v1.Volume it is optional and there's an implied behaviour
// on which one is the default VolumeSource of the ones available. However,
// on v1.Probe the Handler field is mandatory and says that one of the
// available values and only one should be specified (it mandates to write
// something)
// +optional
FileStorageSpec *SystemFileStorageSpec `json:"fileStorage,omitempty"`
// TODO should union fields be optional?
// +optional
DatabaseSpec *SystemDatabaseSpec `json:"database,omitempty"`
}
func (*SystemSpec) DeepCopy ¶
func (in *SystemSpec) DeepCopy() *SystemSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SystemSpec.
func (*SystemSpec) DeepCopyInto ¶
func (in *SystemSpec) DeepCopyInto(out *SystemSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WildcardRouterSpec ¶
type WildcardRouterSpec struct {
// +optional
Image *string `json:"image,omitempty"`
}
func (*WildcardRouterSpec) DeepCopy ¶
func (in *WildcardRouterSpec) DeepCopy() *WildcardRouterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WildcardRouterSpec.
func (*WildcardRouterSpec) DeepCopyInto ¶
func (in *WildcardRouterSpec) DeepCopyInto(out *WildcardRouterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ZyncSpec ¶
type ZyncSpec struct {
// +optional
Image *string `json:"image,omitempty"`
// +optional
PostgreSQLImage *string `json:"postgreSQLImage,omitempty"`
}
func (*ZyncSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZyncSpec.
func (*ZyncSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.