apiservermsgs

Documentation

Index

• Constants
• type ApplyPolicyRequest
• type ApplyPolicyResponse
• type ApplyResults
• type BasicAuthCredentials
  • func (b BasicAuthCredentials) HasUsernameAndPassword() bool
• type CatRequest
• type CatResponse
• type ClusterScaleResponse
• type ClusterTestDetail
• type ClusterTestRequest
• type ClusterTestResponse
• type ClusterTestResult
• type CreateBackrestBackupRequest
• type CreateBackrestBackupResponse
• type CreateBackupRequest
• type CreateBackupResponse
• type CreateBenchmarkRequest
  • func (c CreateBenchmarkRequest) Validate() error
• type CreateBenchmarkResponse
• type CreateClusterRequest
• type CreateClusterResponse
• type CreateFailoverRequest
• type CreateFailoverResponse
• type CreatePgbouncerRequest
• type CreatePgbouncerResponse
• type CreatePgpoolRequest
• type CreatePgpoolResponse
• type CreatePolicyRequest
• type CreatePolicyResponse
• type CreateScheduleRequest
• type CreateScheduleResponse
• type CreateUpgradeRequest
• type CreateUpgradeResponse
• type CreateUserRequest
• type CreateUserResponse
• type CreatepgDumpBackupRequest
• type CreatepgDumpBackupResponse
• type DeleteBackupResponse
• type DeleteBenchmarkRequest
  • func (d DeleteBenchmarkRequest) Validate() error
• type DeleteBenchmarkResponse
• type DeleteClusterRequest
• type DeleteClusterResponse
• type DeleteLabelRequest
• type DeletePgbouncerRequest
• type DeletePgbouncerResponse
• type DeletePgpoolRequest
• type DeletePgpoolResponse
• type DeletePolicyRequest
• type DeletePolicyResponse
• type DeleteScheduleRequest
• type DeleteScheduleResponse
• type DeleteUserResponse
• type DfDetail
• type DfResponse
• type FailoverTargetSpec
• type KeyValue
• type LabelRequest
• type LabelResponse
• type LoadRequest
• type LoadResponse
• type LsRequest
• type LsResponse
• type NamespaceResult
• type NodeInfo
• type PgRestoreRequest
• type PgRestoreResponse
• type PgbasebackupRestoreRequest
• type PgbasebackupRestoreResponse
• type QueryFailoverRequest
• type QueryFailoverResponse
• type ReloadRequest
• type ReloadResponse
• type RestoreRequest
• type RestoreResponse
• type ScaleDownResponse
• type ScaleQueryResponse
• type ScaleQueryTargetSpec
• type ShowBackrestDetail
• type ShowBackrestResponse
• type ShowBackupResponse
• type ShowBenchmarkRequest
  • func (s ShowBenchmarkRequest) Validate() error
• type ShowBenchmarkResponse
• type ShowClusterDeployment
• type ShowClusterDetail
• type ShowClusterPod
• type ShowClusterReplica
• type ShowClusterRequest
• type ShowClusterResponse
• type ShowClusterService
• type ShowConfigResponse
• type ShowNamespaceResponse
• type ShowPVCRequest
• type ShowPVCResponse
• type ShowPolicyRequest
• type ShowPolicyResponse
• type ShowScheduleRequest
• type ShowScheduleResponse
• type ShowUserDetail
• type ShowUserResponse
• type ShowUserSecret
• type ShowWorkflowDetail
• type ShowWorkflowResponse
• type ShowpgDumpDetail
• type Status
• type StatusDetail
• type StatusResponse
• type UpdateClusterResponse
• type UserRequest
• type UserResponse
• type VersionResponse

Constants

const Error = "error"

const Ok = "ok"

Ok status

const PGO_VERSION = "4.0.1"

const PodTypeBackup = "backup"

const PodTypePgbackrest = "pgbackrest"

const PodTypePgbouncer = "pgbouncer"

const PodTypePgpool = "pgpool"

const PodTypePrimary = "primary"

const PodTypeReplica = "replica"

const PodTypeUnknown = "unknown"

Types

type ApplyPolicyRequest

type ApplyPolicyRequest struct {
	Name          string
	Selector      string
	DryRun        bool
	Namespace     string
	ClientVersion string
}

ApplyPolicyRequest ...

type ApplyPolicyResponse

type ApplyPolicyResponse struct {
	Name []string
	Status
}

ApplyPolicyResponse ...

type ApplyResults

type ApplyResults struct {
	Results []string
}

ApplyResults ...

type BasicAuthCredentials

type BasicAuthCredentials struct {
	Username     string
	Password     string
	APIServerURL string
}

