v1

Documentation

Overview

Package v1 contains API Schema definitions for the operator v1 API group +kubebuilder:object:generate=true +groupName=operator.postgrest.org

Index

• Variables
• type ConnectionProperties
  • func (in *ConnectionProperties) DeepCopy() *ConnectionProperties
  • func (in *ConnectionProperties) DeepCopyInto(out *ConnectionProperties)
• type Postgrest
  • func (in *Postgrest) DeepCopy() *Postgrest
  • func (in *Postgrest) DeepCopyInto(out *Postgrest)
  • func (in *Postgrest) DeepCopyObject() runtime.Object
• type PostgrestList
  • func (in *PostgrestList) DeepCopy() *PostgrestList
  • func (in *PostgrestList) DeepCopyInto(out *PostgrestList)
  • func (in *PostgrestList) DeepCopyObject() runtime.Object
• type PostgrestSpec
  • func (in *PostgrestSpec) DeepCopy() *PostgrestSpec
  • func (in *PostgrestSpec) DeepCopyInto(out *PostgrestSpec)
• type PostgrestStatus
  • func (in *PostgrestStatus) DeepCopy() *PostgrestStatus
  • func (in *PostgrestStatus) DeepCopyInto(out *PostgrestStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "operator.postgrest.org", 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
)

Types

type ConnectionProperties

type ConnectionProperties struct {
	Host     string `json:"host,omitempty"`
	Port     int    `json:"port,omitempty"`
	Database string `json:"database,omitempty"`
	User     string `json:"user,omitempty"`
	Password string `json:"password,omitempty"`
	// Additional connection properties as query parameters (e.g., sslmode=disable)
	ExtraParams string `json:"extraParams,omitempty"`
	// Alternative to user and password properties; secret will have to contain USER and PASSWORD, optionally POSTGRES_URL
	SecretName string `json:"secretName,omitempty"`
}

func (*ConnectionProperties) DeepCopy

func (in *ConnectionProperties) DeepCopy() *ConnectionProperties

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionProperties.

func (*ConnectionProperties) DeepCopyInto

func (in *ConnectionProperties) DeepCopyInto(out *ConnectionProperties)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Postgrest

type Postgrest struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PostgrestSpec   `json:"spec,omitempty"`
	Status PostgrestStatus `json:"status,omitempty"`
}

Schema for the postgrests API

func (*Postgrest) DeepCopy

func (in *Postgrest) DeepCopy() *Postgrest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Postgrest.

func (*Postgrest) DeepCopyInto

func (in *Postgrest) DeepCopyInto(out *Postgrest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Postgrest) DeepCopyObject

func (in *Postgrest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PostgrestList

type PostgrestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Postgrest `json:"items"`
}

List of Postgrest

func (*PostgrestList) DeepCopy

func (in *PostgrestList) DeepCopy() *PostgrestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgrestList.

func (*PostgrestList) DeepCopyInto

func (in *PostgrestList) DeepCopyInto(out *PostgrestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PostgrestList) DeepCopyObject

func (in *PostgrestList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PostgrestSpec

type PostgrestSpec struct {
	// Schema for this PostgREST instance
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Schema string `json:"schema,omitempty"` // PGRST_DB_SCHEMAS

	// Tables to expose (only if anonymous role is auto-generated)
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Tables []string `json:"tables,omitempty"`

	// Comma-separated string of permitted actions (only if anonymous role is auto-generated)
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Grants string `json:"grants,omitempty"`

	// Role used by PostgREST to authenticate on the database; if not specified, it will be auto-generated as <CR name>_postgrest_role'
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	AnonRole string `json:"anonRole,omitempty"` // PGRST_DB_ANON_ROLE

	// Properties to connect to Postgres
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Connection ConnectionProperties `json:"connection,omitempty"`
}

PostgREST properties

func (*PostgrestSpec) DeepCopy

func (in *PostgrestSpec) DeepCopy() *PostgrestSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgrestSpec.

func (*PostgrestSpec) DeepCopyInto

func (in *PostgrestSpec) DeepCopyInto(out *PostgrestSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PostgrestStatus

type PostgrestStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status
	State             string `json:"state,omitempty" patchStrategy:"merge"`
	Message           string `json:"message,omitempty" patchStrategy:"merge"`
	GeneratedAnonRole string `json:"generatedAnonRole,omitempty" patchStrategy:"merge"`
}

PostgREST status

func (*PostgrestStatus) DeepCopy

func (in *PostgrestStatus) DeepCopy() *PostgrestStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgrestStatus.

func (*PostgrestStatus) DeepCopyInto

func (in *PostgrestStatus) DeepCopyInto(out *PostgrestStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.