...

Source file src/github.com/openshift/api/apps/v1/consts.go

Documentation: github.com/openshift/api/apps/v1

     1  package v1
     2  
     3  const (
     4  	// DeploymentStatusReasonAnnotation represents the reason for deployment being in a given state
     5  	// Used for specifying the reason for cancellation or failure of a deployment
     6  	// This is on replication controller set by deployer controller.
     7  	DeploymentStatusReasonAnnotation = "openshift.io/deployment.status-reason"
     8  
     9  	// DeploymentPodAnnotation is an annotation on a deployment (a ReplicationController). The
    10  	// annotation value is the name of the deployer Pod which will act upon the ReplicationController
    11  	// to implement the deployment behavior.
    12  	// This is set on replication controller by deployer controller.
    13  	DeploymentPodAnnotation = "openshift.io/deployer-pod.name"
    14  
    15  	// DeploymentConfigAnnotation is an annotation name used to correlate a deployment with the
    16  	// DeploymentConfig on which the deployment is based.
    17  	// This is set on replication controller pod template by deployer controller.
    18  	DeploymentConfigAnnotation = "openshift.io/deployment-config.name"
    19  
    20  	// DeploymentCancelledAnnotation indicates that the deployment has been cancelled
    21  	// The annotation value does not matter and its mere presence indicates cancellation.
    22  	// This is set on replication controller by deployment config controller or oc rollout cancel command.
    23  	DeploymentCancelledAnnotation = "openshift.io/deployment.cancelled"
    24  
    25  	// DeploymentEncodedConfigAnnotation is an annotation name used to retrieve specific encoded
    26  	// DeploymentConfig on which a given deployment is based.
    27  	// This is set on replication controller by deployer controller.
    28  	DeploymentEncodedConfigAnnotation = "openshift.io/encoded-deployment-config"
    29  
    30  	// DeploymentVersionAnnotation is an annotation on a deployment (a ReplicationController). The
    31  	// annotation value is the LatestVersion value of the DeploymentConfig which was the basis for
    32  	// the deployment.
    33  	// This is set on replication controller pod template by deployment config controller.
    34  	DeploymentVersionAnnotation = "openshift.io/deployment-config.latest-version"
    35  
    36  	// DeployerPodForDeploymentLabel is a label which groups pods related to a
    37  	// deployment. The value is a deployment name. The deployer pod and hook pods
    38  	// created by the internal strategies will have this label. Custom
    39  	// strategies can apply this label to any pods they create, enabling
    40  	// platform-provided cancellation and garbage collection support.
    41  	// This is set on deployer pod by deployer controller.
    42  	DeployerPodForDeploymentLabel = "openshift.io/deployer-pod-for.name"
    43  
    44  	// DeploymentStatusAnnotation is an annotation name used to retrieve the DeploymentPhase of
    45  	// a deployment.
    46  	// This is set on replication controller by deployer controller.
    47  	DeploymentStatusAnnotation = "openshift.io/deployment.phase"
    48  )
    49  
    50  type DeploymentConditionReason string
    51  
    52  var (
    53  	// ReplicationControllerUpdatedReason is added in a deployment config when one of its replication
    54  	// controllers is updated as part of the rollout process.
    55  	ReplicationControllerUpdatedReason DeploymentConditionReason = "ReplicationControllerUpdated"
    56  
    57  	// ReplicationControllerCreateError is added in a deployment config when it cannot create a new replication
    58  	// controller.
    59  	ReplicationControllerCreateErrorReason DeploymentConditionReason = "ReplicationControllerCreateError"
    60  
    61  	// ReplicationControllerCreatedReason is added in a deployment config when it creates a new replication
    62  	// controller.
    63  	NewReplicationControllerCreatedReason DeploymentConditionReason = "NewReplicationControllerCreated"
    64  
    65  	// NewReplicationControllerAvailableReason is added in a deployment config when its newest replication controller is made
    66  	// available ie. the number of new pods that have passed readiness checks and run for at least
    67  	// minReadySeconds is at least the minimum available pods that need to run for the deployment config.
    68  	NewReplicationControllerAvailableReason DeploymentConditionReason = "NewReplicationControllerAvailable"
    69  
    70  	// ProgressDeadlineExceededReason is added in a deployment config when its newest replication controller fails to show
    71  	// any progress within the given deadline (progressDeadlineSeconds).
    72  	ProgressDeadlineExceededReason DeploymentConditionReason = "ProgressDeadlineExceeded"
    73  
    74  	// DeploymentConfigPausedReason is added in a deployment config when it is paused. Lack of progress shouldn't be
    75  	// estimated once a deployment config is paused.
    76  	DeploymentConfigPausedReason DeploymentConditionReason = "DeploymentConfigPaused"
    77  
    78  	// DeploymentConfigResumedReason is added in a deployment config when it is resumed. Useful for not failing accidentally
    79  	// deployment configs that paused amidst a rollout.
    80  	DeploymentConfigResumedReason DeploymentConditionReason = "DeploymentConfigResumed"
    81  
    82  	// RolloutCancelledReason is added in a deployment config when its newest rollout was
    83  	// interrupted by cancellation.
    84  	RolloutCancelledReason DeploymentConditionReason = "RolloutCancelled"
    85  )
    86  
    87  // DeploymentStatus describes the possible states a deployment can be in.
    88  type DeploymentStatus string
    89  
    90  var (
    91  
    92  	// DeploymentStatusNew means the deployment has been accepted but not yet acted upon.
    93  	DeploymentStatusNew DeploymentStatus = "New"
    94  
    95  	// DeploymentStatusPending means the deployment been handed over to a deployment strategy,
    96  	// but the strategy has not yet declared the deployment to be running.
    97  	DeploymentStatusPending DeploymentStatus = "Pending"
    98  
    99  	// DeploymentStatusRunning means the deployment strategy has reported the deployment as
   100  	// being in-progress.
   101  	DeploymentStatusRunning DeploymentStatus = "Running"
   102  
   103  	// DeploymentStatusComplete means the deployment finished without an error.
   104  	DeploymentStatusComplete DeploymentStatus = "Complete"
   105  
   106  	// DeploymentStatusFailed means the deployment finished with an error.
   107  	DeploymentStatusFailed DeploymentStatus = "Failed"
   108  )
   109  

View as plain text