Documentation ¶
Index ¶
- type Alertmanager
- type AlertmanagerSpec
- type AllowedRegistry
- type BackupCredentials
- type BackupStatus
- type ClusterTemplate
- type ClusterTemplateInstance
- type ClusterTemplateList
- type ClusterTemplateSSHKey
- type Constraint
- type ConstraintStatus
- type ConstraintTemplate
- type EtcdBackupConfig
- type EtcdBackupConfigCondition
- type EtcdBackupConfigSpec
- type EtcdBackupConfigStatus
- type EtcdRestore
- type EtcdRestoreSpec
- type EtcdRestoreStatus
- type GVK
- type GatekeeperConfig
- type GatekeeperConfigSpec
- type MLA
- type MLAAdminSetting
- type MatchEntry
- type OIDCSpec
- type Preset
- type PresetList
- type PresetProvider
- type ReadinessSpec
- type RuleGroup
- type S3BackupCredentials
- type SeedSettings
- type Sync
- type Trace
- type Validation
- type Violation
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Alertmanager ¶ added in v2.18.0
type Alertmanager struct {
Spec AlertmanagerSpec `json:"spec"`
}
Alertmanager represents an Alertmanager Configuration swagger:model Alertmanager
type AlertmanagerSpec ¶ added in v2.18.0
type AlertmanagerSpec struct { // Config contains the alertmanager configuration in YAML Config []byte `json:"config"` }
type AllowedRegistry ¶ added in v2.18.0
type AllowedRegistry struct { Name string `json:"name"` Spec crdapiv1.AllowedRegistrySpec `json:"spec"` }
AllowedRegistry represents a object containing a allowed image registry prefix swagger:model AllowedRegistry
type BackupCredentials ¶ added in v2.18.0
type BackupCredentials struct {
S3BackupCredentials S3BackupCredentials `json:"s3,omitempty"`
}
BackupCredentials contains credentials for etcd backups swagger:model BackupCredentials
type BackupStatus ¶ added in v2.18.0
type BackupStatus struct { // ScheduledTime will always be set when the BackupStatus is created, so it'll never be nil ScheduledTime *apiv1.Time `json:"scheduledTime,omitempty"` BackupName string `json:"backupName,omitempty"` JobName string `json:"jobName,omitempty"` BackupStartTime *apiv1.Time `json:"backupStartTime,omitempty"` BackupFinishedTime *apiv1.Time `json:"backupFinishedTime,omitempty"` BackupPhase crdapiv1.BackupStatusPhase `json:"backupPhase,omitempty"` BackupMessage string `json:"backupMessage,omitempty"` DeleteJobName string `json:"deleteJobName,omitempty"` DeleteStartTime *apiv1.Time `json:"deleteStartTime,omitempty"` DeleteFinishedTime *apiv1.Time `json:"deleteFinishedTime,omitempty"` DeletePhase crdapiv1.BackupStatusPhase `json:"deletePhase,omitempty"` DeleteMessage string `json:"deleteMessage,omitempty"` }
type ClusterTemplate ¶ added in v2.18.0
type ClusterTemplate struct { Name string `json:"name"` ID string `json:"id"` ProjectID string `json:"projectID,omitempty"` User string `json:"user,omitempty"` Scope string `json:"scope"` UserSSHKeys []ClusterTemplateSSHKey `json:"userSshKeys,omitempty"` Cluster *apiv1.Cluster `json:"cluster,omitempty"` NodeDeployment *apiv1.NodeDeployment `json:"nodeDeployment,omitempty"` }
ClusterTemplate represents a ClusterTemplate object swagger:model ClusterTemplate
type ClusterTemplateInstance ¶ added in v2.18.0
type ClusterTemplateInstance struct { Name string `json:"name"` Spec crdapiv1.ClusterTemplateInstanceSpec `json:"spec"` }
ClusterTemplateInstance represents a ClusterTemplateInstance object swagger:model ClusterTemplateInstance
type ClusterTemplateList ¶ added in v2.18.0
type ClusterTemplateList []ClusterTemplate
ClusterTemplateList represents a ClusterTemplate list swagger:model ClusterTemplateList
type ClusterTemplateSSHKey ¶ added in v2.18.0
ClusterTemplateSSHKey represents SSH Key object for Cluster Template swagger:model ClusterTemplateSSHKey
type Constraint ¶
type Constraint struct { Name string `json:"name"` Labels map[string]string `json:"labels,omitempty"` Spec crdapiv1.ConstraintSpec `json:"spec"` Status *ConstraintStatus `json:"status,omitempty"` }
Constraint represents a gatekeeper Constraint swagger:model Constraint
type ConstraintStatus ¶
type ConstraintStatus struct { Enforcement string `json:"enforcement,omitempty"` AuditTimestamp string `json:"auditTimestamp,omitempty"` Violations []Violation `json:"violations,omitempty"` Synced *bool `json:"synced,omitempty"` }
ConstraintStatus represents a constraint status which holds audit info
type ConstraintTemplate ¶
type ConstraintTemplate struct { Name string `json:"name"` Spec crdapiv1.ConstraintTemplateSpec `json:"spec"` Status v1beta1.ConstraintTemplateStatus `json:"status"` }
ConstraintTemplate represents a gatekeeper ConstraintTemplate swagger:model ConstraintTemplate
type EtcdBackupConfig ¶ added in v2.18.0
type EtcdBackupConfig struct { apiv1.ObjectMeta Spec EtcdBackupConfigSpec `json:"spec"` Status EtcdBackupConfigStatus `json:"status"` }
EtcdBackupConfig represents an object holding the configuration for etcd backups swagger:model EtcdBackupConfig
type EtcdBackupConfigCondition ¶ added in v2.18.0
type EtcdBackupConfigCondition struct { // Type of EtcdBackupConfig condition. Type crdapiv1.EtcdBackupConfigConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // Last time we got an update on a given condition. // +optional LastHeartbeatTime apiv1.Time `json:"lastHeartbeatTime,omitempty"` // Last time the condition transit from one status to another. // +optional LastTransitionTime apiv1.Time `json:"lastTransitionTime,omitempty"` // (brief) reason for the condition's last transition. // +optional Reason string `json:"reason,omitempty"` // Human readable message indicating details about last transition. // +optional Message string `json:"message,omitempty"` }
type EtcdBackupConfigSpec ¶ added in v2.18.0
type EtcdBackupConfigSpec struct { // ClusterID is the id of the cluster which will be backed up ClusterID string `json:"clusterId"` // Schedule is a cron expression defining when to perform // the backup. If not set, the backup is performed exactly // once, immediately. Schedule string `json:"schedule,omitempty"` // Keep is the number of backups to keep around before deleting the oldest one // If not set, defaults to DefaultKeptBackupsCount. Only used if Schedule is set. Keep *int `json:"keep,omitempty"` }
EtcdBackupConfigSpec represents an object holding the etcd backup configuration specification swagger:model EtcdBackupConfigSpec
type EtcdBackupConfigStatus ¶ added in v2.18.0
type EtcdBackupConfigStatus struct { // CurrentBackups tracks the creation and deletion progress if all backups managed by the EtcdBackupConfig CurrentBackups []BackupStatus `json:"lastBackups,omitempty"` // Conditions contains conditions of the EtcdBackupConfig Conditions []EtcdBackupConfigCondition `json:"conditions,omitempty"` // If the controller was configured with a cleanupContainer, CleanupRunning keeps track of the corresponding job CleanupRunning bool `json:"cleanupRunning,omitempty"` }
type EtcdRestore ¶ added in v2.18.0
type EtcdRestore struct { Name string `json:"name"` Spec EtcdRestoreSpec `json:"spec"` Status EtcdRestoreStatus `json:"status"` }
EtcdRestore represents an object holding the configuration for etcd backup restore swagger:model EtcdRestore
type EtcdRestoreSpec ¶ added in v2.18.0
type EtcdRestoreSpec struct { // ClusterID is the id of the cluster which will be restored from the backup ClusterID string `json:"clusterId"` // BackupName is the name of the backup to restore from BackupName string `json:"backupName"` // BackupDownloadCredentialsSecret is the name of a secret in the cluster-xxx namespace containing // credentials needed to download the backup BackupDownloadCredentialsSecret string `json:"backupDownloadCredentialsSecret,omitempty"` }
EtcdRestoreSpec represents an object holding the etcd backup restore configuration specification swagger:model EtcdRestoreSpec
type EtcdRestoreStatus ¶ added in v2.18.0
type EtcdRestoreStatus struct { Phase crdapiv1.EtcdRestorePhase `json:"phase"` RestoreTime *apiv1.Time `json:"restoreTime,omitempty"` }
type GVK ¶
type GVK struct { Group string `json:"group,omitempty"` Version string `json:"version,omitempty"` Kind string `json:"kind,omitempty"` }
GVK group version kind of a resource
type GatekeeperConfig ¶
type GatekeeperConfig struct {
Spec GatekeeperConfigSpec `json:"spec"`
}
GatekeeperConfig represents a gatekeeper config swagger:model GatekeeperConfig
type GatekeeperConfigSpec ¶
type GatekeeperConfigSpec struct { // Configuration for syncing k8s objects Sync Sync `json:"sync,omitempty"` // Configuration for validation Validation Validation `json:"validation,omitempty"` // Configuration for namespace exclusion Match []MatchEntry `json:"match,omitempty"` // Configuration for readiness tracker Readiness ReadinessSpec `json:"readiness,omitempty"` }
type MLA ¶ added in v2.18.0
type MLA struct { // whether the user cluster MLA (Monitoring, Logging & Alerting) stack is enabled in the seed UserClusterMLAEnabled bool `json:"user_cluster_mla_enabled"` }
type MLAAdminSetting ¶ added in v2.18.0
type MLAAdminSetting struct { // MonitoringRateLimits contains rate-limiting configuration for monitoring in the user cluster. MonitoringRateLimits *crdapiv1.MonitoringRateLimitSettings `json:"monitoringRateLimits,omitempty"` // LoggingRateLimits contains rate-limiting configuration logging in the user cluster. LoggingRateLimits *crdapiv1.LoggingRateLimitSettings `json:"loggingRateLimits,omitempty"` }
MLAAdminSetting represents an object holding admin setting options for user cluster MLA (Monitoring, Logging and Alerting). swagger:model MLAAdminSetting
type MatchEntry ¶
type OIDCSpec ¶ added in v2.18.0
type OIDCSpec struct { IssuerURL string `json:"issuerUrl,omitempty"` ClientID string `json:"clientId,omitempty"` ClientSecret string `json:"clientSecret,omitempty"` }
OIDCSpec contains OIDC params that can be used to access user cluster. swagger:model OIDCSpec
type Preset ¶
type Preset struct { Name string `json:"name"` Enabled bool `json:"enabled"` Providers []PresetProvider `json:"providers"` }
Preset represents a preset swagger:model Preset
type PresetList ¶
type PresetList struct {
Items []Preset `json:"items"`
}
PresetList represents a list of presets swagger:model PresetList
type PresetProvider ¶
type PresetProvider struct { Name crdapiv1.ProviderType `json:"name"` Enabled bool `json:"enabled"` }
PresetProvider represents a preset provider swagger:model PresetProvider
type ReadinessSpec ¶
type ReadinessSpec struct { // enables stats for gatekeeper audit StatsEnabled bool `json:"statsEnabled,omitempty"` }
type RuleGroup ¶ added in v2.18.0
type RuleGroup struct { // contains the RuleGroup data. Ref: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group Data []byte `json:"data"` // the type of this ruleGroup applies to. It can be `Metrics`. Type crdapiv1.RuleGroupType `json:"type"` }
RuleGroup represents a rule group of recording and alerting rules. swagger:model RuleGroup
type S3BackupCredentials ¶ added in v2.18.0
type S3BackupCredentials struct { AccessKeyID string `json:"accessKeyId,omitempty"` SecretAccessKey string `json:"secretAccessKey,omitempty"` }
S3BackupCredentials contains credentials for S3 etcd backups swagger:model S3BackupCredentials
type SeedSettings ¶ added in v2.18.0
type SeedSettings struct { // the Seed level MLA (Monitoring, Logging, and Alerting) stack settings MLA MLA `json:"mla"` // the Seed level metering settings Metering crdapiv1.MeteringConfigurations `json:"metering"` // the Seed level seed dns overwrite SeedDNSOverwrite string `json:"seedDNSOverwrite,omitempty"` }
SeedSettings represents settings for a Seed cluster swagger:model SeedSettings
type Sync ¶
type Sync struct { // If non-empty, entries on this list will be replicated into OPA SyncOnly []GVK `json:"syncOnly,omitempty"` }
type Trace ¶
type Trace struct { // Only trace requests from the specified user User string `json:"user,omitempty"` // Only trace requests of the following GroupVersionKind Kind GVK `json:"kind,omitempty"` // Also dump the state of OPA with the trace. Set to `All` to dump everything. Dump string `json:"dump,omitempty"` }
type Validation ¶
type Validation struct { // List of requests to trace. Both "user" and "kinds" must be specified Traces []Trace `json:"traces,omitempty"` }
type Violation ¶
type Violation struct { EnforcementAction string `json:"enforcementAction,omitempty"` Kind string `json:"kind,omitempty"` Message string `json:"message,omitempty"` Name string `json:"name,omitempty"` Namespace string `json:"namespace,omitempty"` }
Violation represents a gatekeeper constraint violation