plugin

package

v1.22.0 Latest Latest Go to latest Published: Dec 21, 2023 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cloudnative-pg/cloudnative-pg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package plugin contains the common behaviors of the kubectl-cnpg subcommand

Index ¶

Constants
Variables
func CreateAndGenerateObjects(ctx context.Context, k8sObject []client.Object, option bool) error
func GetPGControlData(ctx context.Context, pod corev1.Pod) (string, error)
func Print(o interface{}, format OutputFormat, writer io.Writer) error
func SetupKubernetesClient(configFlags *genericclioptions.ConfigFlags) error
type OutputFormat

Constants ¶

View Source

const (
	// OutputFormatText means just use a human-readable output
	OutputFormatText = "text"

	// OutputFormatJSON means use machine-readable JSON output
	OutputFormatJSON = "json"

	// OutputFormatYAML means use machine-readable JSON output
	OutputFormatYAML = "yaml"
)

Variables ¶

View Source

var (
	// Namespace to operate in
	Namespace string

	// NamespaceExplicitlyPassed indicates if the namespace was passed manually
	NamespaceExplicitlyPassed bool

	// Config is the Kubernetes configuration used
	Config *rest.Config

	// Client is the controller-runtime client
	Client client.Client

	// ClientInterface contains the interface used i the plugin
	ClientInterface kubernetes.Interface
)

Functions ¶

func CreateAndGenerateObjects ¶ added in v1.18.1

func CreateAndGenerateObjects(ctx context.Context, k8sObject []client.Object, option bool) error

CreateAndGenerateObjects creates provided k8s object or generate manifest collectively

func GetPGControlData ¶ added in v1.21.0

func GetPGControlData(
	ctx context.Context,
	pod corev1.Pod,
) (string, error)

GetPGControlData obtains the PgControldata from the passed pod by doing an exec. This approach should be used only in the plugin commands.

func Print ¶

func Print(o interface{}, format OutputFormat, writer io.Writer) error

Print output an object via an io.Writer in a machine-readable way

func SetupKubernetesClient ¶ added in v1.18.0

func SetupKubernetesClient(configFlags *genericclioptions.ConfigFlags) error

SetupKubernetesClient creates a k8s client to be used inside the kubectl-cnpg utility

Types ¶

type OutputFormat ¶

type OutputFormat string

OutputFormat represent the output format supported by this command

Source Files ¶

View all Source files

Directories ¶

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

Path	Synopsis
backup Package backup implements a command to request an on-demand backup for a PostgreSQL cluster	Package backup implements a command to request an on-demand backup for a PostgreSQL cluster
certificate Package certificate implement the kubectl-cnpg certificate command	Package certificate implement the kubectl-cnpg certificate command
destroy Package destroy implements a command to destroy an instances of a cluster and its associated PVC	Package destroy implements a command to destroy an instances of a cluster and its associated PVC
fence Package fence implements a command to fence instances in a cluster	Package fence implements a command to fence instances in a cluster
fio Package fio implements the fio job creation via deployment	Package fio implements the fio job creation via deployment
hibernate Package hibernate implements the hibernation feature	Package hibernate implements the hibernation feature
install Package install implements the install plugin command	Package install implements the install plugin command
logs Package logs implements the kubectl-cnpg logs command	Package logs implements the kubectl-cnpg logs command
maintenance Package maintenance implements the kubectl-cnpg maintenance sub-command	Package maintenance implements the kubectl-cnpg maintenance sub-command
pgbench Package pgbench implements the pgbench job creation	Package pgbench implements the pgbench job creation
promote Package promote implement the kubectl-cnpg promote command	Package promote implement the kubectl-cnpg promote command
psql Package psql implements the `kubectl cnpg psql` command	Package psql implements the `kubectl cnpg psql` command
reload Package reload implements a command to trigger a reconciliation loop for a cluster	Package reload implements a command to trigger a reconciliation loop for a cluster
report Package report implements the kubectl-cnpg report command	Package report implements the kubectl-cnpg report command
restart Package restart implements a command to rollout restart a cluster or restart a single instance	Package restart implements a command to rollout restart a cluster or restart a single instance
snapshot Package snapshot implements the snapshot feature	Package snapshot implements the snapshot feature
status Package status implements the kubectl-cnpg status command	Package status implements the kubectl-cnpg status command