ns

Documentation

Index

• Constants
• Variables
• func CanCreateRBACInNamespace(clientset *kubernetes.Clientset, namespace string, ...) (bool, error)
• func CheckAccessPrivs(clientset *kubernetes.Clientset, privs map[string][]string, ...) (bool, error)
• func ConfigureInstallNamespaces(clientset *kubernetes.Clientset, installationName, pgoNamespace string, ...) error
• func CreateFakeNamespaceClient(installationName string) (kubernetes.Interface, error)
• func CreateNamespace(clientset *kubernetes.Clientset, ...) error
• func DeleteNamespace(clientset *kubernetes.Clientset, ...) error
• func GetCurrentNamespaceList(clientset *kubernetes.Clientset, installationName string, ...) ([]string, error)
• func GetInitialNamespaceList(clientset *kubernetes.Clientset, namespaceOperatingMode NamespaceOperatingMode, ...) ([]string, error)
• func ReconcileTargetRBAC(clientset *kubernetes.Clientset, pgoNamespace, targetNamespace string) error
• func UpdateNamespace(clientset *kubernetes.Clientset, ...) error
• func ValidateNamespaceNames(namespace ...string) error
• func ValidateNamespacesWatched(clientset *kubernetes.Clientset, namespaceOperatingMode NamespaceOperatingMode, ...) error
• type NamespaceOperatingMode
  • func GetNamespaceOperatingMode(clientset *kubernetes.Clientset) (NamespaceOperatingMode, error)
• type PgoRole
• type PgoRoleBinding
• type PgoServiceAccount

Constants

const OPERATOR_SERVICE_ACCOUNT = "postgres-operator"

const PGO_BACKREST_ROLE = "pgo-backrest-role"

const PGO_BACKREST_ROLE_BINDING = "pgo-backrest-role-binding"

const PGO_BACKREST_SERVICE_ACCOUNT = "pgo-backrest"

const PGO_DEFAULT_SERVICE_ACCOUNT = "pgo-default"

const PGO_PG_ROLE = "pgo-pg-role"

const PGO_PG_ROLE_BINDING = "pgo-pg-role-binding"

const PGO_PG_SERVICE_ACCOUNT = "pgo-pg"

const PGO_TARGET_ROLE = "pgo-target-role"

const PGO_TARGET_ROLE_BINDING = "pgo-target-role-binding"

const PGO_TARGET_SERVICE_ACCOUNT = "pgo-target"

Variables

var (

	// ErrInvalidNamespaceName defines the error that is thrown when a namespace does not meet the
	// requirements for naming set by Kubernetes
	ErrInvalidNamespaceName = errors.New(validation.RegexError(dns1123ErrMsg, dns1123Fmt,
		"my-name", "123-abc"))
	// ErrNamespaceNotWatched defines the error that is thrown when a namespace does not meet the
	// requirements for naming set by Kubernetes
	ErrNamespaceNotWatched = errors.New("The namespaces are not watched by the " +
		"current PostgreSQL Operator installation")
)

Functions

func CanCreateRBACInNamespace

func CanCreateRBACInNamespace(clientset *kubernetes.Clientset, namespace string,
	namespaceOperatingMode NamespaceOperatingMode) (bool, error)

CanCreateRBACInNamespace returns true or false to indicate whether or not the Operator ServiceAccount has privileges to create RBAC (ServiceAccounts, Roles and RoleBindings) within the namespace specified.

func CheckAccessPrivs

func CheckAccessPrivs(clientset *kubernetes.Clientset,
	privs map[string][]string, apiGroup, namespace string) (bool, error)

CheckAccessPrivs checks to see if the ServiceAccount currently running the operator has the permissions defined for various resources as specified in the provided permissions map. If an empty namespace is provided then it is assumed the resource is cluster-scoped. If the ServiceAccount has all of the permissions defined in the permissions map, then "true" is returned. Otherwise, if the Service Account is missing any of the permissions specified, or if an error is encountered while attempting to deterine the permissions for the service account, then "false" is returned (along with the error in the event an error is encountered).

func ConfigureInstallNamespaces

func ConfigureInstallNamespaces(clientset *kubernetes.Clientset, installationName, pgoNamespace string,
	namespaceNames []string, namespaceOperatingMode NamespaceOperatingMode) error

ConfigureInstallNamespaces is responsible for properly configuring up any namespaces provided for the installation of the Operator. This includes creating or updating those namespaces so they can be utilized by the Operator to deploy PG clusters.

func CreateFakeNamespaceClient

func CreateFakeNamespaceClient(installationName string) (kubernetes.Interface, error)

CreateFakeNamespaceClient creates a fake namespace client for use with the "disabled" namespace operating mode

func CreateNamespace

func CreateNamespace(clientset *kubernetes.Clientset, installationName, pgoNamespace,
	createdBy, newNs string) error

CreateNamespace creates a new namespace that is owned by the Operator.

func DeleteNamespace

func DeleteNamespace(clientset *kubernetes.Clientset, installationName, pgoNamespace, deletedBy, ns string) error

DeleteNamespace deletes the namespace specified.

func GetCurrentNamespaceList

func GetCurrentNamespaceList(clientset *kubernetes.Clientset,
	installationName string, namespaceOperatingMode NamespaceOperatingMode) ([]string, error)