func (BasicAuthCredentials) HasUsernameAndPassword

func (b BasicAuthCredentials) HasUsernameAndPassword() bool

type CatRequest

type CatRequest struct {
	Namespace string
	Args      []string
}

CatRequest ...

type CatResponse

type CatResponse struct {
	Results []string
	Status
}

CatResponse ...

type ClusterScaleResponse

type ClusterScaleResponse struct {
	Results []string
	Status
}

ClusterScaleResponse ...

type ClusterTestDetail

type ClusterTestDetail struct {
	PsqlString string
	Working    bool
}

ClusterTestDetail ...

type ClusterTestRequest

type ClusterTestRequest struct {
	Clustername   string
	Selector      string
	ClientVersion string
	Namespace     string
	AllFlag       bool
}

ClusterTestRequest ...

type ClusterTestResponse

type ClusterTestResponse struct {
	Results []ClusterTestResult
	Status
}

ClusterTestResponse ...

type ClusterTestResult

type ClusterTestResult struct {
	ClusterName string
	Items       []ClusterTestDetail
}

ClusterTestResult ...

type CreateBackrestBackupRequest

type CreateBackrestBackupRequest struct {
	Namespace           string
	Args                []string
	Selector            string
	BackupOpts          string
	BackrestStorageType string
}

CreateBackrestBackupRequest ...

type CreateBackrestBackupResponse

type CreateBackrestBackupResponse struct {
	Results []string
	Status
}

CreateBackrestBackupResponse ...

type CreateBackupRequest

type CreateBackupRequest struct {
	Namespace     string
	Args          []string
	Selector      string
	PVCName       string
	StorageConfig string
	BackupOpts    string
}

CreateBackupRequest ...

type CreateBackupResponse

type CreateBackupResponse struct {
	Results []string
	Status
}

CreateBackupResponse ...

type CreateBenchmarkRequest

type CreateBenchmarkRequest struct {
	Args          []string
	BenchmarkOpts string
	Clients       int
	ClusterName   string
	Database      string
	InitOpts      string
	Jobs          int
	Namespace     string
	Policy        string
	Scale         int
	Selector      string
	Transactions  int
	User          string
}

CreateBenchmarkRequest ...

func (CreateBenchmarkRequest) Validate

func (c CreateBenchmarkRequest) Validate() error

type CreateBenchmarkResponse

type CreateBenchmarkResponse struct {
	Results []string
	Status
}

CreateBenchmarkResponse ...

type CreateClusterRequest

type CreateClusterRequest struct {
	Name                string
	Namespace           string
	NodeLabel           string
	Password            string
	SecretFrom          string
	UserLabels          string
	Policies            string
	CCPImage            string
	CCPImageTag         string
	Series              int
	ReplicaCount        int
	ServiceType         string
	MetricsFlag         bool
	BadgerFlag          bool
	AutofailFlag        bool
	ArchiveFlag         bool
	BackrestFlag        string
	BackrestStorageType string
	//BackrestRestoreFrom  string
	PgpoolFlag           bool
	PgbouncerFlag        bool
	PgpoolSecret         string
	PgbouncerSecret      string
	PgbouncerPass        string
	PgbouncerUser        string
	CustomConfig         string
	StorageConfig        string
	ReplicaStorageConfig string
	ContainerResources   string
	ClientVersion        string
}

CreateClusterRequest ...

type CreateClusterResponse

type CreateClusterResponse struct {
	Results []string
	Status
}

CreateClusterResponse ...

type CreateFailoverRequest

type CreateFailoverRequest struct {
	Namespace              string
	ClusterName            string
	AutofailReplaceReplica string
	Target                 string
	ClientVersion          string
}

CreateFailoverRequest ...

type CreateFailoverResponse

type CreateFailoverResponse struct {
	Results []string
	Targets string
	Status
}

CreateFailoverResponse ...

type CreatePgbouncerRequest

type CreatePgbouncerRequest struct {
	Args          []string
	Selector      string
	Namespace     string
	PgbouncerUser string
	PgbouncerPass string
	ClientVersion string
}

CreatePgbouncerRequest ...

type CreatePgbouncerResponse

type CreatePgbouncerResponse struct {
	Results []string
	Status
}

CreatePgbouncerResponse ...

type CreatePgpoolRequest

type CreatePgpoolRequest struct {
	Args          []string
	Selector      string
	PgpoolSecret  string
	Namespace     string
	ClientVersion string
}

CreatePgpoolRequest ...

type CreatePgpoolResponse

type CreatePgpoolResponse struct {
	Results []string
	Status
}

CreatePgpoolResponse ...

