Documentation
¶
Overview ¶
Package kubectl provides the functions used by the kubectl command line tool under k8s.io/kubernetes/cmd. The functions are kept in this package to better support unit testing. The main() method for kubectl is only an entry point and should contain no functionality.
A set of common functions needed by cmd/kubectl and pkg/kubectl packages.
Index ¶
- Constants
- Variables
- func AbortRollingUpdate(c *RollingUpdaterConfig) error
- func AddDeploymentKeyToReplicationController(oldRc *api.ReplicationController, ...) (*api.ReplicationController, error)
- func AddJsonFilenameFlag(cmd *cobra.Command, value *[]string, usage string)
- func AnnotateFlags(cmd *cobra.Command, generators map[string]Generator)
- func CreateApplyAnnotation(info *resource.Info, codec runtime.Encoder) error
- func CreateNewControllerFromCurrentController(rcClient coreclient.ReplicationControllersGetter, codec runtime.Codec, ...) (*api.ReplicationController, error)
- func CreateOrUpdateAnnotation(createAnnotation bool, info *resource.Info, codec runtime.Encoder) error
- func EnsureFlagsValid(cmd *cobra.Command, generators map[string]Generator, generatorInUse string) error
- func FindSourceController(r coreclient.ReplicationControllersGetter, namespace, name string) (*api.ReplicationController, error)
- func GetBool(params map[string]string, key string, defValue bool) (bool, error)
- func GetModifiedConfiguration(info *resource.Info, annotate bool, codec runtime.Encoder) ([]byte, error)
- func GetNextControllerAnnotation(rc *api.ReplicationController) (string, bool)
- func GetOriginalConfiguration(mapping *meta.RESTMapping, obj runtime.Object) ([]byte, error)
- func HandleResourceRequirementsV1(params map[string]string) (v1.ResourceRequirements, error)
- func IsNoSuchReaperError(err error) bool
- func IsZero(i interface{}) bool
- func LoadExistingNextReplicationController(c coreclient.ReplicationControllersGetter, namespace, newName string) (*api.ReplicationController, error)
- func MakeLabels(labels map[string]string) string
- func MakeParams(cmd *cobra.Command, params []GeneratorParam) map[string]interface{}
- func MakeProtocols(protocols map[string]string) string
- func ParseLabels(labelSpec interface{}) (map[string]string, error)
- func ParseProtocols(protocols interface{}) (map[string]string, error)
- func Rename(c coreclient.ReplicationControllersGetter, rc *api.ReplicationController, ...) error
- func ResourceAliases(rs []string) []string
- func ResourceShortFormFor(resource string) (string, bool)
- func ScaleCondition(r Scaler, precondition *ScalePrecondition, namespace, name string, count uint, ...) wait.ConditionFunc
- func SetNextControllerAnnotation(rc *api.ReplicationController, name string)
- func SetOriginalConfiguration(info *resource.Info, original []byte) error
- func UpdateApplyAnnotation(info *resource.Info, codec runtime.Encoder) error
- func UpdateExistingReplicationController(rcClient coreclient.ReplicationControllersGetter, ...) (*api.ReplicationController, error)
- func ValidateParams(paramSpec []GeneratorParam, params map[string]interface{}) error
- type BaseDeploymentGenerator
- type BasicPod
- type BasicReplicationController
- type ClusterRoleBindingGeneratorV1
- type ConfigMapGeneratorV1
- type CronJobV1Beta1
- type CronJobV2Alpha1
- type DaemonSetHistoryViewer
- type DaemonSetReaper
- type DaemonSetRollbacker
- type DaemonSetStatusViewer
- type DeploymentAppsV1Beta1
- type DeploymentBasicAppsGeneratorV1
- type DeploymentBasicGeneratorV1
- type DeploymentHistoryViewer
- type DeploymentReaper
- type DeploymentRollbacker
- type DeploymentScaler
- type DeploymentStatusViewer
- type DeploymentV1Beta1
- type FilterFunc
- type Filters
- type Generator
- type GeneratorParam
- type HistoryViewer
- type HistoryVisitor
- func (v *HistoryVisitor) VisitCronJob(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitDaemonSet(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitDeployment(elem kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitJob(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitPod(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitReplicaSet(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitReplicationController(kind kapps.GroupKindElement)
- func (v *HistoryVisitor) VisitStatefulSet(kind kapps.GroupKindElement)
- type HorizontalPodAutoscalerV1
- type JobReaper
- type JobScaler
- type JobV1
- type NamespaceGeneratorV1
- type NamespaceInfo
- type NewControllerConfig
- type NoSuchReaperError
- type PodDisruptionBudgetV1Generator
- type PodDisruptionBudgetV2Generator
- type PodReaper
- type PreconditionError
- type PriorityClassV1Generator
- type RESTClient
- type Reaper
- type ReplicaSetReaper
- type ReplicaSetScaler
- type ReplicationControllerReaper
- type ReplicationControllerScaler
- type ResourceQuotaGeneratorV1
- type ResourceShortcuts
- type RetryParams
- type RoleBindingGeneratorV1
- type Rollbacker
- type RollingUpdater
- type RollingUpdaterCleanupPolicy
- type RollingUpdaterConfig
- type RuntimeSort
- type ScaleError
- type ScaleErrorType
- type ScalePrecondition
- func (precondition *ScalePrecondition) ValidateDeployment(deployment *extensions.Deployment) error
- func (precondition *ScalePrecondition) ValidateJob(job *batch.Job) error
- func (precondition *ScalePrecondition) ValidateReplicaSet(replicaSet *extensions.ReplicaSet) error
- func (precondition *ScalePrecondition) ValidateReplicationController(controller *api.ReplicationController) error
- func (precondition *ScalePrecondition) ValidateStatefulSet(ps *apps.StatefulSet) error
- type Scaler
- type SecretForDockerRegistryGeneratorV1
- type SecretForTLSGeneratorV1
- type SecretGeneratorV1
- type ServiceAccountGeneratorV1
- type ServiceClusterIPGeneratorV1
- type ServiceCommonGeneratorV1
- type ServiceExternalNameGeneratorV1
- type ServiceGeneratorV1
- type ServiceGeneratorV2
- type ServiceLoadBalancerGeneratorV1
- type ServiceNodePortGeneratorV1
- type SortingPrinter
- type StatefulSetHistoryViewer
- type StatefulSetReaper
- type StatefulSetRollbacker
- type StatefulSetScaler
- type StatefulSetStatusViewer
- type StatusViewer
- type StructuredGenerator
Constants ¶
const ( Interval = time.Second * 1 Timeout = time.Minute * 5 )
const (
ChangeCauseAnnotation = "kubernetes.io/change-cause"
)
Variables ¶
var ResourcesShortcutStatic = []ResourceShortcuts{ { ShortForm: schema.GroupResource{Resource: "cm"}, LongForm: schema.GroupResource{Resource: "configmaps"}, }, { ShortForm: schema.GroupResource{Resource: "cs"}, LongForm: schema.GroupResource{Resource: "componentstatuses"}, }, { ShortForm: schema.GroupResource{Resource: "ep"}, LongForm: schema.GroupResource{Resource: "endpoints"}, }, { ShortForm: schema.GroupResource{Resource: "ev"}, LongForm: schema.GroupResource{Resource: "events"}, }, { ShortForm: schema.GroupResource{Resource: "limits"}, LongForm: schema.GroupResource{Resource: "limitranges"}, }, { ShortForm: schema.GroupResource{Resource: "no"}, LongForm: schema.GroupResource{Resource: "nodes"}, }, { ShortForm: schema.GroupResource{Resource: "ns"}, LongForm: schema.GroupResource{Resource: "namespaces"}, }, { ShortForm: schema.GroupResource{Resource: "po"}, LongForm: schema.GroupResource{Resource: "pods"}, }, { ShortForm: schema.GroupResource{Resource: "pvc"}, LongForm: schema.GroupResource{Resource: "persistentvolumeclaims"}, }, { ShortForm: schema.GroupResource{Resource: "pv"}, LongForm: schema.GroupResource{Resource: "persistentvolumes"}, }, { ShortForm: schema.GroupResource{Resource: "quota"}, LongForm: schema.GroupResource{Resource: "resourcequotas"}, }, { ShortForm: schema.GroupResource{Resource: "rc"}, LongForm: schema.GroupResource{Resource: "replicationcontrollers"}, }, { ShortForm: schema.GroupResource{Resource: "rs"}, LongForm: schema.GroupResource{Resource: "replicasets"}, }, { ShortForm: schema.GroupResource{Resource: "sa"}, LongForm: schema.GroupResource{Resource: "serviceaccounts"}, }, { ShortForm: schema.GroupResource{Resource: "svc"}, LongForm: schema.GroupResource{Resource: "services"}, }, { ShortForm: schema.GroupResource{Group: "autoscaling", Resource: "hpa"}, LongForm: schema.GroupResource{Group: "autoscaling", Resource: "horizontalpodautoscalers"}, }, { ShortForm: schema.GroupResource{Group: "certificates.k8s.io", Resource: "csr"}, LongForm: schema.GroupResource{Group: "certificates.k8s.io", Resource: "certificatesigningrequests"}, }, { ShortForm: schema.GroupResource{Group: "policy", Resource: "pdb"}, LongForm: schema.GroupResource{Group: "policy", Resource: "poddisruptionbudgets"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "deploy"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "deployments"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "ds"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "daemonsets"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "hpa"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "horizontalpodautoscalers"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "ing"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "ingresses"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "netpol"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "networkpolicies"}, }, { ShortForm: schema.GroupResource{Group: "extensions", Resource: "psp"}, LongForm: schema.GroupResource{Group: "extensions", Resource: "podSecurityPolicies"}, }, }
ResourcesShortcutStatic is the list of short names to their expanded names. Note that the list is ordered by group.
Functions ¶
func AbortRollingUpdate ¶ added in v0.18.2
func AbortRollingUpdate(c *RollingUpdaterConfig) error
func AddDeploymentKeyToReplicationController ¶ added in v0.18.2
func AddDeploymentKeyToReplicationController(oldRc *api.ReplicationController, rcClient coreclient.ReplicationControllersGetter, podClient coreclient.PodsGetter, deploymentKey, deploymentValue, namespace string, out io.Writer) (*api.ReplicationController, error)
func AddJsonFilenameFlag ¶ added in v0.18.2
func AnnotateFlags ¶ added in v1.2.3
AnnotateFlags annotates all flags that are used by generators.
func CreateApplyAnnotation ¶ added in v1.2.3
CreateApplyAnnotation gets the modified configuration of the object, without embedding it again, and then sets it on the object as the annotation.
func CreateNewControllerFromCurrentController ¶ added in v0.18.2
func CreateNewControllerFromCurrentController(rcClient coreclient.ReplicationControllersGetter, codec runtime.Codec, cfg *NewControllerConfig) (*api.ReplicationController, error)
func CreateOrUpdateAnnotation ¶ added in v1.2.3
func CreateOrUpdateAnnotation(createAnnotation bool, info *resource.Info, codec runtime.Encoder) error
Create the annotation used by kubectl apply only when createAnnotation is true Otherwise, only update the annotation when it already exists
func EnsureFlagsValid ¶ added in v1.2.3
func EnsureFlagsValid(cmd *cobra.Command, generators map[string]Generator, generatorInUse string) error
EnsureFlagsValid ensures that no invalid flags are being used against a generator.
func FindSourceController ¶ added in v0.18.2
func FindSourceController(r coreclient.ReplicationControllersGetter, namespace, name string) (*api.ReplicationController, error)
func GetModifiedConfiguration ¶ added in v1.2.3
func GetModifiedConfiguration(info *resource.Info, annotate bool, codec runtime.Encoder) ([]byte, error)
GetModifiedConfiguration retrieves the modified configuration of the object. If annotate is true, it embeds the result as an annotation in the modified configuration. If an object was read from the command input, it will use that version of the object. Otherwise, it will use the version from the server.
func GetNextControllerAnnotation ¶ added in v0.18.2
func GetNextControllerAnnotation(rc *api.ReplicationController) (string, bool)
func GetOriginalConfiguration ¶ added in v1.2.3
GetOriginalConfiguration retrieves the original configuration of the object from the annotation, or nil if no annotation was found.
func HandleResourceRequirementsV1 ¶ added in v1.6.0
func HandleResourceRequirementsV1(params map[string]string) (v1.ResourceRequirements, error)
HandleResourceRequirementsV1 parses the limits and requests parameters if specified and returns ResourceRequirements.
func IsNoSuchReaperError ¶ added in v0.18.2
func LoadExistingNextReplicationController ¶ added in v0.18.2
func LoadExistingNextReplicationController(c coreclient.ReplicationControllersGetter, namespace, newName string) (*api.ReplicationController, error)
func MakeLabels ¶ added in v0.13.1
func MakeParams ¶ added in v0.9.2
func MakeParams(cmd *cobra.Command, params []GeneratorParam) map[string]interface{}
MakeParams is a utility that creates generator parameters from a command line
func MakeProtocols ¶ added in v1.3.0
func ParseLabels ¶ added in v0.9.2
ParseLabels turns a string representation of a label set into a map[string]string
func ParseProtocols ¶ added in v1.3.0
func Rename ¶ added in v0.18.2
func Rename(c coreclient.ReplicationControllersGetter, rc *api.ReplicationController, newName string) error
func ResourceAliases ¶ added in v1.3.0
ResourceAliases returns the resource shortcuts and plural forms for the given resources.
func ResourceShortFormFor ¶ added in v1.4.2
ResourceShortFormFor looks up for a short form of resource names. TODO: Change the signature of this function so that it can make use of ResourceShortcuts.
func ScaleCondition ¶ added in v0.18.2
func ScaleCondition(r Scaler, precondition *ScalePrecondition, namespace, name string, count uint, updatedResourceVersion *string) wait.ConditionFunc
ScaleCondition is a closure around Scale that facilitates retries via util.wait
func SetNextControllerAnnotation ¶ added in v0.18.2
func SetNextControllerAnnotation(rc *api.ReplicationController, name string)
func SetOriginalConfiguration ¶ added in v1.2.3
SetOriginalConfiguration sets the original configuration of the object as the annotation on the object for later use in computing a three way patch.
func UpdateApplyAnnotation ¶ added in v1.2.3
UpdateApplyAnnotation calls CreateApplyAnnotation if the last applied configuration annotation is already present. Otherwise, it does nothing.
func UpdateExistingReplicationController ¶ added in v0.18.2
func UpdateExistingReplicationController(rcClient coreclient.ReplicationControllersGetter, podClient coreclient.PodsGetter, oldRc *api.ReplicationController, namespace, newName, deploymentKey, deploymentValue string, out io.Writer) (*api.ReplicationController, error)
func ValidateParams ¶ added in v0.9.2
func ValidateParams(paramSpec []GeneratorParam, params map[string]interface{}) error
ValidateParams ensures that all required params are present in the params map
Types ¶
type BaseDeploymentGenerator ¶ added in v1.8.0
BaseDeploymentGenerator: implement the common functionality of DeploymentBasicGeneratorV1 and DeploymentBasicAppsGeneratorV1. To reduce confusion, it's best to keep this struct in the same file as those generators.
type BasicPod ¶ added in v1.2.3
type BasicPod struct{}
func (BasicPod) ParamNames ¶ added in v1.2.3
func (BasicPod) ParamNames() []GeneratorParam
type BasicReplicationController ¶ added in v0.9.2
type BasicReplicationController struct{}
func (BasicReplicationController) Generate ¶ added in v0.9.2
func (BasicReplicationController) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (BasicReplicationController) ParamNames ¶ added in v0.9.2
func (BasicReplicationController) ParamNames() []GeneratorParam
type ClusterRoleBindingGeneratorV1 ¶ added in v1.6.0
type ClusterRoleBindingGeneratorV1 struct { // Name of clusterRoleBinding (required) Name string // ClusterRole for the clusterRoleBinding (required) ClusterRole string // Users to derive the clusterRoleBinding from (optional) Users []string // Groups to derive the clusterRoleBinding from (optional) Groups []string // ServiceAccounts to derive the clusterRoleBinding from in namespace:name format(optional) ServiceAccounts []string }
ClusterRoleBindingGeneratorV1 supports stable generation of a clusterRoleBinding.
func (ClusterRoleBindingGeneratorV1) Generate ¶ added in v1.6.0
func (s ClusterRoleBindingGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a clusterRoleBinding using the specified parameters.
func (ClusterRoleBindingGeneratorV1) ParamNames ¶ added in v1.6.0
func (s ClusterRoleBindingGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern.
func (ClusterRoleBindingGeneratorV1) StructuredGenerate ¶ added in v1.6.0
func (s ClusterRoleBindingGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a clusterRoleBinding object using the configured fields.
type ConfigMapGeneratorV1 ¶ added in v1.2.3
type ConfigMapGeneratorV1 struct { // Name of configMap (required) Name string // Type of configMap (optional) Type string // FileSources to derive the configMap from (optional) FileSources []string // LiteralSources to derive the configMap from (optional) LiteralSources []string // EnvFileSource to derive the configMap from (optional) EnvFileSource string // AppendHash; if true, derive a hash from the ConfigMap and append it to the name AppendHash bool }
ConfigMapGeneratorV1 supports stable generation of a configMap.
func (ConfigMapGeneratorV1) Generate ¶ added in v1.2.3
func (s ConfigMapGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a configMap using the specified parameters.
func (ConfigMapGeneratorV1) ParamNames ¶ added in v1.2.3
func (s ConfigMapGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern.
func (ConfigMapGeneratorV1) StructuredGenerate ¶ added in v1.2.3
func (s ConfigMapGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a configMap object using the configured fields.
type CronJobV1Beta1 ¶ added in v1.8.0
type CronJobV1Beta1 struct{}
func (CronJobV1Beta1) Generate ¶ added in v1.8.0
func (CronJobV1Beta1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (CronJobV1Beta1) ParamNames ¶ added in v1.8.0
func (CronJobV1Beta1) ParamNames() []GeneratorParam
type CronJobV2Alpha1 ¶ added in v1.5.1
type CronJobV2Alpha1 struct{}
func (CronJobV2Alpha1) Generate ¶ added in v1.5.1
func (CronJobV2Alpha1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (CronJobV2Alpha1) ParamNames ¶ added in v1.5.1
func (CronJobV2Alpha1) ParamNames() []GeneratorParam
type DaemonSetHistoryViewer ¶ added in v1.7.0
type DaemonSetHistoryViewer struct {
// contains filtered or unexported fields
}
func (*DaemonSetHistoryViewer) ViewHistory ¶ added in v1.7.0
func (h *DaemonSetHistoryViewer) ViewHistory(namespace, name string, revision int64) (string, error)
ViewHistory returns a revision-to-history map as the revision history of a deployment TODO: this should be a describer
type DaemonSetReaper ¶ added in v1.2.3
type DaemonSetReaper struct {
// contains filtered or unexported fields
}
func (*DaemonSetReaper) Stop ¶ added in v1.2.3
func (reaper *DaemonSetReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
type DaemonSetRollbacker ¶ added in v1.7.0
type DaemonSetRollbacker struct {
// contains filtered or unexported fields
}
type DaemonSetStatusViewer ¶ added in v1.6.0
type DaemonSetStatusViewer struct {
// contains filtered or unexported fields
}
DaemonSetStatusViewer implements the StatusViewer interface.
type DeploymentAppsV1Beta1 ¶ added in v1.6.0
type DeploymentAppsV1Beta1 struct{}
func (DeploymentAppsV1Beta1) Generate ¶ added in v1.6.0
func (DeploymentAppsV1Beta1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (DeploymentAppsV1Beta1) ParamNames ¶ added in v1.6.0
func (DeploymentAppsV1Beta1) ParamNames() []GeneratorParam
type DeploymentBasicAppsGeneratorV1 ¶ added in v1.6.0
type DeploymentBasicAppsGeneratorV1 struct {
BaseDeploymentGenerator
}
DeploymentBasicAppsGeneratorV1 supports stable generation of a deployment under apps/v1beta1 endpoint
func (*DeploymentBasicAppsGeneratorV1) StructuredGenerate ¶ added in v1.6.0
func (s *DeploymentBasicAppsGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a deployment object using the configured fields
type DeploymentBasicGeneratorV1 ¶ added in v1.4.2
type DeploymentBasicGeneratorV1 struct {
BaseDeploymentGenerator
}
DeploymentBasicGeneratorV1 supports stable generation of a deployment
func (*DeploymentBasicGeneratorV1) StructuredGenerate ¶ added in v1.4.2
func (s *DeploymentBasicGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a deployment object using the configured fields
type DeploymentHistoryViewer ¶ added in v1.2.3
type DeploymentHistoryViewer struct {
// contains filtered or unexported fields
}
func (*DeploymentHistoryViewer) ViewHistory ¶ added in v1.4.2
func (h *DeploymentHistoryViewer) ViewHistory(namespace, name string, revision int64) (string, error)
ViewHistory returns a revision-to-replicaset map as the revision history of a deployment TODO: this should be a describer
type DeploymentReaper ¶ added in v1.2.3
type DeploymentReaper struct {
// contains filtered or unexported fields
}
func (*DeploymentReaper) Stop ¶ added in v1.2.3
func (reaper *DeploymentReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
type DeploymentRollbacker ¶ added in v1.2.3
type DeploymentRollbacker struct {
// contains filtered or unexported fields
}
type DeploymentScaler ¶ added in v1.2.3
type DeploymentScaler struct {
// contains filtered or unexported fields
}
func (*DeploymentScaler) Scale ¶ added in v1.2.3
func (scaler *DeploymentScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error
Scale updates a deployment to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for the status to reach desired count.
func (*DeploymentScaler) ScaleSimple ¶ added in v1.2.3
func (scaler *DeploymentScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
ScaleSimple is responsible for updating a deployment's desired replicas count. It returns the resourceVersion of the deployment if the update is successful.
type DeploymentStatusViewer ¶ added in v1.3.0
type DeploymentStatusViewer struct {
// contains filtered or unexported fields
}
DeploymentStatusViewer implements the StatusViewer interface.
type DeploymentV1Beta1 ¶ added in v1.2.3
type DeploymentV1Beta1 struct{}
func (DeploymentV1Beta1) Generate ¶ added in v1.2.3
func (DeploymentV1Beta1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (DeploymentV1Beta1) ParamNames ¶ added in v1.2.3
func (DeploymentV1Beta1) ParamNames() []GeneratorParam
type FilterFunc ¶ added in v1.5.1
type FilterFunc func(runtime.Object, printers.PrintOptions) bool
FilterFunc is a function that knows how to filter a specific resource kind. It receives a generic runtime.Object which must be type-checked by the function. Returns a boolean value true if a resource is filtered, or false otherwise.
type Filters ¶ added in v1.5.1
type Filters []FilterFunc
Filters is a collection of filter funcs
func NewResourceFilter ¶ added in v1.5.1
func NewResourceFilter() Filters
type Generator ¶ added in v0.9.2
type Generator interface { // Generate creates an API object given a set of parameters Generate(params map[string]interface{}) (runtime.Object, error) // ParamNames returns the list of parameters that this generator uses ParamNames() []GeneratorParam }
Generator is an interface for things that can generate API objects from input parameters. One example is the "expose" generator that is capable of exposing new replication controllers and services, among other things.
type GeneratorParam ¶ added in v0.9.2
GeneratorParam is a parameter for a generator TODO: facilitate structured json generator input schemes
type HistoryViewer ¶ added in v1.2.3
type HistoryViewer interface {
ViewHistory(namespace, name string, revision int64) (string, error)
}
HistoryViewer provides an interface for resources have historical information.
func HistoryViewerFor ¶ added in v1.2.3
func HistoryViewerFor(kind schema.GroupKind, c kubernetes.Interface) (HistoryViewer, error)
HistoryViewerFor returns an implementation of HistoryViewer interface for the given schema kind
type HistoryVisitor ¶ added in v1.9.0
type HistoryVisitor struct {
// contains filtered or unexported fields
}
func (*HistoryVisitor) VisitCronJob ¶ added in v1.9.0
func (v *HistoryVisitor) VisitCronJob(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitDaemonSet ¶ added in v1.9.0
func (v *HistoryVisitor) VisitDaemonSet(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitDeployment ¶ added in v1.9.0
func (v *HistoryVisitor) VisitDeployment(elem kapps.GroupKindElement)
func (*HistoryVisitor) VisitJob ¶ added in v1.9.0
func (v *HistoryVisitor) VisitJob(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitPod ¶ added in v1.9.0
func (v *HistoryVisitor) VisitPod(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitReplicaSet ¶ added in v1.9.0
func (v *HistoryVisitor) VisitReplicaSet(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitReplicationController ¶ added in v1.9.0
func (v *HistoryVisitor) VisitReplicationController(kind kapps.GroupKindElement)
func (*HistoryVisitor) VisitStatefulSet ¶ added in v1.9.0
func (v *HistoryVisitor) VisitStatefulSet(kind kapps.GroupKindElement)
type HorizontalPodAutoscalerV1 ¶ added in v1.3.0
type HorizontalPodAutoscalerV1 struct{}
func (HorizontalPodAutoscalerV1) Generate ¶ added in v1.3.0
func (HorizontalPodAutoscalerV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (HorizontalPodAutoscalerV1) ParamNames ¶ added in v1.3.0
func (HorizontalPodAutoscalerV1) ParamNames() []GeneratorParam
type JobReaper ¶ added in v1.2.3
type JobReaper struct {
// contains filtered or unexported fields
}
type JobScaler ¶ added in v1.2.3
type JobScaler struct {
// contains filtered or unexported fields
}
func (*JobScaler) Scale ¶ added in v1.2.3
func (scaler *JobScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error
Scale updates a Job to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for parallelism to reach desired number, which can be less than requested based on job's current progress.
func (*JobScaler) ScaleSimple ¶ added in v1.2.3
func (scaler *JobScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
ScaleSimple is responsible for updating job's parallelism. It returns the resourceVersion of the job if the update is successful.
type JobV1 ¶ added in v1.2.3
type JobV1 struct{}
func (JobV1) ParamNames ¶ added in v1.2.3
func (JobV1) ParamNames() []GeneratorParam
type NamespaceGeneratorV1 ¶ added in v1.2.3
type NamespaceGeneratorV1 struct { // Name of namespace Name string }
NamespaceGeneratorV1 supports stable generation of a namespace
func (NamespaceGeneratorV1) Generate ¶ added in v1.2.3
func (g NamespaceGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a namespace using the specified parameters
func (NamespaceGeneratorV1) ParamNames ¶ added in v1.2.3
func (g NamespaceGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
func (*NamespaceGeneratorV1) StructuredGenerate ¶ added in v1.2.3
func (g *NamespaceGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a namespace object using the configured fields
type NamespaceInfo ¶
type NamespaceInfo struct {
Namespace string
}
type NewControllerConfig ¶ added in v1.2.6
type NoSuchReaperError ¶ added in v0.18.2
type NoSuchReaperError struct {
// contains filtered or unexported fields
}
func (*NoSuchReaperError) Error ¶ added in v0.18.2
func (n *NoSuchReaperError) Error() string
type PodDisruptionBudgetV1Generator ¶ added in v1.6.0
PodDisruptionBudgetV1Generator supports stable generation of a pod disruption budget.
func (PodDisruptionBudgetV1Generator) Generate ¶ added in v1.6.0
func (s PodDisruptionBudgetV1Generator) Generate(params map[string]interface{}) (runtime.Object, error)
func (PodDisruptionBudgetV1Generator) ParamNames ¶ added in v1.6.0
func (PodDisruptionBudgetV1Generator) ParamNames() []GeneratorParam
func (*PodDisruptionBudgetV1Generator) StructuredGenerate ¶ added in v1.6.0
func (s *PodDisruptionBudgetV1Generator) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a pod disruption budget object using the configured fields.
type PodDisruptionBudgetV2Generator ¶ added in v1.7.0
PodDisruptionBudgetV2Generator supports stable generation of a pod disruption budget.
func (PodDisruptionBudgetV2Generator) Generate ¶ added in v1.7.0
func (s PodDisruptionBudgetV2Generator) Generate(params map[string]interface{}) (runtime.Object, error)
func (PodDisruptionBudgetV2Generator) ParamNames ¶ added in v1.7.0
func (PodDisruptionBudgetV2Generator) ParamNames() []GeneratorParam
func (*PodDisruptionBudgetV2Generator) StructuredGenerate ¶ added in v1.7.0
func (s *PodDisruptionBudgetV2Generator) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a pod disruption budget object using the configured fields.
type PodReaper ¶ added in v0.9.2
type PodReaper struct {
// contains filtered or unexported fields
}
type PreconditionError ¶ added in v0.9.2
A PreconditionError is returned when a resource fails to match the scale preconditions passed to kubectl.
func (PreconditionError) Error ¶ added in v0.9.2
func (pe PreconditionError) Error() string
type PriorityClassV1Generator ¶ added in v1.9.0
type PriorityClassV1Generator struct { Name string Value int32 GlobalDefault bool Description string }
PriorityClassV1Generator supports stable generation of a priorityClass.
func (PriorityClassV1Generator) Generate ¶ added in v1.9.0
func (s PriorityClassV1Generator) Generate(params map[string]interface{}) (runtime.Object, error)
func (PriorityClassV1Generator) ParamNames ¶ added in v1.9.0
func (PriorityClassV1Generator) ParamNames() []GeneratorParam
func (*PriorityClassV1Generator) StructuredGenerate ¶ added in v1.9.0
func (s *PriorityClassV1Generator) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a priorityClass object using the configured fields.
type RESTClient ¶
type RESTClient interface { Get() *client.Request Post() *client.Request Patch(types.PatchType) *client.Request Delete() *client.Request Put() *client.Request }
RESTClient is a client helper for dealing with RESTful resources in a generic way.
type Reaper ¶ added in v0.9.2
type Reaper interface { // Stop a given object within a namespace. timeout is how long we'll // wait for the termination to be successful. gracePeriod is time given // to an API object for it to delete itself cleanly (e.g., pod // shutdown). It may or may not be supported by the API object. Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error }
A Reaper terminates an object as gracefully as possible.
func ReaperForReplicationController ¶ added in v0.18.2
func ReaperForReplicationController(rcClient coreclient.ReplicationControllersGetter, timeout time.Duration) (Reaper, error)
type ReplicaSetReaper ¶ added in v1.2.3
type ReplicaSetReaper struct {
// contains filtered or unexported fields
}
func (*ReplicaSetReaper) Stop ¶ added in v1.2.3
func (reaper *ReplicaSetReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
type ReplicaSetScaler ¶ added in v1.2.3
type ReplicaSetScaler struct {
// contains filtered or unexported fields
}
func (*ReplicaSetScaler) Scale ¶ added in v1.2.3
func (scaler *ReplicaSetScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error
Scale updates a ReplicaSet to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for it's replica count to reach the new value (if wait is not nil).
func (*ReplicaSetScaler) ScaleSimple ¶ added in v1.2.3
func (scaler *ReplicaSetScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
ScaleSimple does a simple one-shot attempt at scaling. It returns the resourceVersion of the replicaset if the update is successful.
type ReplicationControllerReaper ¶ added in v0.9.2
type ReplicationControllerReaper struct {
// contains filtered or unexported fields
}
func (*ReplicationControllerReaper) Stop ¶ added in v0.9.2
func (reaper *ReplicationControllerReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
type ReplicationControllerScaler ¶ added in v0.18.2
type ReplicationControllerScaler struct {
// contains filtered or unexported fields
}
func (*ReplicationControllerScaler) Scale ¶ added in v0.18.2
func (scaler *ReplicationControllerScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error
Scale updates a ReplicationController to a new size, with optional precondition check (if preconditions is not nil), optional retries (if retry is not nil), and then optionally waits for it's replica count to reach the new value (if wait is not nil).
func (*ReplicationControllerScaler) ScaleSimple ¶ added in v0.18.2
func (scaler *ReplicationControllerScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
ScaleSimple does a simple one-shot attempt at scaling. It returns the resourceVersion of the replication controller if the update is successful.
type ResourceQuotaGeneratorV1 ¶ added in v1.4.2
type ResourceQuotaGeneratorV1 struct { // The name of a quota object. Name string // The hard resource limit string before parsing. Hard string // The scopes of a quota object before parsing. Scopes string }
ResourceQuotaGeneratorV1 supports stable generation of a resource quota
func (ResourceQuotaGeneratorV1) Generate ¶ added in v1.4.2
func (g ResourceQuotaGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
func (ResourceQuotaGeneratorV1) ParamNames ¶ added in v1.4.2
func (g ResourceQuotaGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
func (*ResourceQuotaGeneratorV1) StructuredGenerate ¶ added in v1.4.2
func (g *ResourceQuotaGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a ResourceQuota object using the configured fields
type ResourceShortcuts ¶ added in v1.6.0
type ResourceShortcuts struct { ShortForm schema.GroupResource LongForm schema.GroupResource }
ResourceShortcuts represents a structure that holds the information how to transition from resource's shortcut to its full name.
type RetryParams ¶ added in v0.15.0
RetryParams encapsulates the retry parameters used by kubectl's scaler.
func NewRetryParams ¶ added in v0.18.2
func NewRetryParams(interval, timeout time.Duration) *RetryParams
type RoleBindingGeneratorV1 ¶ added in v1.6.0
type RoleBindingGeneratorV1 struct { // Name of roleBinding (required) Name string // ClusterRole for the roleBinding ClusterRole string // Role for the roleBinding Role string // Users to derive the roleBinding from (optional) Users []string // Groups to derive the roleBinding from (optional) Groups []string // ServiceAccounts to derive the roleBinding from in namespace:name format(optional) ServiceAccounts []string }
RoleBindingGeneratorV1 supports stable generation of a roleBinding.
func (RoleBindingGeneratorV1) Generate ¶ added in v1.6.0
func (s RoleBindingGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a roleBinding using the specified parameters.
func (RoleBindingGeneratorV1) ParamNames ¶ added in v1.6.0
func (s RoleBindingGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern.
func (RoleBindingGeneratorV1) StructuredGenerate ¶ added in v1.6.0
func (s RoleBindingGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a roleBinding object using the configured fields.
type Rollbacker ¶ added in v1.2.3
type Rollbacker interface {
Rollback(obj runtime.Object, updatedAnnotations map[string]string, toRevision int64, dryRun bool) (string, error)
}
Rollbacker provides an interface for resources that can be rolled back.
func RollbackerFor ¶ added in v1.2.3
func RollbackerFor(kind schema.GroupKind, c kubernetes.Interface) (Rollbacker, error)
type RollingUpdater ¶ added in v0.9.2
type RollingUpdater struct {
// contains filtered or unexported fields
}
RollingUpdater provides methods for updating replicated pods in a predictable, fault-tolerant way.
func NewRollingUpdater ¶ added in v0.9.2
func NewRollingUpdater(namespace string, rcClient coreclient.ReplicationControllersGetter, podClient coreclient.PodsGetter) *RollingUpdater
NewRollingUpdater creates a RollingUpdater from a client.
func (*RollingUpdater) Update ¶ added in v0.9.2
func (r *RollingUpdater) Update(config *RollingUpdaterConfig) error
Update all pods for a ReplicationController (oldRc) by creating a new controller (newRc) with 0 replicas, and synchronously scaling oldRc and newRc until oldRc has 0 replicas and newRc has the original # of desired replicas. Cleanup occurs based on a RollingUpdaterCleanupPolicy.
Each interval, the updater will attempt to make progress however it can without violating any availability constraints defined by the config. This means the amount scaled up or down each interval will vary based on the timeliness of readiness and the updater will always try to make progress, even slowly.
If an update from newRc to oldRc is already in progress, we attempt to drive it to completion. If an error occurs at any step of the update, the error will be returned.
A scaling event (either up or down) is considered progress; if no progress is made within the config.Timeout, an error is returned.
TODO: make this handle performing a rollback of a partially completed rollout.
type RollingUpdaterCleanupPolicy ¶ added in v0.18.2
type RollingUpdaterCleanupPolicy string
RollingUpdaterCleanupPolicy is a cleanup action to take after the deployment is complete.
const ( // DeleteRollingUpdateCleanupPolicy means delete the old controller. DeleteRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Delete" // PreserveRollingUpdateCleanupPolicy means keep the old controller. PreserveRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Preserve" // RenameRollingUpdateCleanupPolicy means delete the old controller, and rename // the new controller to the name of the old controller. RenameRollingUpdateCleanupPolicy RollingUpdaterCleanupPolicy = "Rename" )
type RollingUpdaterConfig ¶ added in v0.18.2
type RollingUpdaterConfig struct { // Out is a writer for progress output. Out io.Writer // OldRC is an existing controller to be replaced. OldRc *api.ReplicationController // NewRc is a controller that will take ownership of updated pods (will be // created if needed). NewRc *api.ReplicationController // UpdatePeriod is the time to wait between individual pod updates. UpdatePeriod time.Duration // Interval is the time to wait between polling controller status after // update. Interval time.Duration // Timeout is the time to wait for controller updates before giving up. Timeout time.Duration // MinReadySeconds is the number of seconds to wait after the pods are ready MinReadySeconds int32 // CleanupPolicy defines the cleanup action to take after the deployment is // complete. CleanupPolicy RollingUpdaterCleanupPolicy // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). // Absolute number is calculated from percentage by rounding up. // This can not be 0 if MaxSurge is 0. // By default, a fixed value of 1 is used. // Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods // immediately when the rolling update starts. Once new pods are ready, old RC // can be scaled down further, followed by scaling up the new RC, ensuring // that the total number of pods available at all times during the update is at // least 70% of desired pods. MaxUnavailable intstr.IntOrString // MaxSurge is the maximum number of pods that can be scheduled above the desired number of pods. // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). // This can not be 0 if MaxUnavailable is 0. // Absolute number is calculated from percentage by rounding up. // By default, a value of 1 is used. // Example: when this is set to 30%, the new RC can be scaled up immediately // when the rolling update starts, such that the total number of old and new pods do not exceed // 130% of desired pods. Once old pods have been killed, new RC can be scaled up // further, ensuring that total number of pods running at any time during // the update is atmost 130% of desired pods. MaxSurge intstr.IntOrString // OnProgress is invoked if set during each scale cycle, to allow the caller to perform additional logic or // abort the scale. If an error is returned the cleanup method will not be invoked. The percentage value // is a synthetic "progress" calculation that represents the approximate percentage completion. OnProgress func(oldRc, newRc *api.ReplicationController, percentage int) error }
RollingUpdaterConfig is the configuration for a rolling deployment process.
type RuntimeSort ¶ added in v1.2.3
type RuntimeSort struct {
// contains filtered or unexported fields
}
RuntimeSort is an implementation of the golang sort interface that knows how to sort lists of runtime.Object
func NewRuntimeSort ¶ added in v1.2.3
func NewRuntimeSort(field string, objs []runtime.Object) *RuntimeSort
func SortObjects ¶ added in v1.2.3
func (*RuntimeSort) Len ¶ added in v1.2.3
func (r *RuntimeSort) Len() int
func (*RuntimeSort) Less ¶ added in v1.2.3
func (r *RuntimeSort) Less(i, j int) bool
func (*RuntimeSort) OriginalPosition ¶ added in v1.2.3
func (r *RuntimeSort) OriginalPosition(ix int) int
Returns the starting (original) position of a particular index. e.g. If OriginalPosition(0) returns 5 than the the item currently at position 0 was at position 5 in the original unsorted array.
func (*RuntimeSort) Swap ¶ added in v1.2.3
func (r *RuntimeSort) Swap(i, j int)
type ScaleError ¶ added in v1.2.3
type ScaleError struct { FailureType ScaleErrorType ResourceVersion string ActualError error }
A ScaleError is returned when a scale request passes preconditions but fails to actually scale the controller.
func (ScaleError) Error ¶ added in v1.2.3
func (c ScaleError) Error() string
type ScaleErrorType ¶ added in v1.2.3
type ScaleErrorType int
const ( ScaleGetFailure ScaleErrorType = iota ScaleUpdateFailure ScaleUpdateConflictFailure )
type ScalePrecondition ¶ added in v0.18.2
ScalePrecondition describes a condition that must be true for the scale to take place If CurrentSize == -1, it is ignored. If CurrentResourceVersion is the empty string, it is ignored. Otherwise they must equal the values in the resource for it to be valid.
func (*ScalePrecondition) ValidateDeployment ¶ added in v1.2.3
func (precondition *ScalePrecondition) ValidateDeployment(deployment *extensions.Deployment) error
ValidateDeployment ensures that the preconditions match. Returns nil if they are valid, an error otherwise.
func (*ScalePrecondition) ValidateJob ¶ added in v1.2.3
func (precondition *ScalePrecondition) ValidateJob(job *batch.Job) error
ValidateJob ensures that the preconditions match. Returns nil if they are valid, an error otherwise.
func (*ScalePrecondition) ValidateReplicaSet ¶ added in v1.2.3
func (precondition *ScalePrecondition) ValidateReplicaSet(replicaSet *extensions.ReplicaSet) error
ValidateReplicaSet ensures that the preconditions match. Returns nil if they are valid, an error otherwise
func (*ScalePrecondition) ValidateReplicationController ¶ added in v1.2.3
func (precondition *ScalePrecondition) ValidateReplicationController(controller *api.ReplicationController) error
ValidateReplicationController ensures that the preconditions match. Returns nil if they are valid, an error otherwise
func (*ScalePrecondition) ValidateStatefulSet ¶ added in v1.5.1
func (precondition *ScalePrecondition) ValidateStatefulSet(ps *apps.StatefulSet) error
ValidateStatefulSet ensures that the preconditions match. Returns nil if they are valid, an error otherwise.
type Scaler ¶ added in v0.18.2
type Scaler interface { // Scale scales the named resource after checking preconditions. It optionally // retries in the event of resource version mismatch (if retry is not nil), // and optionally waits until the status of the resource matches newSize (if wait is not nil) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, wait *RetryParams) error // ScaleSimple does a simple one-shot attempt at scaling - not useful on its own, but // a necessary building block for Scale ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (updatedResourceVersion string, err error) }
Scaler provides an interface for resources that can be scaled.
type SecretForDockerRegistryGeneratorV1 ¶ added in v1.2.3
type SecretForDockerRegistryGeneratorV1 struct { // Name of secret (required) Name string // Username for registry (required) Username string // Email for registry (optional) Email string // Password for registry (required) Password string // Server for registry (required) Server string // AppendHash; if true, derive a hash from the Secret and append it to the name AppendHash bool }
SecretForDockerRegistryGeneratorV1 supports stable generation of a docker registry secret
func (SecretForDockerRegistryGeneratorV1) Generate ¶ added in v1.2.3
func (s SecretForDockerRegistryGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a secret using the specified parameters
func (SecretForDockerRegistryGeneratorV1) ParamNames ¶ added in v1.2.3
func (s SecretForDockerRegistryGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
func (SecretForDockerRegistryGeneratorV1) StructuredGenerate ¶ added in v1.2.3
func (s SecretForDockerRegistryGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a secret object using the configured fields
type SecretForTLSGeneratorV1 ¶ added in v1.3.0
type SecretForTLSGeneratorV1 struct { // Name is the name of this TLS secret. Name string // Key is the path to the user's private key. Key string // Cert is the path to the user's public key certificate. Cert string // AppendHash; if true, derive a hash from the Secret and append it to the name AppendHash bool }
SecretForTLSGeneratorV1 supports stable generation of a TLS secret.
func (SecretForTLSGeneratorV1) Generate ¶ added in v1.3.0
func (s SecretForTLSGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a secret using the specified parameters
func (SecretForTLSGeneratorV1) ParamNames ¶ added in v1.3.0
func (s SecretForTLSGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
func (SecretForTLSGeneratorV1) StructuredGenerate ¶ added in v1.3.0
func (s SecretForTLSGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a secret object using the configured fields
type SecretGeneratorV1 ¶ added in v1.2.3
type SecretGeneratorV1 struct { // Name of secret (required) Name string // Type of secret (optional) Type string // FileSources to derive the secret from (optional) FileSources []string // LiteralSources to derive the secret from (optional) LiteralSources []string // EnvFileSource to derive the secret from (optional) EnvFileSource string // AppendHash; if true, derive a hash from the Secret data and type and append it to the name AppendHash bool }
SecretGeneratorV1 supports stable generation of an opaque secret
func (SecretGeneratorV1) Generate ¶ added in v1.2.3
func (s SecretGeneratorV1) Generate(genericParams map[string]interface{}) (runtime.Object, error)
Generate returns a secret using the specified parameters
func (SecretGeneratorV1) ParamNames ¶ added in v1.2.3
func (s SecretGeneratorV1) ParamNames() []GeneratorParam
ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
func (SecretGeneratorV1) StructuredGenerate ¶ added in v1.2.3
func (s SecretGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a secret object using the configured fields
type ServiceAccountGeneratorV1 ¶ added in v1.2.3
type ServiceAccountGeneratorV1 struct { // Name of service account Name string }
ServiceAccountGeneratorV1 supports stable generation of a service account
func (*ServiceAccountGeneratorV1) StructuredGenerate ¶ added in v1.2.3
func (g *ServiceAccountGeneratorV1) StructuredGenerate() (runtime.Object, error)
StructuredGenerate outputs a service account object using the configured fields
type ServiceClusterIPGeneratorV1 ¶ added in v1.4.2
type ServiceClusterIPGeneratorV1 struct {
ServiceCommonGeneratorV1
}
func (ServiceClusterIPGeneratorV1) Generate ¶ added in v1.4.2
func (s ServiceClusterIPGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceClusterIPGeneratorV1) ParamNames ¶ added in v1.4.2
func (ServiceClusterIPGeneratorV1) ParamNames() []GeneratorParam
type ServiceCommonGeneratorV1 ¶ added in v1.4.2
type ServiceCommonGeneratorV1 struct { Name string TCP []string Type v1.ServiceType ClusterIP string NodePort int ExternalName string }
func (ServiceCommonGeneratorV1) GenerateCommon ¶ added in v1.4.2
func (s ServiceCommonGeneratorV1) GenerateCommon(params map[string]interface{}) error
func (ServiceCommonGeneratorV1) StructuredGenerate ¶ added in v1.4.2
func (s ServiceCommonGeneratorV1) StructuredGenerate() (runtime.Object, error)
type ServiceExternalNameGeneratorV1 ¶ added in v1.6.0
type ServiceExternalNameGeneratorV1 struct {
ServiceCommonGeneratorV1
}
TODO: is this really necessary?
func (ServiceExternalNameGeneratorV1) Generate ¶ added in v1.6.0
func (s ServiceExternalNameGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceExternalNameGeneratorV1) ParamNames ¶ added in v1.6.0
func (ServiceExternalNameGeneratorV1) ParamNames() []GeneratorParam
type ServiceGeneratorV1 ¶ added in v1.0.2
type ServiceGeneratorV1 struct{}
The only difference between ServiceGeneratorV1 and V2 is that the service port is named "default" in V1, while it is left unnamed in V2.
func (ServiceGeneratorV1) Generate ¶ added in v1.0.2
func (ServiceGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceGeneratorV1) ParamNames ¶ added in v1.0.2
func (ServiceGeneratorV1) ParamNames() []GeneratorParam
type ServiceGeneratorV2 ¶ added in v1.0.2
type ServiceGeneratorV2 struct{}
func (ServiceGeneratorV2) Generate ¶ added in v1.0.2
func (ServiceGeneratorV2) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceGeneratorV2) ParamNames ¶ added in v1.0.2
func (ServiceGeneratorV2) ParamNames() []GeneratorParam
type ServiceLoadBalancerGeneratorV1 ¶ added in v1.4.2
type ServiceLoadBalancerGeneratorV1 struct {
ServiceCommonGeneratorV1
}
func (ServiceLoadBalancerGeneratorV1) Generate ¶ added in v1.4.2
func (s ServiceLoadBalancerGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceLoadBalancerGeneratorV1) ParamNames ¶ added in v1.4.2
func (ServiceLoadBalancerGeneratorV1) ParamNames() []GeneratorParam
type ServiceNodePortGeneratorV1 ¶ added in v1.4.2
type ServiceNodePortGeneratorV1 struct {
ServiceCommonGeneratorV1
}
func (ServiceNodePortGeneratorV1) Generate ¶ added in v1.4.2
func (s ServiceNodePortGeneratorV1) Generate(params map[string]interface{}) (runtime.Object, error)
func (ServiceNodePortGeneratorV1) ParamNames ¶ added in v1.4.2
func (ServiceNodePortGeneratorV1) ParamNames() []GeneratorParam
type SortingPrinter ¶ added in v1.2.3
type SortingPrinter struct { SortField string Delegate printers.ResourcePrinter Decoder runtime.Decoder }
Sorting printer sorts list types before delegating to another printer. Non-list types are simply passed through
func (*SortingPrinter) AfterPrint ¶ added in v1.5.1
func (s *SortingPrinter) AfterPrint(w io.Writer, res string) error
func (*SortingPrinter) HandledResources ¶ added in v1.2.3
func (s *SortingPrinter) HandledResources() []string
TODO: implement HandledResources()
func (*SortingPrinter) IsGeneric ¶ added in v1.7.0
func (s *SortingPrinter) IsGeneric() bool
type StatefulSetHistoryViewer ¶ added in v1.7.0
type StatefulSetHistoryViewer struct {
// contains filtered or unexported fields
}
func (*StatefulSetHistoryViewer) ViewHistory ¶ added in v1.7.0
func (h *StatefulSetHistoryViewer) ViewHistory(namespace, name string, revision int64) (string, error)
ViewHistory returns a list of the revision history of a statefulset TODO: this should be a describer TODO: needs to implement detailed revision view
type StatefulSetReaper ¶ added in v1.5.1
type StatefulSetReaper struct {
// contains filtered or unexported fields
}
func (*StatefulSetReaper) Stop ¶ added in v1.5.1
func (reaper *StatefulSetReaper) Stop(namespace, name string, timeout time.Duration, gracePeriod *metav1.DeleteOptions) error
type StatefulSetRollbacker ¶ added in v1.8.0
type StatefulSetRollbacker struct {
// contains filtered or unexported fields
}
func (*StatefulSetRollbacker) Rollback ¶ added in v1.8.0
func (r *StatefulSetRollbacker) Rollback(obj runtime.Object, updatedAnnotations map[string]string, toRevision int64, dryRun bool) (string, error)
toRevision is a non-negative integer, with 0 being reserved to indicate rolling back to previous configuration
type StatefulSetScaler ¶ added in v1.5.1
type StatefulSetScaler struct {
// contains filtered or unexported fields
}
func (*StatefulSetScaler) Scale ¶ added in v1.5.1
func (scaler *StatefulSetScaler) Scale(namespace, name string, newSize uint, preconditions *ScalePrecondition, retry, waitForReplicas *RetryParams) error
func (*StatefulSetScaler) ScaleSimple ¶ added in v1.5.1
func (scaler *StatefulSetScaler) ScaleSimple(namespace, name string, preconditions *ScalePrecondition, newSize uint) (string, error)
ScaleSimple does a simple one-shot attempt at scaling. It returns the resourceVersion of the statefulset if the update is successful.
type StatefulSetStatusViewer ¶ added in v1.7.0
type StatefulSetStatusViewer struct {
// contains filtered or unexported fields
}
StatefulSetStatusViewer implements the StatusViewer interface.
type StatusViewer ¶ added in v1.3.0
type StatusViewer interface {
Status(namespace, name string, revision int64) (string, bool, error)
}
StatusViewer provides an interface for resources that have rollout status.
func StatusViewerFor ¶ added in v1.3.0
func StatusViewerFor(kind schema.GroupKind, c kubernetes.Interface) (StatusViewer, error)
StatusViewerFor returns a StatusViewer for the resource specified by kind.
type StructuredGenerator ¶ added in v1.2.3
type StructuredGenerator interface { // StructuredGenerator creates an API object using pre-configured parameters StructuredGenerate() (runtime.Object, error) }
StructuredGenerator is an interface for things that can generate API objects not using parameter injection
Source Files
¶
- apply.go
- autoscale.go
- bash_comp_utils.go
- clusterrolebinding.go
- configmap.go
- delete.go
- deployment.go
- doc.go
- env_file.go
- generate.go
- history.go
- interfaces.go
- kubectl.go
- namespace.go
- pdb.go
- priorityclass.go
- quota.go
- resource_filter.go
- rolebinding.go
- rollback.go
- rolling_updater.go
- rollout_status.go
- run.go
- scale.go
- secret.go
- secret_for_docker_registry.go
- secret_for_tls.go
- service.go
- service_basic.go
- serviceaccount.go
- sorting_printer.go
- versioned_client.go
Directories
¶
Path | Synopsis |
---|---|
util/env
Package env provides functions to incorporate environment variables into kubectl commands.
|
Package env provides functions to incorporate environment variables into kubectl commands. |
util/openapi
Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions.
|
Package openapi is a collection of libraries for fetching the openapi spec from a Kubernetes server and then indexing the type definitions. |
Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions.
|
Package resource assists clients in dealing with RESTful objects that match the Kubernetes API conventions. |