Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new healthy deployment pipeline step #289

Merged
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
2 changes: 2 additions & 0 deletions components/schemas/pipelines/PipelineSteps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ discriminator:
environment.deployment.stop: steps/EnvironmentDeploymentStopStep.yml
environment.deployments.tag: steps/EnvironmentDeploymentsTagStep.yml
environment.deployments.prune: steps/EnvironmentDeploymentsPruneStep.yml
environment.deployment.healthy.watch: steps/EnvironmentDeploymentHealthyWatchStep.yml

stack.build.create: steps/StackBuildCreateStep.yml
stack.build.generate: steps/StackBuildGenerateStep.yml
Expand Down Expand Up @@ -58,6 +59,7 @@ oneOf:
- $ref: steps/EnvironmentDeploymentStopStep.yml
- $ref: steps/EnvironmentDeploymentsTagStep.yml
- $ref: steps/EnvironmentDeploymentsPruneStep.yml
- $ref: steps/EnvironmentDeploymentHealthyWatchStep.yml

# stack steps
- $ref: steps/StackBuildCreateStep.yml
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
title: EnvironmentDeploymentHealthyWatchStep
type: object
description: |
Waits for a deployment to be considered 'healthy' before allowing the pipeline to continue.
A deployement is considered 'healthy' when all instances of all containers that have had a state change in the last 15 minutes
that have health checks defined, become healthy.
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.healthy.watch
details:
type: object
required:
- environment
properties:
environment:
$ref: ../FluidIdentifier.yml
tag:
type: string
nullable: true
version:
type: string
nullable: true
max_wait:
type: string
nullable: true
description: The maximum amount of time to wait for the deployment to become healthy before failing this step.
allOf:
- $ref: ../../Duration.yml
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@
"lint:public": "npx @redocly/cli lint ./public/api.yml",
"lint:internal": "npx @redocly/cli lint ./internal/api.yml",
"build": "npm run build:public && npm run build:internal",
"build:public": "npx @redocly/cli bundle public/api.yml --output dist/public-api.yml",
"build:internal": "npx @redocly/cli bundle internal/api.yml --output dist/internal-api.yml",
"build:public": "npx @redocly/cli@1.9.0 bundle public/api.yml --output dist/public-api.yml",
"build:internal": "npx @redocly/cli@1.9.0 bundle internal/api.yml --output dist/internal-api.yml",
"preview:public": "npm run build:public && npx @redocly/cli preview-docs dist/public-api.yml",
"preview:internal": "npm run build:internal && npx @redocly/cli preview-docs dist/internal-api.yml"
},
"author": "Petrichor Holdings, Inc.",
"license": "Apache-2.0"
"license": "Apache-2.0",
"devDependencies": {
"@redocly/cli": "1.9.0"
}
}
Loading