type CreatePolicyRequest

type CreatePolicyRequest struct {
	Name          string
	URL           string
	SQL           string
	Namespace     string
	ClientVersion string
}

CreatePolicyRequest ...

type CreatePolicyResponse

type CreatePolicyResponse struct {
	Status
}

CreatePolicyResponse ...

type CreateScheduleRequest

type CreateScheduleRequest struct {
	ClusterName         string
	Name                string
	Namespace           string
	Schedule            string
	ScheduleType        string
	Selector            string
	PGBackRestType      string
	BackrestStorageType string
	PVCName             string
	ScheduleOptions     string
	StorageConfig       string
	PolicyName          string
	Database            string
	Secret              string
}

CreateScheduleRequest ...

type CreateScheduleResponse

type CreateScheduleResponse struct {
	Results []string
	Status
}

type CreateUpgradeRequest

type CreateUpgradeRequest struct {
	Args          []string
	Selector      string
	Namespace     string
	CCPImageTag   string
	ClientVersion string
}

CreateUpgradeRequest ...

type CreateUpgradeResponse

type CreateUpgradeResponse struct {
	Results []string
	Status
}

CreateUpgradeResponse ...

type CreateUserRequest

type CreateUserRequest struct {
	Name            string
	Namespace       string
	Selector        string
	Password        string
	ManagedUser     bool
	UserDBAccess    string
	PasswordAgeDays int
	ClientVersion   string
	PasswordLength  int
}

CreateUserRequest ...

type CreateUserResponse

type CreateUserResponse struct {
	Results []string
	Status
}

CreateUserResponse ...

type CreatepgDumpBackupRequest

type CreatepgDumpBackupRequest struct {
	Namespace     string
	Args          []string
	Selector      string
	PVCName       string
	StorageConfig string
	BackupOpts    string
}

type CreatepgDumpBackupResponse

type CreatepgDumpBackupResponse struct {
	Results []string
	Status
}

type DeleteBackupResponse

type DeleteBackupResponse struct {
	Results []string
	Status
}

DeleteBackupResponse ...

type DeleteBenchmarkRequest

type DeleteBenchmarkRequest struct {
	Args        []string
	Namespace   string
	ClusterName string
	Selector    string
}

func (DeleteBenchmarkRequest) Validate

func (d DeleteBenchmarkRequest) Validate() error

type DeleteBenchmarkResponse

type DeleteBenchmarkResponse struct {
	Results []string
	Status
}

type DeleteClusterRequest

type DeleteClusterRequest struct {
	Clustername   string
	Selector      string
	ClientVersion string
	Namespace     string
	AllFlag       bool
	DeleteBackups bool
	DeleteData    bool
}

DeleteClusterRequest ...

type DeleteClusterResponse

type DeleteClusterResponse struct {
	Results []string
	Status
}

DeleteClusterResponse ...

type DeleteLabelRequest

type DeleteLabelRequest struct {
	Selector      string
	Namespace     string
	Args          []string
	LabelCmdLabel string
	ClientVersion string
}

DeleteLabelRequest ...

type DeletePgbouncerRequest

type DeletePgbouncerRequest struct {
	Args          []string
	Selector      string
	Namespace     string
	ClientVersion string
}

DeletePgbouncerRequest ...

type DeletePgbouncerResponse

type DeletePgbouncerResponse struct {
	Results []string
	Status
}

DeletePgbouncerResponse ...

type DeletePgpoolRequest

type DeletePgpoolRequest struct {
	Args          []string
	Selector      string
	Namespace     string
	ClientVersion string
}

DeletePgpoolRequest ...

type DeletePgpoolResponse

type DeletePgpoolResponse struct {
	Results []string
	Status
}

DeletePgpoolResponse ...

type DeletePolicyRequest

type DeletePolicyRequest struct {
	Selector      string
	Namespace     string
	AllFlag       bool
	ClientVersion string
	PolicyName    string
}

DeletePolicyRequest ...

type DeletePolicyResponse

type DeletePolicyResponse struct {
	Results []string
	Status
}

DeletePolicyResponse ...

type DeleteScheduleRequest

type DeleteScheduleRequest struct {
	Namespace    string
	ScheduleName string
	ClusterName  string
	Selector     string
}

type DeleteScheduleResponse

type DeleteScheduleResponse struct {
	Results []string
	Status
}

type DeleteUserResponse

type DeleteUserResponse struct {
	Results []string
	Status
}

DeleteUserResponse ...

type DfDetail

type DfDetail struct {
	Name      string
	PGSize    string
	ClaimSize string
	Pct       int64
	Working   bool
}

