README
¶
CloudNativePG - Machinery
The CloudNativePG codebase is not intended to be used as a library.
This repository hosts a Go module that includes features that were moved out of the CloudNativePG codebase to make them accessible for use in other projects.
How to use it
As a Go module:
go get github.com/cloudnative-pg/machinery
The documentation is available on the pkg.go.dev website.
Users
This library is used by CloudNativePG itself and by the supporting
barman-cloud library.
License
This code is released under the permissive Apache License 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
api
Package api contains a set of reusable structures to reference a Kubernetes resource or a key inside a Secret or ConfigMap.
|
Package api contains a set of reusable structures to reference a Kubernetes resource or a key inside a Secret or ConfigMap. |
|
env
Package env contains useful functions to manage the system environment
|
Package env contains useful functions to manage the system environment |
|
envmap
Package envmap is a set of utility functions to manage a process environment as a map between the environment variable names and their value
|
Package envmap is a set of utility functions to manage a process environment as a map between the environment variable names and their value |
|
execlog
Package execlog is a set of utility functions allowing the caller to run an external process while dumping its output into a JSON-formatted log stream.
|
Package execlog is a set of utility functions allowing the caller to run an external process while dumping its output into a JSON-formatted log stream. |
|
fileutils
Package fileutils contains utility functions to work with a file system
|
Package fileutils contains utility functions to work with a file system |
|
fileutils/compatibility
Package compatibility provides a layer to cross-compile with other OS than Linux
|
Package compatibility provides a layer to cross-compile with other OS than Linux |
|
fileutils/wals
Package wals implements the management of WAL files list
|
Package wals implements the management of WAL files list |
|
hash
Package hash allows the user to get a hash number for a given Kubernetes object.
|
Package hash allows the user to get a hash number for a given Kubernetes object. |
|
image/reference
Package reference contains an image reference parser
|
Package reference contains an image reference parser |
|
log
Package log contains the CloudNativePG logging infrastructure
|
Package log contains the CloudNativePG logging infrastructure |
|
postgres/pgconfig
Package pgconfig contains a Go interface for the "pg_config" utility
|
Package pgconfig contains a Go interface for the "pg_config" utility |
|
postgres/time
Package time contains some useful functions to manage timestamps in the same representation that PostgreSQL uses.
|
Package time contains some useful functions to manage timestamps in the same representation that PostgreSQL uses. |
|
postgres/version
Package version contains a PostgreSQL image version parser with the corresponding data type and operations on it
|
Package version contains a PostgreSQL image version parser with the corresponding data type and operations on it |
|
stringset
Package stringset implements a basic set of strings
|
Package stringset implements a basic set of strings |
|
types
Package types the common types used by CNPG
|
Package types the common types used by CNPG |
Click to show internal directories.
Click to hide internal directories.