Documentation ¶
Index ¶
- Constants
- func ActiveDeployment(input []api.ReplicationController) *api.ReplicationController
- func AnyDeployerPodSelector() labels.Selector
- func CanTransitionPhase(current, next deployapi.DeploymentStatus) bool
- func ConfigSelector(name string) labels.Selector
- func DecodeDeploymentConfig(controller *api.ReplicationController, decoder runtime.Decoder) (*deployapi.DeploymentConfig, error)
- func DeployerPodNameFor(obj runtime.Object) string
- func DeployerPodNameForDeployment(deployment string) string
- func DeployerPodSelector(name string) labels.Selector
- func DeploymentConfigDeepCopy(dc *deployapi.DeploymentConfig) (*deployapi.DeploymentConfig, error)
- func DeploymentConfigNameFor(obj runtime.Object) string
- func DeploymentDeepCopy(rc *api.ReplicationController) (*api.ReplicationController, error)
- func DeploymentDesiredReplicas(obj runtime.Object) (int32, bool)
- func DeploymentNameFor(obj runtime.Object) string
- func DeploymentNameForConfigVersion(name string, version int64) string
- func DeploymentReplicas(obj runtime.Object) (int32, bool)
- func DeploymentStatusFor(obj runtime.Object) deployapi.DeploymentStatus
- func DeploymentStatusReasonFor(obj runtime.Object) string
- func DeploymentVersionFor(obj runtime.Object) int64
- func DeploymentsForCleanup(configuration *deployapi.DeploymentConfig, ...) []api.ReplicationController
- func EncodeDeploymentConfig(config *deployapi.DeploymentConfig, codec runtime.Codec) (string, error)
- func EncodedDeploymentConfigFor(obj runtime.Object) string
- func GetAvailablePods(pods []*api.Pod, minReadySeconds int32) int32
- func GetDeploymentCondition(status deployapi.DeploymentConfigStatus, ...) *deployapi.DeploymentCondition
- func GetReplicaCountForDeployments(deployments []api.ReplicationController) int32
- func GetStatusReplicaCountForDeployments(deployments []api.ReplicationController) int32
- func HasChangeTrigger(config *deployapi.DeploymentConfig) bool
- func HasImageChangeTrigger(config *deployapi.DeploymentConfig) bool
- func HasSynced(dc *deployapi.DeploymentConfig, generation int64) bool
- func IsCompleteDeployment(deployment *api.ReplicationController) bool
- func IsDeploymentCancelled(deployment *api.ReplicationController) bool
- func IsFailedDeployment(deployment *api.ReplicationController) bool
- func IsOwnedByConfig(deployment *api.ReplicationController) bool
- func IsProgressing(config deployapi.DeploymentConfig, newStatus deployapi.DeploymentConfigStatus) bool
- func IsRollingConfig(config *deployapi.DeploymentConfig) bool
- func IsTerminatedDeployment(deployment *api.ReplicationController) bool
- func LabelForDeployment(deployment *api.ReplicationController) string
- func LabelForDeploymentConfig(config *deployapi.DeploymentConfig) string
- func LatestDeploymentInfo(config *deployapi.DeploymentConfig, deployments []api.ReplicationController) (bool, *api.ReplicationController)
- func LatestDeploymentNameForConfig(config *deployapi.DeploymentConfig) string
- func MakeDeployment(config *deployapi.DeploymentConfig, codec runtime.Codec) (*api.ReplicationController, error)
- func MaxSurge(config deployapi.DeploymentConfig) int32
- func MaxUnavailable(config deployapi.DeploymentConfig) int32
- func NewDeploymentCondition(condType deployapi.DeploymentConditionType, status api.ConditionStatus, ...) *deployapi.DeploymentCondition
- func RemoveDeploymentCondition(status *deployapi.DeploymentConfigStatus, ...)
- func SetDeploymentCondition(status *deployapi.DeploymentConfigStatus, ...)
- func WaitForRunningDeployerPod(podClient kcoreclient.PodsGetter, rc *api.ReplicationController, ...) error
- type ByLatestVersionAsc
- type ByLatestVersionDesc
- type ByMostRecent
Constants ¶
const ( // Reasons for deployment config conditions: // // ReplicationControllerUpdatedReason is added in a deployment config when one of its replication // controllers is updated as part of the rollout process. ReplicationControllerUpdatedReason = "ReplicationControllerUpdated" // FailedRcCreateReason is added in a deployment config when it cannot create a new replication // controller. FailedRcCreateReason = "ReplicationControllerCreateError" // NewReplicationControllerReason is added in a deployment config when it creates a new replication // controller. NewReplicationControllerReason = "NewReplicationControllerCreated" // NewRcAvailableReason is added in a deployment config when its newest replication controller is made // available ie. the number of new pods that have passed readiness checks and run for at least // minReadySeconds is at least the minimum available pods that need to run for the deployment config. NewRcAvailableReason = "NewReplicationControllerAvailable" // TimedOutReason is added in a deployment config when its newest replication controller fails to show // any progress within the given deadline (progressDeadlineSeconds). TimedOutReason = "ProgressDeadlineExceeded" // PausedDeployReason is added in a deployment config when it is paused. Lack of progress shouldn't be // estimated once a deployment config is paused. PausedDeployReason = "DeploymentConfigPaused" // ResumedDeployReason is added in a deployment config when it is resumed. Useful for not failing accidentally // deployment configs that paused amidst a rollout. ResumedDeployReason = "DeploymentConfigResumed" )
const DeployerPodSuffix = "deploy"
DeployerPodSuffix is the suffix added to pods created from a deployment
Variables ¶
This section is empty.
Functions ¶
func ActiveDeployment ¶ added in v1.1.1
func ActiveDeployment(input []api.ReplicationController) *api.ReplicationController
ActiveDeployment returns the latest complete deployment, or nil if there is no such deployment. The active deployment is not always the same as the latest deployment.
func AnyDeployerPodSelector ¶
AnyDeployerPodSelector returns a label Selector which can be used to find all deployer pods across all deployments, including hook and custom deployer pods.
func CanTransitionPhase ¶ added in v1.2.0
func CanTransitionPhase(current, next deployapi.DeploymentStatus) bool
CanTransitionPhase returns whether it is allowed to go from the current to the next phase.
func ConfigSelector ¶
ConfigSelector returns a label Selector which can be used to find all deployments for a DeploymentConfig.
TODO: Using the annotation constant for now since the value is correct but we could consider adding a new constant to the public types.
func DecodeDeploymentConfig ¶
func DecodeDeploymentConfig(controller *api.ReplicationController, decoder runtime.Decoder) (*deployapi.DeploymentConfig, error)
DecodeDeploymentConfig decodes a DeploymentConfig from controller using codec. An error is returned if the controller doesn't contain an encoded config.
func DeployerPodNameFor ¶
func DeployerPodNameForDeployment ¶
DeployerPodNameForDeployment returns the name of a pod for a given deployment
func DeployerPodSelector ¶
DeployerPodSelector returns a label Selector which can be used to find all deployer pods associated with a deployment with name.
func DeploymentConfigDeepCopy ¶ added in v1.3.0
func DeploymentConfigDeepCopy(dc *deployapi.DeploymentConfig) (*deployapi.DeploymentConfig, error)
func DeploymentConfigNameFor ¶
func DeploymentDeepCopy ¶ added in v1.3.0
func DeploymentDeepCopy(rc *api.ReplicationController) (*api.ReplicationController, error)
func DeploymentNameFor ¶
func DeploymentNameForConfigVersion ¶ added in v1.0.7
DeploymentNameForConfigVersion returns the name of the version-th deployment for the config that has the provided name
func DeploymentStatusFor ¶
func DeploymentStatusFor(obj runtime.Object) deployapi.DeploymentStatus
func DeploymentVersionFor ¶
func DeploymentsForCleanup ¶ added in v1.3.0
func DeploymentsForCleanup(configuration *deployapi.DeploymentConfig, deployments []api.ReplicationController) []api.ReplicationController
DeploymentsForCleanup determines which deployments for a configuration are relevant for the revision history limit quota
func EncodeDeploymentConfig ¶
func EncodeDeploymentConfig(config *deployapi.DeploymentConfig, codec runtime.Codec) (string, error)
EncodeDeploymentConfig encodes config as a string using codec.
func GetAvailablePods ¶ added in v1.3.0
GetAvailablePods returns all the available pods from the provided pod list.
func GetDeploymentCondition ¶ added in v1.4.0
func GetDeploymentCondition(status deployapi.DeploymentConfigStatus, condType deployapi.DeploymentConditionType) *deployapi.DeploymentCondition
GetDeploymentCondition returns the condition with the provided type.
func GetReplicaCountForDeployments ¶ added in v1.3.0
func GetReplicaCountForDeployments(deployments []api.ReplicationController) int32
GetReplicaCountForDeployments returns the sum of all replicas for the given deployments.
func GetStatusReplicaCountForDeployments ¶ added in v1.3.0
func GetStatusReplicaCountForDeployments(deployments []api.ReplicationController) int32
GetStatusReplicaCountForDeployments returns the sum of the replicas reported in the status of the given deployments.
func HasChangeTrigger ¶ added in v1.0.7
func HasChangeTrigger(config *deployapi.DeploymentConfig) bool
HasChangeTrigger returns whether the provided deployment configuration has a config change trigger or not
func HasImageChangeTrigger ¶ added in v1.4.0
func HasImageChangeTrigger(config *deployapi.DeploymentConfig) bool
HasImageChangeTrigger returns whether the provided deployment configuration has an image change trigger or not.
func HasSynced ¶ added in v1.3.0
func HasSynced(dc *deployapi.DeploymentConfig, generation int64) bool
HasSynced checks if the provided deployment config has been noticed by the deployment config controller.
func IsCompleteDeployment ¶ added in v1.4.0
func IsCompleteDeployment(deployment *api.ReplicationController) bool
IsCompleteDeployment returns true if the passed deployment failed.
func IsDeploymentCancelled ¶
func IsDeploymentCancelled(deployment *api.ReplicationController) bool
func IsFailedDeployment ¶ added in v1.3.0
func IsFailedDeployment(deployment *api.ReplicationController) bool
IsFailedDeployment returns true if the passed deployment failed.
func IsOwnedByConfig ¶ added in v1.3.0
func IsOwnedByConfig(deployment *api.ReplicationController) bool
IsOwnedByConfig checks whether the provided replication controller is part of a deployment configuration. TODO: Switch to use owner references once we got those working.
func IsProgressing ¶ added in v1.4.0
func IsProgressing(config deployapi.DeploymentConfig, newStatus deployapi.DeploymentConfigStatus) bool
IsProgressing expects a state deployment config and its updated status in order to determine if there is any progress.
func IsRollingConfig ¶ added in v1.4.0
func IsRollingConfig(config *deployapi.DeploymentConfig) bool
IsRollingConfig returns true if the strategy type is a rolling update.
func IsTerminatedDeployment ¶ added in v1.0.7
func IsTerminatedDeployment(deployment *api.ReplicationController) bool
IsTerminatedDeployment returns true if the passed deployment has terminated (either complete or failed).
func LabelForDeployment ¶
func LabelForDeployment(deployment *api.ReplicationController) string
LabelForDeployment builds a string identifier for a Deployment.
func LabelForDeploymentConfig ¶
func LabelForDeploymentConfig(config *deployapi.DeploymentConfig) string
LabelForDeploymentConfig builds a string identifier for a DeploymentConfig.
func LatestDeploymentInfo ¶ added in v1.0.7
func LatestDeploymentInfo(config *deployapi.DeploymentConfig, deployments []api.ReplicationController) (bool, *api.ReplicationController)
LatestDeploymentInfo returns info about the latest deployment for a config, or nil if there is no latest deployment. The latest deployment is not always the same as the active deployment.
func LatestDeploymentNameForConfig ¶
func LatestDeploymentNameForConfig(config *deployapi.DeploymentConfig) string
LatestDeploymentNameForConfig returns a stable identifier for config based on its version.
func MakeDeployment ¶
func MakeDeployment(config *deployapi.DeploymentConfig, codec runtime.Codec) (*api.ReplicationController, error)
MakeDeployment creates a deployment represented as a ReplicationController and based on the given DeploymentConfig. The controller replica count will be zero.
func MaxSurge ¶ added in v1.4.0
func MaxSurge(config deployapi.DeploymentConfig) int32
MaxSurge returns the maximum surge pods a rolling deployment config can take.
func MaxUnavailable ¶ added in v1.4.0
func MaxUnavailable(config deployapi.DeploymentConfig) int32
MaxUnavailable returns the maximum unavailable pods a rolling deployment config can take.
func NewDeploymentCondition ¶ added in v1.4.0
func NewDeploymentCondition(condType deployapi.DeploymentConditionType, status api.ConditionStatus, reason, message string) *deployapi.DeploymentCondition
NewDeploymentCondition creates a new deployment condition.
func RemoveDeploymentCondition ¶ added in v1.4.0
func RemoveDeploymentCondition(status *deployapi.DeploymentConfigStatus, condType deployapi.DeploymentConditionType)
RemoveDeploymentCondition removes the deployment condition with the provided type.
func SetDeploymentCondition ¶ added in v1.4.0
func SetDeploymentCondition(status *deployapi.DeploymentConfigStatus, condition deployapi.DeploymentCondition)
SetDeploymentCondition updates the deployment to include the provided condition. If the condition that we are about to add already exists and has the same status and reason then we are not going to update.
func WaitForRunningDeployerPod ¶ added in v1.3.0
func WaitForRunningDeployerPod(podClient kcoreclient.PodsGetter, rc *api.ReplicationController, timeout time.Duration) error
WaitForRunningDeployerPod waits a given period of time until the deployer pod for given replication controller is not running.
Types ¶
type ByLatestVersionAsc ¶ added in v1.0.7
type ByLatestVersionAsc []api.ReplicationController
ByLatestVersionAsc sorts deployments by LatestVersion ascending.
func (ByLatestVersionAsc) Len ¶ added in v1.0.7
func (d ByLatestVersionAsc) Len() int
func (ByLatestVersionAsc) Less ¶ added in v1.0.7
func (d ByLatestVersionAsc) Less(i, j int) bool
func (ByLatestVersionAsc) Swap ¶ added in v1.0.7
func (d ByLatestVersionAsc) Swap(i, j int)
type ByLatestVersionDesc ¶ added in v1.0.7
type ByLatestVersionDesc []api.ReplicationController
ByLatestVersionDesc sorts deployments by LatestVersion descending.
func (ByLatestVersionDesc) Len ¶ added in v1.0.7
func (d ByLatestVersionDesc) Len() int
func (ByLatestVersionDesc) Less ¶ added in v1.0.7
func (d ByLatestVersionDesc) Less(i, j int) bool
func (ByLatestVersionDesc) Swap ¶ added in v1.0.7
func (d ByLatestVersionDesc) Swap(i, j int)
type ByMostRecent ¶ added in v1.1.1
type ByMostRecent []*api.ReplicationController
ByMostRecent sorts deployments by most recently created.
func (ByMostRecent) Len ¶ added in v1.1.1
func (s ByMostRecent) Len() int
func (ByMostRecent) Less ¶ added in v1.1.1
func (s ByMostRecent) Less(i, j int) bool
func (ByMostRecent) Swap ¶ added in v1.1.1
func (s ByMostRecent) Swap(i, j int)