this aggregated status comes from the pgo-status container by means of a volume mounted json blob it generates

type DfResponse

type DfResponse struct {
	Results []DfDetail
	Status
}

ShowClusterResponse ...

type FailoverTargetSpec

type FailoverTargetSpec struct {
	Name            string
	ReadyStatus     string
	Node            string
	PreferredNode   bool
	RepStatus       string
	ReceiveLocation uint64
	ReplayLocation  uint64
}

type KeyValue

type KeyValue struct {
	Key   string
	Value int
}

type LabelRequest

type LabelRequest struct {
	Selector      string
	Namespace     string
	Args          []string
	LabelCmdLabel string
	DryRun        bool
	DeleteLabel   bool
	ClientVersion string
}

LabelRequest ...

type LabelResponse

type LabelResponse struct {
	Results []string
	Status
}

LabelResponse ...

type LoadRequest

type LoadRequest struct {
	Args          []string
	Selector      string
	Namespace     string
	LoadConfig    string
	Policies      string
	ClientVersion string
}

LoadRequest ...

type LoadResponse

type LoadResponse struct {
	Results []string
	Status
}

LoadResponse ...

type LsRequest

type LsRequest struct {
	Namespace string
	Args      []string
}

LsRequest ...

type LsResponse

type LsResponse struct {
	Results []string
	Status
}

LsResponse ...

type NamespaceResult

type NamespaceResult struct {
	Namespace  string
	UserAccess bool
}

type NodeInfo

type NodeInfo struct {
	Name   string
	Status string
	Labels map[string]string
}

type PgRestoreRequest

type PgRestoreRequest struct {
	Namespace   string
	FromCluster string
	FromPVC     string
	RestoreOpts string
	PITRTarget  string
	NodeLabel   string
}

type PgRestoreResponse

type PgRestoreResponse struct {
	Results []string
	Status
}

type PgbasebackupRestoreRequest

type PgbasebackupRestoreRequest struct {
	Namespace   string
	FromCluster string
	ToPVC       string
	FromPVC     string
	BackupPath  string
	NodeLabel   string
}

PgbasebackupRestoreRequest ...

type PgbasebackupRestoreResponse

type PgbasebackupRestoreResponse struct {
	Results []string
	Status
}

PgbasebackupRestoreResponse ...

type QueryFailoverRequest

type QueryFailoverRequest struct {
	ClusterName   string
	ClientVersion string
}

QueryFailoverRequest ...

type QueryFailoverResponse

type QueryFailoverResponse struct {
	Results []string
	Targets []FailoverTargetSpec
	Status
}

QueryFailoverResponse ...

type ReloadRequest

type ReloadRequest struct {
	Namespace string
	Args      []string
	Selector  string
}

ReloadRequest ...

type ReloadResponse

type ReloadResponse struct {
	Results []string
	Status
}

ReloadResponse ...

type RestoreRequest

type RestoreRequest struct {
	Namespace           string
	FromCluster         string
	ToPVC               string
	RestoreOpts         string
	PITRTarget          string
	NodeLabel           string
	BackrestStorageType string
}

RestoreRequest ...

type RestoreResponse

type RestoreResponse struct {
	Results []string
	Status
}

RestoreResponse ...

type ScaleDownResponse

type ScaleDownResponse struct {
	Results []string
	Status
}

type ScaleQueryResponse

type ScaleQueryResponse struct {
	Results []string
	Targets []ScaleQueryTargetSpec
	Status
}

type ScaleQueryTargetSpec

type ScaleQueryTargetSpec struct {
	Name        string
	ReadyStatus string
	Node        string
	RepStatus   string
}

type ShowBackrestDetail

type ShowBackrestDetail struct {
	Name string
	Info string
}

type ShowBackrestResponse

type ShowBackrestResponse struct {
	Items []ShowBackrestDetail
	Status
}

ShowBackrestResponse ...

type ShowBackupResponse

type ShowBackupResponse struct {
	BackupList crv1.PgbackupList
	Status
}

ShowBackupResponse ...

type ShowBenchmarkRequest

type ShowBenchmarkRequest struct {
	Args        []string
	Namespace   string
	ClusterName string
	Selector    string
}

func (ShowBenchmarkRequest) Validate

func (s ShowBenchmarkRequest) Validate() error

type ShowBenchmarkResponse

type ShowBenchmarkResponse struct {
	Results []string
	Status
}

type ShowClusterDeployment

type ShowClusterDeployment struct {
	Name         string
	PolicyLabels []string
}

ShowClusterDeployment

type ShowClusterDetail