GetCurrentNamespaceList returns the current list namespaces being managed by the current Operateor installation. When the current namespace mode is "dynamic" or "readOnly", this involves querying the Kube cluster for an namespaces with the "vendor" and "pgo-installation-name" labels corresponding to the current Operator install. When the namespace mode is "disabled", a list of namespaces specified using the NAMESPACE env var during installation is returned (with the list defaulting to the Operator's own namespace in the event that NAMESPACE is empty).

func GetInitialNamespaceList

func GetInitialNamespaceList(clientset *kubernetes.Clientset,
	namespaceOperatingMode NamespaceOperatingMode,
	installationName, pgoNamespace string) ([]string, error)

GetInitialNamespaceList returns an initial list of namespaces for the current Operator install. This includes first obtaining any namespaces from the NAMESPACE env var, and then if the namespace operating mode permits, also querying the Kube cluster in order to obtain any other namespaces that are part of the install, but not included in the env var. If no namespaces are identified via either of these methods, then the the PGO namespaces is returned as the default namespace.

func ReconcileTargetRBAC

func ReconcileTargetRBAC(clientset *kubernetes.Clientset, pgoNamespace,
	targetNamespace string) error

ReconcileTargetRBAC ensures the RBAC resources in a target namespace are valid, reconciling (i.e. updating or recreating) them if not.

func UpdateNamespace

func UpdateNamespace(clientset *kubernetes.Clientset, installationName, pgoNamespace,
	updatedBy, ns string) error

UpdateNamespace updates a new namespace to be owned by the Operator.

func ValidateNamespaceNames

func ValidateNamespaceNames(namespace ...string) error

ValidateNamespaceNames validates one or more namespace names to ensure they are valid per Kubernetes naming requirements.

func ValidateNamespacesWatched

func ValidateNamespacesWatched(clientset *kubernetes.Clientset,
	namespaceOperatingMode NamespaceOperatingMode,
	installationName string, namespaces ...string) error

ValidateNamespacesWatched validates whether or not the namespaces provided are being watched by the current Operator installation. When the current namespace mode is "dynamic" or "readOnly", this involves ensuring the namespace specified has the proper "vendor" and "pgo-installation-name" labels corresponding to the current Operator install. When the namespace mode is "disabled", this means ensuring the namespace is in the list of those specifiedusing the NAMESPACE env var during installation (with the list defaulting to the Operator's own namespace in the event that NAMESPACE is empty). If any namespaces are found to be invalid, an ErrNamespaceNotWatched error is returned containing an error message listing the invalid namespaces.

Types

type NamespaceOperatingMode

type NamespaceOperatingMode string

NamespaceOperatingMode defines the different namespace operating modes for the Operator

const (
	// NamespaceOperatingModeDynamic enables full dynamic namespace capabilities, in which the
	// Operator can create, delete and update any namespaces within the Kubernetes cluster, while
	// then also having the ability to create the roles, role bindings and service accounts within
	// those namespaces as required for the Operator to create PG clusters.  Additionally, while in
	// this mode the Operator can listen for namespace events (e.g. namespace additions, updates
	// and deletions), and then create or remove controllers for various namespaces as those
	// namespaces are added or removed from the Kubernetes cluster.
	NamespaceOperatingModeDynamic NamespaceOperatingMode = "dynamic"
	// NamespaceOperatingModeReadOnly allows the Operator to listen for namespace events within the
	// Kubernetetes cluster, and then create and run and/or remove controllers as namespaces are
	// added and deleted.  However, while in this mode the Operator is unable to create, delete or
	// update namespaces, nor can it create the RBAC it requires in any of those namespaces to
	// create PG clusters.  Therefore,  while in a "readonly" mode namespaces must be
	// pre-configured with the proper RBAC, since the Operator cannot create the RBAC itself.
	NamespaceOperatingModeReadOnly NamespaceOperatingMode = "readonly"
	// NamespaceOperatingModeDisabled causes namespace capabilities to be disabled altogether.  In
	// this mode the Operator will simply attempt to work with the target namespaces specified
	// during installation.  If no target namespaces are specified, then it will be configured to
	// work within the namespace in which the Operator is deployed.
	NamespaceOperatingModeDisabled NamespaceOperatingMode = "disabled"
)

func GetNamespaceOperatingMode

func GetNamespaceOperatingMode(clientset *kubernetes.Clientset) (NamespaceOperatingMode, error)

GetNamespaceOperatingMode is responsible for returning the proper namespace operating mode for the current Operator install. This is done by submitting a SubjectAccessReview in the local Kubernetes cluster to determine whether or not certain cluster-level privileges have been assigned to the Operator Service Account. Based on the privileges identified, one of the a the proper NamespaceOperatingMode will be returned as applicable for those privileges (please see the various NamespaceOperatingMode types for a detailed explanation of each operating mode).

type PgoRole

type PgoRole struct {
	TargetNamespace string
}

PgoRole is used to populate the following Role templates: pgo-target-role.json pgo-backrest-role.json pgo-pg-role.json

type PgoRoleBinding

type PgoRoleBinding struct {
	TargetNamespace   string
	OperatorNamespace string
}

PgoRoleBinding is used to populate the following RoleBinding templates: pgo-target-role-binding.json pgo-backrest-role-binding.json pgo-pg-role-binding.json

type PgoServiceAccount

type PgoServiceAccount struct {
	TargetNamespace string
}

PgoServiceAccount is used to populate the following ServiceAccount templates: pgo-default-sa.json pgo-target-sa.json pgo-backrest-sa.json pgo-pg-sa.json