management

package

v1.30.1 Latest Latest Go to latest Published: Sep 23, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation ¶

Overview ¶

Package management contains all the features needed by the instance manager that runs in each Pod as PID 1

Index ¶

Variables
func NewControllerRuntimeClient() (client.WithWatch, error)
func NewEventRecorder() (record.EventRecorder, error)
func WaitForClusterCertificates(ctx context.Context, cli client.Client, clusterObjectKey client.ObjectKey) (*apiv1.Cluster, error)
func WaitForGetCluster(ctx context.Context, clusterObjectKey client.ObjectKey) error
func WaitForGetClusterWithClient(ctx context.Context, cli client.Client, clusterObjectKey client.ObjectKey) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Scheme used for the instance manager
	Scheme = runtime.NewScheme()
)

Functions ¶

func NewControllerRuntimeClient ¶

func NewControllerRuntimeClient() (client.WithWatch, error)

NewControllerRuntimeClient creates a new typed K8s client where the PostgreSQL CRD and some basic k8s resources have been already registered.

While using the typed client you may encounter an error like this: no matches for kind "X" in version "Y".

This means that the runtime.Object is missing and needs to registered in the client.

func NewEventRecorder ¶

func NewEventRecorder() (record.EventRecorder, error)

NewEventRecorder creates a new event recorder

func WaitForClusterCertificates ¶ added in v1.29.3

func WaitForClusterCertificates(
	ctx context.Context,
	cli client.Client,
	clusterObjectKey client.ObjectKey,
) (*apiv1.Cluster, error)

WaitForClusterCertificates polls the Cluster until its status has the certificate secret names, then returns it. Use the returned Cluster: a new Get can come back with an older copy, with the names empty again.

The wait has no time limit. The operator never waits on this Pod before writing the status, so this wait cannot block that write.

func WaitForGetCluster ¶ added in v1.23.5

func WaitForGetCluster(ctx context.Context, clusterObjectKey client.ObjectKey) error

WaitForGetCluster will wait for a successful get cluster to be executed. Returns any error encountered.

func WaitForGetClusterWithClient ¶ added in v1.25.0

func WaitForGetClusterWithClient(ctx context.Context, cli client.Client, clusterObjectKey client.ObjectKey) error

WaitForGetClusterWithClient will wait for a successful get cluster to be executed

Types ¶

This section is empty.

Source Files ¶

View all Source files

client.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
external Package external contains the functions needed to manage servers which are external to this PostgreSQL cluster	Package external contains the functions needed to manage servers which are external to this PostgreSQL cluster
internal/pgpass Package pgpass allows the user to generate a PostgreSQL .pgpass file See: https://www.postgresql.org/docs/current/libpq-pgpass.html	Package pgpass allows the user to generate a PostgreSQL .pgpass file See: https://www.postgresql.org/docs/current/libpq-pgpass.html
logtest Package logtest contains the testing utils for the logging subsystem of the instance manager	Package logtest contains the testing utils for the logging subsystem of the instance manager
pgbouncer
config Package config contains the code related to the generation of the PgBouncer configuration	Package config contains the code related to the generation of the PgBouncer configuration
metricsserver Package metricsserver contains the web server powering metrics	Package metricsserver contains the web server powering metrics
postgres Package postgres contains the function about starting up, shutting down and managing a PostgreSQL instance.	Package postgres contains the function about starting up, shutting down and managing a PostgreSQL instance.
archiver Package archiver contains the logic of the CloudNativePG WAL archiver	Package archiver contains the logic of the CloudNativePG WAL archiver
constants Package constants provides the needed constants in the postgres package	Package constants provides the needed constants in the postgres package
logicalimport Package logicalimport contains the logic needed to import a logical snapshot	Package logicalimport contains the logic needed to import a logical snapshot
logpipe Package logpipe implements reading csv logs from PostgreSQL logging_collector (https://www.postgresql.org/docs/current/runtime-config-logging.html) and convert them to JSON.	Package logpipe implements reading csv logs from PostgreSQL logging_collector (https://www.postgresql.org/docs/current/runtime-config-logging.html) and convert them to JSON.
metrics Package metrics enables to expose a set of metrics and collectors on a given postgres instance	Package metrics enables to expose a set of metrics and collectors on a given postgres instance
metrics/histogram Package histogram contain histogram-metrics related functions	Package histogram contain histogram-metrics related functions
pool Package pool contain an implementation of a connection pool to multiple database pointing to the same instance	Package pool contain an implementation of a connection pool to multiple database pointing to the same instance
utils Package utils holds generic utils about postgres instances	Package utils holds generic utils about postgres instances
webserver Package webserver contains the web server powering probes, backups and metrics	Package webserver contains the web server powering probes, backups and metrics
webserver/client/common Package common provides common utilities for the webserver client.	Package common provides common utilities for the webserver client.
webserver/client/local Package local provides a client to interact with the local webserver endpoints.	Package local provides a client to interact with the local webserver endpoints.
webserver/client/remote Package remote contains the client capable of querying the webserver remote endpoint.	Package remote contains the client capable of querying the webserver remote endpoint.
webserver/metricserver Package metricserver contains the web server powering metrics	Package metricserver contains the web server powering metrics
webserver/probes Package probes contains the implementation of startup, liveness and readiness probes	Package probes contains the implementation of startup, liveness and readiness probes
upgrade Package upgrade manages the in-place upgrade of the instance manager	Package upgrade manages the in-place upgrade of the instance manager
url Package url holds the constants for webserver routing	Package url holds the constants for webserver routing