type ShowClusterDetail struct {
	Cluster     crv1.Pgcluster
	Deployments []ShowClusterDeployment
	Pods        []ShowClusterPod
	Services    []ShowClusterService
	Replicas    []ShowClusterReplica
}

ShowClusterDetail ...

type ShowClusterPod

type ShowClusterPod struct {
	Name        string
	Phase       string
	NodeName    string
	PVCName     map[string]string
	ReadyStatus string
	Ready       bool
	Primary     bool
	Type        string
}

ShowClusterPod

type ShowClusterReplica

type ShowClusterReplica struct {
	Name string
}

ShowClusterReplica

type ShowClusterRequest

type ShowClusterRequest struct {
	Clustername   string
	Selector      string
	Ccpimagetag   string
	ClientVersion string
	Namespace     string
	AllFlag       bool
}

ShowClusterRequest ...

type ShowClusterResponse

type ShowClusterResponse struct {
	Results []ShowClusterDetail
	Status
}

ShowClusterResponse ...

type ShowClusterService

type ShowClusterService struct {
	Name         string
	Data         string
	ClusterIP    string
	ExternalIP   string
	ClusterName  string
	Pgbouncer    bool
	BackrestRepo bool
}

ShowClusterService

type ShowConfigResponse

type ShowConfigResponse struct {
	Result config.PgoConfig
	Status
}

ShowConfigResponse ...

type ShowNamespaceResponse

type ShowNamespaceResponse struct {
	Results []NamespaceResult
	Status
}

ShowNamespaceResponse ...

type ShowPVCRequest

type ShowPVCRequest struct {
	PVCName       string
	NodeLabel     string
	PVCRoot       string
	Selector      string
	ClientVersion string
	Namespace     string
	AllFlag       bool
}

ShowPVCRequest ...

type ShowPVCResponse

type ShowPVCResponse struct {
	Results []string
	Status
}

ShowPVCResponse ...

type ShowPolicyRequest

type ShowPolicyRequest struct {
	Selector      string
	Namespace     string
	AllFlag       bool
	ClientVersion string
	Policyname    string
}

ShowPolicyRequest ...

type ShowPolicyResponse

type ShowPolicyResponse struct {
	PolicyList crv1.PgpolicyList
	Status
}

ShowPolicyResponse ...

type ShowScheduleRequest

type ShowScheduleRequest struct {
	Namespace    string
	ScheduleName string
	ClusterName  string
	Selector     string
}

type ShowScheduleResponse

type ShowScheduleResponse struct {
	Results []string
	Status
}

type ShowUserDetail

type ShowUserDetail struct {
	Cluster     crv1.Pgcluster
	Secrets     []ShowUserSecret
	ExpiredMsgs []string
}

ShowUsersDetail ...

type ShowUserResponse

type ShowUserResponse struct {
	Results []ShowUserDetail
	Status
}

ShowUsersResponse ...

type ShowUserSecret

type ShowUserSecret struct {
	Name     string
	Username string
	Password string
}

ShowUserSecret

type ShowWorkflowDetail

type ShowWorkflowDetail struct {
	ClusterName string
	Parameters  map[string]string
}

type ShowWorkflowResponse

type ShowWorkflowResponse struct {
	Results ShowWorkflowDetail
	Status
}

ShowWorkflowResponse ...

type ShowpgDumpDetail

type ShowpgDumpDetail struct {
	Name string
	Info string
}

type Status

type Status struct {
	Code string
	Msg  string
}

Status ...

type StatusDetail

type StatusDetail struct {
	OperatorStartTime string
	NumDatabases      int
	NumBackups        int
	NumClaims         int
	VolumeCap         string
	DbTags            map[string]int
	NotReady          []string
	Nodes             []NodeInfo
	Labels            []KeyValue
}

this aggregated status comes from the pgo-status container by means of a volume mounted json blob it generates

type StatusResponse

type StatusResponse struct {
	Result StatusDetail
	Status
}

ShowClusterResponse ...

type UpdateClusterResponse

type UpdateClusterResponse struct {
	Results []string
	Status
}

UpdateClusterResponse ...

type UserRequest

type UserRequest struct {
	Args                  []string
	Selector              string
	Namespace             string
	PasswordAgeDays       int
	ChangePasswordForUser string
	Password              string
	DeleteUser            string
	ValidDays             string
	UserDBAccess          string
	AddUser               string
	Expired               string
	UpdatePasswords       bool
	ManagedUser           bool
	ClientVersion         string
	PasswordLength        int
}

UserRequest ...

type UserResponse

type UserResponse struct {
	Results []string
	Status
}

UserResponse ...

type VersionResponse

type VersionResponse struct {
	Version string
	Status
}

VersionResponse ...