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

[ci] Click to deploy cloud #205623

Merged
merged 13 commits into from
Jan 23, 2025
Merged
27 changes: 27 additions & 0 deletions .buildkite/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .buildkite/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@
"globby": "^11.1.0",
"js-yaml": "^4.1.0",
"minimatch": "^5.0.1",
"minimist": "^1.2.8",
"tslib": "*"
},
"devDependencies": {
"@types/chai": "^4.3.3",
"@types/js-yaml": "^4.0.5",
"@types/minimatch": "^3.0.5",
"@types/minimist": "^1.2.5",
"@types/mocha": "^10.0.1",
"@types/node": "^15.12.2",
"chai": "^4.3.10",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/rre.schema.json
apiVersion: backstage.io/v1alpha1
kind: Resource
metadata:
name: bk-kibana-deploy-cloud-from-pr
description: 'Builds Kibana and initiates a Kibana cloud deployment from a PR'
links:
- url: 'https://buildkite.com/elastic/kibana-deploy-cloud-from-pr'
title: Pipeline link
spec:
type: buildkite-pipeline
system: buildkite
owner: 'group:kibana-operations'
implementation:
apiVersion: buildkite.elastic.dev/v1
kind: Pipeline
metadata:
name: kibana / deploy cloud from PR
description: 'Builds Kibana and initiates a Kibana cloud deployment from a PR'
spec:
env:
ELASTIC_SLACK_NOTIFICATIONS_ENABLED: 'false'

allow_rebuilds: false
branch_configuration: main
default_branch: main
repository: elastic/kibana
pipeline_file: .buildkite/pipelines/build_pr_and_deploy_cloud.yml
provider_settings:
build_pull_requests: true
prefix_pull_request_fork_branch_names: false
skip_pull_request_builds_for_existing_commits: true
trigger_mode: none
cancel_intermediate_builds: true
teams:
kibana-operations:
access_level: MANAGE_BUILD_AND_READ
appex-qa:
access_level: MANAGE_BUILD_AND_READ
kibana-tech-leads:
access_level: MANAGE_BUILD_AND_READ
everyone:
access_level: BUILD_AND_READ
tags:
- kibana
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ spec:
branch_configuration: main
default_branch: main
repository: elastic/kibana
pipeline_file: .buildkite/pipelines/serverless_deployment/project-build-and-deploy-pr.yml
pipeline_file: .buildkite/pipelines/serverless_deployment/build_pr_and_deploy_project.yml
provider_settings:
build_pull_requests: true
prefix_pull_request_fork_branch_names: false
Expand Down
52 changes: 52 additions & 0 deletions .buildkite/pipeline-utils/github/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

import { Octokit, RestEndpointMethodTypes } from '@octokit/rest';

export const KIBANA_COMMENT_SIGIL = 'kbn-message-context';

const github = new Octokit({
auth: process.env.GITHUB_TOKEN,
});
Expand Down Expand Up @@ -113,6 +115,56 @@ export function addComment(
});
}

export async function upsertComment(
messageOpts: {
commentBody: string;
commentContext: string;
clearPrevious: boolean;
},
owner = process.env.GITHUB_PR_BASE_OWNER,
repo = process.env.GITHUB_PR_BASE_REPO,
prNumber: undefined | string | number = process.env.GITHUB_PR_NUMBER
) {
const { commentBody, commentContext, clearPrevious } = messageOpts;
if (!owner || !repo || !prNumber) {
throw Error(
"Couldn't retrieve Github PR info from environment variables in order to add a comment"
);
}
if (!commentContext) {
throw Error('Comment context is required when updating a comment');
}

const commentMarker = `<!-- ${KIBANA_COMMENT_SIGIL}:${commentContext} -->`;
const body = `${commentMarker}\n${commentBody}`;

const existingComment = (
await github.paginate(github.issues.listComments, {
owner,
repo,
issue_number: typeof prNumber === 'number' ? prNumber : parseInt(prNumber, 10),
})
).find((comment) => comment.body?.includes(commentMarker));

if (!existingComment) {
return addComment(body, owner, repo, prNumber);
} else if (clearPrevious) {
await github.issues.deleteComment({
owner,
repo,
comment_id: existingComment.id,
});
return addComment(body, owner, repo, prNumber);
} else {
return github.issues.updateComment({
owner,
repo,
comment_id: existingComment.id,
body,
});
}
}

