Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the push v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=push.aerogear.org
Package v1alpha1 contains API Schema definitions for the push v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=push.aerogear.org
Index ¶
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func RegisterDefaults(scheme *runtime.Scheme) error
- type StatusPhase
- type UnifiedPushServer
- type UnifiedPushServerBackup
- type UnifiedPushServerDatabase
- type UnifiedPushServerList
- type UnifiedPushServerSpec
- type UnifiedPushServerStatus
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "push.aerogear.org", 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 StatusPhase ¶
type StatusPhase string
var ( PhaseEmpty StatusPhase PhaseFailing StatusPhase = "Failing" PhaseReconciling StatusPhase = "Reconciling" PhaseInitializing StatusPhase = "Initializing" )
type UnifiedPushServer ¶
type UnifiedPushServer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec UnifiedPushServerSpec `json:"spec,omitempty"`
Status UnifiedPushServerStatus `json:"status,omitempty"`
}
UnifiedPushServer is the Schema for the unifiedpushservers API +k8s:openapi-gen=true +kubebuilder:resource:path=unifiedpushservers,shortName=ups +kubebuilder:singular=unifiedpushserver +kubebuilder:subresource:status
func (*UnifiedPushServer) DeepCopy ¶
func (in *UnifiedPushServer) DeepCopy() *UnifiedPushServer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServer.
func (*UnifiedPushServer) DeepCopyInto ¶
func (in *UnifiedPushServer) DeepCopyInto(out *UnifiedPushServer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UnifiedPushServer) DeepCopyObject ¶
func (in *UnifiedPushServer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UnifiedPushServerBackup ¶
type UnifiedPushServerBackup struct {
// Name is the name that will be given to the resulting
// CronJob
Name string `json:"name"`
// Schedule is the schedule that the job will be run at, in
// cron format
Schedule string `json:"schedule"`
// EncryptionKeySecretName is the name of a secret containing
// PGP/GPG details, including "GPG_PUBLIC_KEY",
// "GPG_TRUST_MODEL", and "GPG_RECIPIENT"
EncryptionKeySecretName string `json:"encryptionKeySecretName,omitempty"`
// EncryptionKeySecretNamespace is the name of the namespace
// that the secret referenced in EncryptionKeySecretName
// resides in
EncryptionKeySecretNamespace string `json:"encryptionKeySecretNamespace,omitempty"`
// BackendSecretName is the name of a secret containing
// storage backend details, such as "AWS_S3_BUCKET_NAME",
// "AWS_ACCESS_KEY_ID", and "AWS_SECRET_ACCESS_KEY"
BackendSecretName string `json:"backendSecretName"`
// BackendSecretNamespace is the name of the namespace that
// the secret referenced in BackendSecretName resides in
BackendSecretNamespace string `json:"backendSecretNamespace,omitempty"`
}
Backup contains the info needed to configure a CronJob for backups
func (*UnifiedPushServerBackup) DeepCopy ¶
func (in *UnifiedPushServerBackup) DeepCopy() *UnifiedPushServerBackup
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServerBackup.
func (*UnifiedPushServerBackup) DeepCopyInto ¶
func (in *UnifiedPushServerBackup) DeepCopyInto(out *UnifiedPushServerBackup)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UnifiedPushServerDatabase ¶
type UnifiedPushServerDatabase struct {
//Name for external database support
Name string `json:"name,omitempty"`
//Password for external database support
Password string `json:"password,omitempty"`
//User for external database support
User string `json:"user,omitempty"`
//Host for external database support
Host string `json:"host,omitempty"`
//Port for external database support
Port intstr.IntOrString `json:"port,omitempty"`
}
UnifiedPushServerDatabase contains the data needed to connect to external database
func (*UnifiedPushServerDatabase) DeepCopy ¶
func (in *UnifiedPushServerDatabase) DeepCopy() *UnifiedPushServerDatabase
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServerDatabase.
func (*UnifiedPushServerDatabase) DeepCopyInto ¶
func (in *UnifiedPushServerDatabase) DeepCopyInto(out *UnifiedPushServerDatabase)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UnifiedPushServerList ¶
type UnifiedPushServerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []UnifiedPushServer `json:"items"`
}
UnifiedPushServerList contains a list of UnifiedPushServer
func (*UnifiedPushServerList) DeepCopy ¶
func (in *UnifiedPushServerList) DeepCopy() *UnifiedPushServerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServerList.
func (*UnifiedPushServerList) DeepCopyInto ¶
func (in *UnifiedPushServerList) DeepCopyInto(out *UnifiedPushServerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UnifiedPushServerList) DeepCopyObject ¶
func (in *UnifiedPushServerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UnifiedPushServerSpec ¶
type UnifiedPushServerSpec struct {
//ExternalDB can be set to true to use details from Database and connect to external db
ExternalDB bool `json:"externalDB,omitempty"`
// Database allows specifying the external PostgreSQL details directly in the CR. Only one
// of Database or DatabaseSecret should be specified, and ExternalDB must be true, otherwise
// a new PostgreSQL instance will be created (and deleted) on the cluster automatically.
Database UnifiedPushServerDatabase `json:"database,omitempty"`
// DatabaseSecret allows reading the external PostgreSQL details from a pre-existing Secret
// (ExternalDB must be true for it to be used). Only one of Database or DatabaseSecret
// should be specified, and ExternalDB must be true, otherwise a new PostgreSQL instance
// will be created (and deleted) on the cluster automatically.
//
// Here's an example of all of the fields that the secret must contain:
//
// POSTGRES_DATABASE: sampledb
// POSTGRES_HOST: 172.30.139.148
// POSTGRES_PORT: "5432"
// POSTGRES_USERNAME: userMSM
// POSTGRES_PASSWORD: RmwWKKIM7or7oJig
// POSTGRES_SUPERUSER: "false"
// POSTGRES_VERSION: "10"
//
DatabaseSecret string `json:"databaseSecret,omitempty"`
// Backups is an array of configs that will be used to create CronJob resource instances
Backups []UnifiedPushServerBackup `json:"backups,omitempty"`
// UseMessageBroker can be set to true to use managed queues, if you are using enmasse. Defaults to false.
UseMessageBroker bool `json:"useMessageBroker,omitempty"`
UnifiedPushResourceRequirements corev1.ResourceRequirements `json:"unifiedPushResourceRequirements,omitempty"`
OAuthResourceRequirements corev1.ResourceRequirements `json:"oAuthResourceRequirements,omitempty"`
PostgresResourceRequirements corev1.ResourceRequirements `json:"postgresResourceRequirements,omitempty"`
// PVC size for Postgres service
PostgresPVCSize string `json:"postgresPVCSize,omitempty"`
Affinity *corev1.Affinity `json:"affinity,omitempty"`
Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}
UnifiedPushServerSpec defines the desired state of UnifiedPushServer +k8s:openapi-gen=true
func (*UnifiedPushServerSpec) DeepCopy ¶
func (in *UnifiedPushServerSpec) DeepCopy() *UnifiedPushServerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServerSpec.
func (*UnifiedPushServerSpec) DeepCopyInto ¶
func (in *UnifiedPushServerSpec) DeepCopyInto(out *UnifiedPushServerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UnifiedPushServerStatus ¶
type UnifiedPushServerStatus struct {
// Phase indicates whether the CR is reconciling(good), failing(bad), or initializing.
Phase StatusPhase `json:"phase"`
// Message is a more human-readable message indicating details about current phase or error.
Message string `json:"message,omitempty"`
// Ready is True if all resources are in a ready state and all work is done (phase should be
// "reconciling"). The type in the Go code here is deliberately a pointer so that we can
// distinguish between false and "not set", since it's an optional field.
Ready *bool `json:"ready,omitempty"`
// SecondaryResources is a map of all the secondary resources types and names created for
// this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" ]
SecondaryResources map[string][]string `json:"secondaryResources,omitempty"`
}
UnifiedPushServerStatus defines the observed state of UnifiedPushServer +k8s:openapi-gen=true
func (*UnifiedPushServerStatus) DeepCopy ¶
func (in *UnifiedPushServerStatus) DeepCopy() *UnifiedPushServerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UnifiedPushServerStatus.
func (*UnifiedPushServerStatus) DeepCopyInto ¶
func (in *UnifiedPushServerStatus) DeepCopyInto(out *UnifiedPushServerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.