Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
title: EnvironmentDeploymentDeprecateAction
type: object
description: |
Deprecates containers in a specific deployment within an environment.
Deprecated deployments will not receive new traffic but existing instances
continue running until explicitly stopped.
required:
- action
- contents
properties:
action:
type: string
enum:
- deployment.deprecate
contents:
type: object
required:
- deployment
properties:
deployment:
description: The selector for which deployment to deprecate.
oneOf:
- type: object
properties:
version:
description: Targets the deployment with this exact version.
$ref: ../../Version.yml
- type: object
properties:
tag:
description: Targets the deployment with this exact tag applied to it.
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
title: EnvironmentDeploymentReinstateAction
type: object
description: |
Reinstates containers in a previously deprecated deployment within an
environment, restoring them to active status and allowing them to
receive traffic again.
required:
- action
- contents
properties:
action:
type: string
enum:
- deployment.reinstate
contents:
type: object
required:
- deployment
properties:
deployment:
description: The selector for which deployment to reinstate.
oneOf:
- type: object
properties:
version:
description: Targets the deployment with this exact version.
$ref: ../../Version.yml
- type: object
properties:
tag:
description: Targets the deployment with this exact tag applied to it.
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
title: EnvironmentDeploymentStartAction
type: object
description: |
Starts a specific deployment within an environment. Requires a deployment
object identifying the tag or version to start.
required:
- action
- contents
properties:
action:
type: string
enum:
- deployment.start
contents:
type: object
required:
- deployment
properties:
deployment:
description: The selector for which deployment to start.
oneOf:
- type: object
properties:
version:
description: Targets the deployment with this exact version.
$ref: ../../Version.yml
- type: object
properties:
tag:
description: Targets the deployment with this exact tag applied to it.
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
title: EnvironmentDeploymentStopAction
type: object
description: |
Stops a specific deployment within an environment. Requires a deployment
object identifying the tag or version to stop.
required:
- action
- contents
properties:
action:
type: string
enum:
- deployment.stop
contents:
type: object
required:
- deployment
properties:
deployment:
description: The selector for which deployment to stop.
oneOf:
- type: object
properties:
version:
description: Targets the deployment with this exact version.
$ref: ../../Version.yml
- type: object
properties:
tag:
description: Targets the deployment with this exact tag applied to it.
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
title: EnvironmentDeploymentsPruneAction
type: object
description: |
Remove any containers that are part of a deployment that does NOT have a tag associated with it.
required:
- action
properties:
action:
type: string
enum:
- deployments.prune
10 changes: 10 additions & 0 deletions components/schemas/environments/task/EnvironmentTask.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ discriminator:
stop: EnvironmentStopAction.yml
initialize: EnvironmentInitializeAction.yml
deployments.reconfigure: EnvironmentReconfigureDeploymentsAction.yml
deployment.start: EnvironmentDeploymentStartAction.yml
deployment.stop: EnvironmentDeploymentStopAction.yml
deployment.deprecate: EnvironmentDeploymentDeprecateAction.yml
deployment.reinstate: EnvironmentDeploymentReinstateAction.yml
deployments.prune: EnvironmentDeploymentsPruneAction.yml
monitoring.reconfigure: EnvironmentReconfigureMonitoringAction.yml
oneOf:
- $ref: EnvironmentStartAction.yml
- $ref: EnvironmentStopAction.yml
- $ref: EnvironmentInitializeAction.yml
- $ref: EnvironmentReconfigureDeploymentsAction.yml
- $ref: EnvironmentDeploymentStartAction.yml
- $ref: EnvironmentDeploymentStopAction.yml
- $ref: EnvironmentDeploymentDeprecateAction.yml
- $ref: EnvironmentDeploymentReinstateAction.yml
- $ref: EnvironmentDeploymentsPruneAction.yml
- $ref: EnvironmentReconfigureMonitoringAction.yml
2 changes: 2 additions & 0 deletions components/schemas/hubs/activity/Activity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ properties:
- environment.deployments.prune
- environment.deployment.start
- environment.deployment.stop
- environment.deployment.deprecate
- environment.deployment.reinstate

- environment.scoped-variable.delete
- environment.scoped-variable.update
Expand Down
4 changes: 4 additions & 0 deletions components/schemas/pipelines/PipelineSteps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ discriminator:
environment.deployments.tag: steps/EnvironmentDeploymentsTagStep.yml
environment.deployments.prune: steps/EnvironmentDeploymentsPruneStep.yml
environment.deployment.healthy.watch: steps/EnvironmentDeploymentHealthyWatchStep.yml
environment.deployment.deprecate: steps/EnvironmentDeploymentDeprecateStep.yml
environment.deployment.reinstate: steps/EnvironmentDeploymentReinstateStep.yml

stack.build.create: steps/StackBuildCreateStep.yml
stack.build.generate: steps/StackBuildGenerateStep.yml
Expand Down Expand Up @@ -61,6 +63,8 @@ oneOf:
- $ref: steps/EnvironmentDeploymentStopStep.yml
- $ref: steps/EnvironmentDeploymentsTagStep.yml
- $ref: steps/EnvironmentDeploymentsPruneStep.yml
- $ref: steps/EnvironmentDeploymentDeprecateStep.yml
- $ref: steps/EnvironmentDeploymentReinstateStep.yml
- $ref: steps/EnvironmentDeploymentHealthyWatchStep.yml

# stack steps
Expand Down
2 changes: 2 additions & 0 deletions components/schemas/pipelines/runs/PipelineRunStep.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ properties:
- environment.deployment.start
- environment.deployment.stop
- environment.deployment.healthy.watch
- environment.deployment.deprecate
- environment.deployment.reinstate
- image.create
- image.import
- images.prune
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
title: EnvironmentDeploymentDeprecateStep
type: object
description: |
Deprecates a tagged deployment within an environment. Deprecated deployments
will not receive new traffic but existing instances continue running until stopped.
required:
- action
- details
properties:
identifier:
type: string
description: An identifier for the step.
options:
type: object
properties:
skip:
type: boolean
action:
type: string
description: The action that the step takes.
enum:
- environment.deployment.deprecate
details:
type: object
required:
- environment
properties:
environment:
$ref: ../FluidIdentifier.yml
tag:
type:
- string
- "null"
version:
type:
- string
- "null"
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
title: EnvironmentDeploymentReinstateStep
type: object
description: |
Reinstates a previously deprecated deployment within an environment,
restoring it to active status and allowing it to receive traffic again.
required:
- action
- details
properties:
identifier:
type: string
description: An identifier for the step.
options:
type: object
properties:
skip:
type: boolean
action:
type: string
description: The action that the step takes.
enum:
- environment.deployment.reinstate
details:
type: object
required:
- environment
properties:
environment:
$ref: ../FluidIdentifier.yml
tag:
type:
- string
- "null"
version:
type:
- string
- "null"
6 changes: 6 additions & 0 deletions components/schemas/search/Component.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ required:
- events
- context_blobs
- associations
- annotations
properties:
id:
description: ID of the component
Expand Down Expand Up @@ -58,3 +59,8 @@ properties:
provider-location:
description: Associated provider location Id
type: string
annotations:
description: Key-value pairs for additional component metadata
type: object
additionalProperties:
type: string
Loading