From a0cbd5be816039ca3e184dc8bb2555d976f7a9f2 Mon Sep 17 00:00:00 2001 From: Mario Rodriguez Molins Date: Tue, 17 Sep 2024 10:21:49 +0200 Subject: [PATCH] Update CI docs --- docs/ci_pipelines.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/ci_pipelines.md b/docs/ci_pipelines.md index 2ab2f873d33..f9d696d9509 100644 --- a/docs/ci_pipelines.md +++ b/docs/ci_pipelines.md @@ -7,6 +7,7 @@ Currently, there are five different pipelines: - https://buildkite.com/elastic/integrations-serverless: pipeline in charge of testing all packages using a Elastic Serverless project. More info at [section](#serverless-pipeline). - https://buildkite.com/elastic/integrations-publish: pipeline to publish the new versions of packages. More info at [section](#publish-packages). - https://buildkite.com/elastic/integrations-schedule-daily/: pipeline running every night to test packages in different scenarios. More info at [section](#daily-job). +- https://buildkite.com/elastic/integrations-schedule-weekly/: pipeline running once per week to test packages in different scenarios. More info at [section](#weekly-job). - https://buildkite.com/elastic/integrations-backport/: pipeline to create backport branches (just from UI). More info at [section](#backport-branches-pipeline). ## Pull Requests and pushes to specific branches @@ -22,6 +23,7 @@ Special comments that can be added in the Pull Request (by Elastic employees): There are some environment variables that can be added into this pipeline: - **FORCE_CHECK_ALL**: If `true`, this forces the CI to check all packages even if those packages have no file updated/added/deleted. Default: `false`. - **STACK_VERSION**: Force the CI steps to spin up a specific Elastic stack version to run the tests. Default: unset. +- **STACK_LOGSDB_ENABLED**: Force to enable LogsDB in Elasticsearch service. Default: false. - **PUBLISH_COVERAGE_REPORTS**: If `true`, it enables reporting coverage reports. Currently, it is just set for the build triggered with the current major Elastic stack from the daily job. Default: `false`. @@ -120,13 +122,17 @@ This environment variable can be defined at: Every night it is configured to run a daily job that will be in charge of testing all packages with different scenarios: https://buildkite.com/elastic/integrations-schedule-daily/ -The schedule of this job can be checked [here](https://github.com/elastic/integrations/blob/5714f5665bbe3bc29b9e2444c6a94dbc2d5eebe9/catalog-info.yaml#L93). +The schedule of this job can be checked [here](https://github.com/elastic/integrations/blob/2e72e8524728daca2d47c814d8042031b8f5804f/catalog-info.yaml#L145). The scenarios that are tested in this daily job are: - Test packages with a local Elastic stack running the previous major version of the stack (7.17.X SNAPSHOT). - Triggered pipeline: https://buildkite.com/elastic/integrations -- Test packages with a local Elastic stack running the latest major version of the stack (currently 8.X.Y-SNAPSHOT). +- Test packages with a local Elastic stack running the latest 8.x major version of the stack (currently 8.X.Y-SNAPSHOT). + - Triggered pipeline: https://buildkite.com/elastic/integrations +- Test packages with a local Elastic stack running the latest 8.x major version of the stack with LogsDB enabled (currently 8.X.Y-SNAPSHOT). + - Triggered pipeline: https://buildkite.com/elastic/integrations +- Test packages with a local Elastic stack running the latest major version of the stack (currently 9.X.Y-SNAPSHOT). - Triggered pipeline: https://buildkite.com/elastic/integrations - Test packages with an Elastic Serverless Observability project. - Triggered pipeline: https://buildkite.com/elastic/integration-serverless @@ -141,6 +147,24 @@ have been published by triggering the pipeline https://buildkite.com/elastic/int Each step triggering a new pipeline can be customized through environment variables. Environment variables that can be used in each pipeline are detailed in the corresponding sections of each pipeline. +## Weekly job + +**Note**: Just available for Employees at Elastic. + +Every week it is configured to run a job that will be in charge of testing all packages with non-Wolfi Elastic Agent docker images: https://buildkite.com/elastic/integrations-schedule-weekly/ + +The schedule of this job can be checked [here](https://github.com/elastic/integrations/blob/5714f5665bbe3bc29b9e2444c6a94dbc2d5eebe9/catalog-info.yaml#L93). + +The scenarios that are tested in this weekly job are: + +- Test packages with a local Elastic stack running the latest 8.x major version of the stack with Elastic Agent images based on Ubuntu iamges (currently 8.X.Y-SNAPSHOT). + - Triggered pipeline: https://buildkite.com/elastic/integrations +- Test packages with a local Elastic stack running the latest 9.x major version of the stack with Elastic Agent images based on non-wolfi images (currently 9.X.Y-SNAPSHOT). + - Triggered pipeline: https://buildkite.com/elastic/integrations + +Each step triggering a new pipeline can be customized through environment variables. Environment variables that can +be used in each pipeline are detailed in the corresponding sections of each pipeline. + ## Backport branches pipeline