export function getGithubClient() {
return github;
}
82 changes: 82 additions & 0 deletions .buildkite/pipelines/build_pr_and_deploy_cloud.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
env:
ELASTIC_PR_COMMENTS_ENABLED: 'true'
ELASTIC_GITHUB_BUILD_COMMIT_STATUS_ENABLED: 'true'
GITHUB_BUILD_COMMIT_STATUS_CONTEXT: kibana-deploy-cloud-from-pr

steps:
- group: 'Cloud Deployment'
if: "build.env('GITHUB_PR_LABELS') =~ /(ci:cloud-deploy|ci:cloud-redeploy)/"

steps:
- command: .buildkite/scripts/lifecycle/pre_build.sh
label: Pre-Build
timeout_in_minutes: 10
agents:
provider: gcp
image: family/kibana-ubuntu-2004
imageProject: elastic-images-prod
machineType: n2-standard-2
retry:
automatic:
- exit_status: '*'
limit: 1

- command: |
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
--message "PR Cloud deployment started at: $BUILDKITE_BUILD_URL" \
--context "cloud-deploy-job" \
--clear-previous
label: Comment with job URL
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agents:
provider: gcp
image: family/kibana-ubuntu-2004
imageProject: elastic-images-prod
machineType: n2-standard-2
timeout_in_minutes: 5
- command: .buildkite/scripts/steps/build_kibana.sh
label: Build Kibana Distribution
agents:
provider: gcp
image: family/kibana-ubuntu-2004
imageProject: elastic-images-prod
machineType: n2-standard-8
preemptible: true
diskSizeGb: 125
if: "build.env('KIBANA_BUILD_ID') == null || build.env('KIBANA_BUILD_ID') == ''"
timeout_in_minutes: 90
retry:
automatic:
- exit_status: '-1'
limit: 3

- wait: ~

- command: .buildkite/scripts/steps/cloud/build_and_deploy.sh
label: 'Build and Deploy to Cloud'
agents:
provider: gcp
image: family/kibana-ubuntu-2004
imageProject: elastic-images-prod
machineType: n2-standard-2
preemptible: true
timeout_in_minutes: 30
retry:
automatic:
- exit_status: '-1'
limit: 3

- wait: ~

- command: |
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
--message "Cloud deployment initiated, see credentials at: $BUILDKITE_BUILD_URL" \
--context "cloud-deploy-job" \
--clear-previous
label: Comment with job URL
agents:
provider: gcp
image: family/kibana-ubuntu-2004
imageProject: elastic-images-prod
machineType: n2-standard-2
timeout_in_minutes: 5
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ steps:
limit: 1

- command: |
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "PR Project deployment started at: $BUILDKITE_BUILD_URL"
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
--message "PR Project deployment started at: $BUILDKITE_BUILD_URL" \
--context "project-deploy-job" \
--clear-previous
label: Comment with job URL
agents:
provider: gcp
Expand Down Expand Up @@ -62,7 +65,10 @@ steps:
- wait: ~

- command: |
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "Project deployed, see credentials at: $BUILDKITE_BUILD_URL"
ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
--message "Project deployed, see credentials at: $BUILDKITE_BUILD_URL" \
--context "project-deploy-job" \
--clear-previous
label: Comment with job URL
agents:
provider: gcp
Expand Down
25 changes: 25 additions & 0 deletions .buildkite/pull_requests.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,31 @@
"/__snapshots__/",
"\\.test\\.(ts|tsx|js|jsx)"
]
},
{
"repoOwner": "elastic",
"repoName": "kibana",
"pipelineSlug": "kibana-deploy-cloud-from-pr",
"skip_ci_labels": [],
"enabled": true,
"allow_org_users": true,
"allowed_repo_permissions": ["admin", "write"],
"allowed_list": ["elastic-vault-github-plugin-prod[bot]"],
"set_commit_status": true,
"commit_status_context": "kibana-deploy-cloud-from-pr",
"build_on_commit": false,
"build_on_comment": true,
"build_drafts": false,
"trigger_comment_regex": "^(?:(?:buildkite\\W+)?(?:deploy)\\W+(?:cloud))$",
"kibana_versions_check": true,
"kibana_build_reuse": true,
"kibana_build_reuse_pipeline_slugs": ["kibana-pull-request", "kibana-on-merge", "kibana-deploy-cloud-from-pr"],
"kibana_build_reuse_regexes": [
"^test/",
"^x-pack/test/",
"/__snapshots__/",
"\\.test\\.(ts|tsx|js|jsx)"
]
}
]
}
Loading