Documentation
¶
Overview ¶
Package v1 contains hand-crafted API Schema definitions for the dbforpostgresql v1 API group +groupName=dbforpostgresql.azure.com
Package v1 contains API Schema definitions for dbforpostgresql data plane APIs +kubebuilder:object:generate=true All object properties are optional by default, this will be overridden when needed: +kubebuilder:validation:Optional +groupName=dbforpostgresql.azure.com
Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Variables
- type LocalUserSpec
- type RoleOptionsSpec
- type User
- func (user *User) AzureName() string
- func (in *User) DeepCopy() *User
- func (in *User) DeepCopyInto(out *User)
- func (in *User) DeepCopyObject() runtime.Object
- func (user *User) GetConditions() conditions.Conditions
- func (user *User) Hub()
- func (user *User) Owner() *genruntime.ResourceReference
- func (user *User) SetConditions(conditions conditions.Conditions)
- type UserList
- type UserSpec
- type UserStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "dbforpostgresql.azure.com", 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 LocalUserSpec ¶
type LocalUserSpec struct {
// +kubebuilder:validation:Required
// ServerAdminUsername is the user name of the Server administrator
ServerAdminUsername string `json:"serverAdminUsername,omitempty"`
// +kubebuilder:validation:Required
// ServerAdminPassword is a reference to a secret containing the servers administrator password
ServerAdminPassword *genruntime.SecretReference `json:"serverAdminPassword,omitempty"`
// +kubebuilder:validation:Required
// Password is the password to use for the user
Password *genruntime.SecretReference `json:"password,omitempty"`
}
func (*LocalUserSpec) DeepCopy ¶
func (in *LocalUserSpec) DeepCopy() *LocalUserSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalUserSpec.
func (*LocalUserSpec) DeepCopyInto ¶
func (in *LocalUserSpec) DeepCopyInto(out *LocalUserSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RoleOptionsSpec ¶
type RoleOptionsSpec struct {
// +kubebuilder:validation:Optional
// +kubebuilder:default=true
// WITH LOGIN or NOLOGIN
Login bool `json:"login,omitempty"`
// +kubebuilder:validation:Optional
// +kubebuilder:default=false
// WITH CREATEROLE or NOCREATEROLE
CreateRole bool `json:"createRole,omitempty"`
// +kubebuilder:validation:Optional
// +kubebuilder:default=false
// WITH CREATEDB or NOCREATEDB
CreateDb bool `json:"createDb,omitempty"`
// +kubebuilder:validation:Optional
// +kubebuilder:default=false
// WITH REPLICATION or NOREPLICATION
Replication bool `json:"replication,omitempty"`
}
func (*RoleOptionsSpec) DeepCopy ¶
func (in *RoleOptionsSpec) DeepCopy() *RoleOptionsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RoleOptionsSpec.
func (*RoleOptionsSpec) DeepCopyInto ¶
func (in *RoleOptionsSpec) DeepCopyInto(out *RoleOptionsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type User ¶
type User struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec UserSpec `json:"spec,omitempty"`
Status UserStatus `json:"status,omitempty"`
}
+kubebuilder:object:root=true +kubebuilder:resource:categories={azure,dbforpostgresql} +kubebuilder:subresource:status +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="Severity",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].severity" +kubebuilder:printcolumn:name="Reason",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].reason" +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].message" +kubebuilder:storageversion User is a postgresql user.
func (*User) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new User.
func (*User) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*User) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*User) GetConditions ¶
func (user *User) GetConditions() conditions.Conditions
GetConditions returns the conditions of the resource
func (*User) Hub ¶
func (user *User) Hub()
Hub marks that this userSpec is the hub type for conversion
func (*User) Owner ¶
func (user *User) Owner() *genruntime.ResourceReference
Owner returns the ResourceReference of the owner, or nil if there is no owner
func (*User) SetConditions ¶
func (user *User) SetConditions(conditions conditions.Conditions)
SetConditions sets the conditions on the resource status
type UserList ¶
type UserList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []User `json:"items"`
}
+kubebuilder:object:root=true
func (*UserList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserList.
func (*UserList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserSpec ¶
type UserSpec struct {
// AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it
// doesn't have to be.
AzureName string `json:"azureName,omitempty"`
// +kubebuilder:validation:Required
// Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also
// controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a
// reference to a dbforpostgresql.azure.com/FlexibleServer resource
Owner *genruntime.KubernetesOwnerReference `group:"dbforpostgresql.azure.com" json:"owner,omitempty" kind:"FlexibleServer"`
// Roles is the set of roles granted to the user upon creation.
// The Azure Database for PostgreSQL server is created with 3 default roles defined: azure_pg_admin, azure_superuser,
// and your server admin user (this last is a role w/ login permission, commonly called a User).
Roles []string `json:"roles,omitempty"`
// +kubebuilder:default={login: true}
// RoleOptions defines additional attributes of the user role. You can read more about these attributes
// at https://www.postgresql.org/docs/current/role-attributes.html.
RoleOptions *RoleOptionsSpec `json:"roleOptions,omitempty"`
// +kubebuilder:validation:Required
// LocalUser contains details for creating a standard (non-aad) postgresql User.
LocalUser *LocalUserSpec `json:"localUser,omitempty"`
}
func (*UserSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserSpec.
func (*UserSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserSpec) OriginalVersion ¶
OriginalVersion returns the original API version used to create the resource.
func (*UserSpec) SetAzureName ¶
SetAzureName sets the Azure name of the resource
type UserStatus ¶
type UserStatus struct {
// Conditions: The observed state of the resource
Conditions []conditions.Condition `json:"conditions,omitempty"`
}
func (*UserStatus) DeepCopy ¶
func (in *UserStatus) DeepCopy() *UserStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserStatus.
func (*UserStatus) DeepCopyInto ¶
func (in *UserStatus) DeepCopyInto(out *UserStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.