diff --git a/.github/ISSUE_TEMPLATE/component_release_template.md b/.github/ISSUE_TEMPLATE/component_release_template.md index eee254d9f8..c4996b9048 100644 --- a/.github/ISSUE_TEMPLATE/component_release_template.md +++ b/.github/ISSUE_TEMPLATE/component_release_template.md @@ -1,5 +1,5 @@ -This is a component issue for __{REPLACE_WITH_RELEASE_VERSION}__. -Coming from [opensearch-build__REPLACE_ISSUE_NUMBER__](https://github.com/opensearch-project/opensearch-build/issues/__REPLACE_ISSUE_NUMBER__). Please follow the following checklist. +This is a component issue for {{RELEASE_VERSION}}. +Coming from {{RELEASE_ISSUE}}. Please follow the following checklist. __Please refer to the DATES in that post__.
How to use this issue @@ -22,7 +22,7 @@ Linked at the top of this issue, the overall release issue captures the state of ## What should I do if my plugin isn't making any changes? -If including changes in this release, increment the version on `__{REPLACE_MAJOR_MINOR_PATCH}__` branch to `__{REPLACE_MAJOR_MINOR_PATCH}__` for Min/Core, and `__{REPLACE_MAJOR_MINOR_PATCH_0}__` for components. Otherwise, keep the version number unchanged for both. +If including changes in this release, increment the version on `{{RELEASE_BRANCH_X}}` branch to `{{RELEASE_VERSION}}` for Min/Core, and `{{RELEASE_VERSION}}.0` for components. Otherwise, keep the version number unchanged for both.

@@ -32,20 +32,20 @@ If including changes in this release, increment the version on `__{REPLACE_MAJOR - [ ] Assign this issue to a release owner. - [ ] Finalize scope and feature set and update [the Public Roadmap](https://github.com/orgs/opensearch-project/projects/1). - [ ] All the tasks in this issue have been reviewed by the release owner. -- [ ] Create, update, triage and label all features and issues targeted for this release with `v__REPLACE_MAJOR_MINOR_PATCH__`. +- [ ] Create, update, triage and label all features and issues targeted for this release with `v{{RELEASE_VERSION}}`. ### CI/CD -- [ ] All code changes for `__{REPLACE_MAJOR_MINOR_PATCH}__` are complete. +- [ ] All code changes for `{{RELEASE_BRANCH}}` are complete. - [ ] Ensure working and passing CI. - [ ] Check that this repo is included in the [distribution manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/__REPLACE_MAJOR_MINOR_PATCH__). ### Pre-Release -- [ ] Update to the `__REPLACE_MAJOR_MINOR__` release branch in the [distribution manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/__REPLACE_MAJOR_MINOR_PATCH__). +- [ ] Update to the `{{RELEASE_VERSION}}` release branch in the [distribution manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/{{RELEASE_VERSION}}). - [ ] Increment the version on the parent branch to the next development iteration. - [ ] Gather, review and publish release notes following the [rules](https://github.com/opensearch-project/opensearch-plugins/blob/main/RELEASE_NOTES.md) and back port it to the release branch.[git-release-notes](https://github.com/ariatemplates/git-release-notes) may be used to generate release notes from your commit history. -- [ ] Confirm that all changes for `__{REPLACE_MAJOR_MINOR_PATCH}__` have been merged. +- [ ] Confirm that all changes for `{{RELEASE_VERSION}}` have been merged. - [ ] Add this repo to the [manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/) for the next developer iteration. ### Release Testing diff --git a/.github/ISSUE_TEMPLATE/release_template.md b/.github/ISSUE_TEMPLATE/release_template.md index 0b254c13a4..237b1acd6c 100644 --- a/.github/ISSUE_TEMPLATE/release_template.md +++ b/.github/ISSUE_TEMPLATE/release_template.md @@ -13,90 +13,80 @@ I noticed that a manifest was automatically created in [manifests/{{ env.VERSION ## This Release Issue -This issue captures the state of the OpenSearch release, its assignee is responsible for driving the release. Please contact them or @mention them on this issue for help. There are linked issues on components of the release where individual components can be tracked. More details are included in the Maintainers [Release owner](https://github.com/opensearch-project/opensearch-build/blob/main/MAINTAINERS.md#release-owner) section. - -## Release Steps - -There are several steps to the release process, these steps are completed as the whole release and components that are behind present risk to the release. The release owner completes the tasks in this ticket, whereas component owners resolve tasks on their ticket in their repositories. - -Steps have completion dates for coordinating efforts between the components of a release; components can start as soon as they are ready far in advance of a future release. - -### Component List - -To aid in understanding the state of the release there is a table with status indicating each component state. This is updated based on the status of the component issues. +This issue captures the state of the OpenSearch release, its assignee (Release Manager) is responsible for driving the release. Please contact them or @mention them on this issue for help. There are linked issues on components of the release where individual components can be tracked. For more information check the the [Release Process OpenSearch Guide](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md).

-### Preparation +Please refer to the following link for the release version dates: [Release Schedule and Maintenance Policy](https://opensearch.org/releases.html). -- [ ] Assign this issue to a release owner. -- [ ] Declare a pencils down date for new features to be merged. -- [ ] __REPLACE_RELEASE-minus-14-days__ is pencils down date for feature freeze. -- [ ] Update the Campaigns section to include monitoring campaigns during this release. -- [ ] Update this issue so all `__REPLACE_RELEASE-__` placeholders have actual dates. -- [ ] Document any new quality requirements or changes. -- [ ] Finalize scope and feature set and update [the Public Roadmap](https://github.com/orgs/opensearch-project/projects/1). -- [ ] [Create a release issue in every component repo](https://github.com/opensearch-project/opensearch-plugins/blob/main/META.md#create-an-issue-in-all-plugin-repos) based on [component release issue template](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/component_release_template.md) and link back to this issue, update Components section with these links. -- [ ] Ensure the label is created in each component repo for this new version, and the next minor release. [Create a version label](https://github.com/opensearch-project/opensearch-plugins/blob/main/META.md#create-or-update-labels-in-all-plugin-repos) -- [ ] Ensure that all release issues created above are assigned to an owner in the component team. -- [ ] Increase the build frequency for the this release from once a day (H 1 * * *) to once every hour (H/60 * * * *) in [jenkinsFile](https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/check-for-build.jenkinsfile). +### [Preparation](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#preparation) -### Campaigns +- [ ] [Release manager](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-manager) assigned. +- [ ] Existence of label in each component repo. For more information check the [release-label](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-label) section. +- [ ] [Increase the build frequency](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#increase-the-build-frequency). +- [ ] [Release Issue](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-issue). -__REPLACE with OpenSearch wide initiatives to improve quality and consistency.__ +### [Campaigns](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#campaigns) -### Release Branch - _Ends __REPLACE_RELEASE-minus-14-days__ +- [ ] [Components Release Issue](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#components-release-issue). +- [ ] [Release Campaigns](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-campaigns). -- [ ] Component versions are auto-incremented to {{ env.VERSION }} version. -- [ ] Plugins team to ensure working CI in component repositories and merge the version increment PRs. -- [ ] OpenSearch / OpenSearch-Dashboards core cut branch `.` early. -- [ ] All component repos create `.` branch for the release. +### [Release Branch and Version Increment](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-branch-readiness) - _Ends __REPLACE_RELEASE-minus-14-days__ -### Feature Freeze - _Ends __REPLACE_RELEASE-minus-12-days__ +- [ ] [Core Release Branch](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#core). +- [ ] [Core Version Increment](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#core-version-increment). +- [ ] [Components Release Branch](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#components). +- [ ] [Components Version Increment](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#components-version-increment). + +### [Feature Freeze](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-12-days__ - [ ] OpenSearch / OpenSearch-Dashboards core and components teams finalize their features. -- [ ] Create Jenkins workflows that run daily snapshot builds for [OpenSearch](https://build.ci.opensearch.org/job/distribution-build-opensearch/) and [OpenSearch Dashboards](https://build.ci.opensearch.org/job/distribution-build-opensearch-dashboards/). -- [ ] Make pull requests to add each component to [manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml) and [manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml) with the corresponding checks. -### Code Complete - _Ends __REPLACE_RELEASE-minus-10-days___ +### [Code Complete](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) - _Ends __REPLACE_RELEASE-minus-10-days___ -- [ ] Code Complete: Make sure that the code for this specific version of the release is ready and the branch corresponding to this release has been added to this release version manifest. -- [ ] Verify pull requests to add each component to [manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml) and [manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml) have been merged. -- [ ] Gather, review and combine the release notes from components repositories. +- [ ] Mark this as done once the [Code Complete](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#code-complete-and-feature-freeze) is reviewed. +- [ ] Create/Verify pull requests to add each component to relase input [manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-{{ env.VERSION }}.yml) and [manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}/opensearch-dashboards-{{ env.VERSION }}.yml). -### Release testing - _Ends __REPLACE_RELEASE-minus-6-days___ +### [Release Candidate Creation and Testing](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-candidate-creation-and-testing) - _Ends __REPLACE_RELEASE-minus-6-days___ -- [ ] Declare a release candidate build, and provide the instructions with the release candidates for teams on testing (__REPLACE_RELEASE-minus-8-days__). -- [ ] Stop builds for this version of OpenSearch and/or OpenSearch Dashboards in order to avoid accidental commits going in unknowingly. Restart only if necessary else manually run the build workflow and declare new release candidate. -- [ ] After generate the release candidates, raise PR to lock input manifest refs of both OS and OSD builds with the commit ids from distribution manifest of the release candidates. -- [ ] Sanity Testing (__REPLACE_RELEASE-minus-8-days__ - __REPLACE_RELEASE-minus-6-days__): Sanity testing and fixing of critical issues found by teams. Teams test their components within the distribution, ensuring integration, backwards compatibility, and perf tests pass. -- [ ] Publish all test results in the comments of this issue. +- [ ] [Generate Release Candidate](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-candidate). +- [ ] [Integ Test TAR](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#integ-test-tar). +- [ ] [Integ Test RPM](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#integ-test-rpm). +- [ ] [Docker Build and Scan](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#docker-build-and-scan). +- [ ] [Backwards Compatibility Tests](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#backwards-compatibility-tests). +- [ ] [Windows Integ Test](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#windows-integ-test). +- [ ] [Broadcast and Communication](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#broadcast-and-communication). +- [ ] [Release Candidate Lock](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-candidate-lock). -### Performance testing validation - _Ends __REPLACE_RELEASE-minus-6-days___ +### [Performance testing validation](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#performance-test) - _Ends __REPLACE_RELEASE-minus-6-days___ - [ ] Performance tests do not show a regression. - [ ] Longevity tests do not show any issues. -### Release - _Ends {__REPLACE_RELEASE-day}_ +### [Pre Release](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#pre-release) - _Ends __REPLACE_RELEASE-minus-1-days___ + +- [ ] [Release Labeled Issues](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-labeled-issues). +- [ ] [Go or No-Go](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#go-or-no-go). +- [ ] [Promote Repos](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#promote-repos). +- [ ] [Promote artifacts](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#promote-artifacts). +- [ ] [Release Notes](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-notes). -- [ ] Verify [all issues labeled `v{{ env.VERSION }}` in all projects](https://github.com/opensearch-project/project-meta#find-labeled-issues) have been resolved. -- [ ] Complete [documentation](https://github.com/opensearch-project/documentation-website) for this release. -- [ ] Author [blog post](https://github.com/opensearch-project/project-website) for this release. -- [ ] __REPLACE_RELEASE-minus-1-day - Publish this release on [opensearch.org](https://opensearch.org/downloads.html). -- [ ] __REPLACE_RELEASE-day - Publish a [blog post](https://github.com/opensearch-project/project-website) - release is launched! +### [Release](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#main-release) - _Ends {__REPLACE_RELEASE-day}_ -### Post Release +- [ ] [Maven Promotion](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#maven-promotion). +- [ ] [Docker Promotion](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#docker-promotion). +- [ ] [Release Validation](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-validation). +- [ ] [Collaboration with the Project Management Team](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#collaboration-with-the-project-management-team). -- [ ] Create [release tags](https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/release-tag/release-tag.jenkinsfile) for each component (Jenkins job name: release-tag-creation). -- [ ] Replace refs in [manifests/{{ env.VERSION }}](/opensearch-project/opensearch-build/tree/main/manifests/{{ env.VERSION }}) with tags and remove checks. -- [ ] If this is a major or minor version release, stop building previous patch version. -- [ ] Generate distribution release notes reviewed by PM team for opensearch-build repository. -- [ ] Increment version for Helm Charts [(sample PR)](https://github.com/opensearch-project/helm-charts/pull/246) for the `{{ env.VERSION }}` release. -- [ ] Increment version for Ansible Charts [(sample PR)](https://github.com/opensearch-project/ansible-playbook/pull/50) for the `{{ env.VERSION }}` release. -- [ ] Prepare [for next patch release](https://github.com/opensearch-project/opensearch-plugins/blob/main/META.md#increment-a-version-in-every-plugin) by incrementing patch versions for each component. -- [ ] Update [this template](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/release_template.md) with any new or missed steps. -- [ ] Create an issue for a retrospective, solicit feedback, and publish a summary. +### [Post Release](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#post-release) + +- [ ] [Release Tags](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#release-tags). +- [ ] [Input Manifest Update](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#input-manifest-update). +- [ ] [OpenSearch Build Release notes](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#opensearch-build-release-notes). +- [ ] [Decrease the build frequency](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#decrease-the-build-frequency). +- [ ] [Retrospective Issue](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#retrospective-issue). +- [ ] [Helm and Ansible Playbook release](https://github.com/prudhvigodithi/opensearch-build/blob/public/RELEASE_PROCESS_OPENSEARCH.md#helm-and-ansible-playbook-release). ### Components @@ -116,4 +106,4 @@ __Replace with links to all component tracking issues.__ | :red_circle: | Missed multiple milestones |

- + \ No newline at end of file diff --git a/README.md b/README.md index 4272f8c404..03b4a6b34b 100644 --- a/README.md +++ b/README.md @@ -7,33 +7,33 @@ - [Releasing OpenSearch](#releasing-opensearch) - [Releases and Versions](#releases-and-versions) - - [Creating a New Version](#creating-a-new-version) - - [Onboarding a New Plugin](#onboarding-a-new-plugin) - - [Building and Testing an OpenSearch Distribution](#building-and-testing-an-opensearch-distribution) - - [Building from Source](#building-from-source) - - [Assembling a Distribution](#assembling-a-distribution) - - [Building Patches](#building-patches) - - [Min snapshots](#min-snapshots) - - [CI/CD Environment](#cicd-environment) - - [Build Numbers](#build-numbers) - - [Latest Distribution Url](#latest-distribution-url) - - [Testing the Distribution](#testing-the-distribution) - - [Checking Release Notes](#checking-release-notes) - - [Signing Artifacts](#signing-artifacts) - - [PGP](#pgp) - - [Windows](#windows) - - [Signing RPM artifacts](#signing-rpm-artifacts) - - [Making a Release](#making-a-release) - - [Releasing for Linux](#releasing-for-linux) - - [Releasing for FreeBSD](#releasing-for-freebsd) - - [Releasing for Windows](#releasing-for-windows) - - [Releasing for MacOS](#releasing-for-macos) - - [Utilities](#utilities) - - [Checking Out Source](#checking-out-source) - - [Cross-Platform Builds](#cross-platform-builds) - - [Sanity Checking the Bundle](#sanity-checking-the-bundle) - - [Auto-Generating Manifests](#auto-generating-manifests) - - [Deploying Infrastructure](#deploying-infrastructure) + - [Release labels](#release-labels) +- [Onboarding a New Plugin](#onboarding-a-new-plugin) +- [Building and Testing an OpenSearch Distribution](#building-and-testing-an-opensearch-distribution) + - [Building from Source](#building-from-source) + - [Assembling a Distribution](#assembling-a-distribution) + - [Building Patches](#building-patches) + - [Min snapshots](#min-snapshots) + - [CI/CD Environment](#cicd-environment) + - [Build Numbers](#build-numbers) + - [Latest Distribution Url](#latest-distribution-url) + - [Testing the Distribution](#testing-the-distribution) + - [Checking Release Notes](#checking-release-notes) + - [Signing Artifacts](#signing-artifacts) + - [PGP](#pgp) + - [Windows](#windows) + - [Signing RPM artifacts](#signing-rpm-artifacts) +- [Making a Release](#making-a-release) + - [Releasing for Linux](#releasing-for-linux) + - [Releasing for FreeBSD](#releasing-for-freebsd) + - [Releasing for Windows](#releasing-for-windows) + - [Releasing for MacOS](#releasing-for-macos) +- [Utilities](#utilities) + - [Checking Out Source](#checking-out-source) + - [Cross-Platform Builds](#cross-platform-builds) + - [Sanity Checking the Bundle](#sanity-checking-the-bundle) + - [Auto-Generating Manifests](#auto-generating-manifests) +- [Deploying Infrastructure](#deploying-infrastructure) - [Contributing](#contributing) - [Getting Help](#getting-help) - [Code of Conduct](#code-of-conduct) @@ -41,22 +41,21 @@ - [License](#license) - [Copyright](#copyright) -## Releasing OpenSearch +### Releasing OpenSearch -### Releases and Versions +See [release process](./RELEASE_PROCESS_OPENSEARCH.md) document for more information. + +#### Releases and Versions The OpenSearch project releases as versioned distributions of OpenSearch, OpenSearch Dashboards, and the OpenSearch plugins. It [follows semantic versioning](https://opensearch.org/blog/technical-post/2021/08/what-is-semver/). Software, such as Data Prepper, clients, and the Logstash output plugin, are versioned independently of the OpenSearch Project. They also may have independent releases from the main project distributions. The OpenSearch Project may also release software under alpha, beta, release candidate, and generally available labels. The definition of when to use these labels is derived from [the Wikipedia page on Software release lifecycle](https://en.wikipedia.org/wiki/Software_release_life_cycle). Below is the definition of when to use each label. -Release labels: +#### Release labels: * **Alpha** - The code is released with instructions to build. Built distributions of the software may not be available. Some features many not be complete. Additional testing and developement work is planned. Distributions will be postfixed with `-alphaX` where "X" is the number of the alpha version (e.g., "2.0-alpha1"). * **Beta** - Built distributions of the software are available. All features are completed. Additional testing and developement work is planned. Distributions will be postfixed with `-betaX` where "X" is the number of the beta version (e.g., "2.0.0-beta1"). * **Release Candidate** - Built distributions of the software are available. All features are completed. Code is tested and minimal validation remains. At this stage the software is potentially stable and will release unless signficant bugs emerge. Distributions will be postfixed with `-rcX` where "X" is the number of the release candidate version (e.g., "2.0.0-rc1"). * **Generally Available** - Built distributions of the software are available. All features are completed and documented. All testing is completed. Distributions for generally available versions are not postfixed with an additional label (e.g., "2.0.0"). -### Creating a New Version - -Each new OpenSearch release process starts when any one component increments a version, typically on the `main` branch. For example, [OpenSearch#1192](https://github.com/opensearch-project/OpenSearch/pull/1192) incremented the version to 2.0. The [version check automation workflow](.github/workflows/versions.yml) will notice this change or it can be triggered [manually](https://github.com/opensearch-project/opensearch-build/actions/workflows/versions.yml), and make a pull request (e.g. [opensearch-build#514](https://github.com/opensearch-project/opensearch-build/pull/514)) that adds a new manifest (e.g. [opensearch-2.0.0.yml](manifests/2.0.0/opensearch-2.0.0.yml). After that's merged, a GitHub issue is automatically opened by [this workflow](.github/workflows/releases.yml) to make a new release using [this release template](.github/ISSUE_TEMPLATE/release_template.md) (e.g. [opensearch-build#566](https://github.com/opensearch-project/opensearch-build/issues/566)). Existing and new components [(re)onboard into every release](ONBOARDING.md) by submitting pull requests to each version's manifest. ### Onboarding a New Plugin @@ -210,9 +209,10 @@ RPM artifacts are signed via a legacy shell script which uses a [macros template See [src/sign_workflow](./src/sign_workflow) for more information. + ### Making a Release -#### Releasing for Linux / Windows +#### Releasing for Linux and Windows The Linux / Windows release is managed by a team at Amazon following [this release template](.github/ISSUE_TEMPLATE/release_template.md) (e.g. [opensearch-build#2649](https://github.com/opensearch-project/opensearch-build/issues/2649)). @@ -277,6 +277,7 @@ Check for updates and create any new manifests. See [src/manifests_workflow](./src/manifests_workflow) for more information. + ### Deploying Infrastructure Storage and access roles for the OpenSearch release process are codified in a [CDK project](./deployment/README.md). diff --git a/RELEASE_PROCESS_OPENSEARCH.md b/RELEASE_PROCESS_OPENSEARCH.md new file mode 100644 index 0000000000..fb93705d77 --- /dev/null +++ b/RELEASE_PROCESS_OPENSEARCH.md @@ -0,0 +1,530 @@ +- [OpenSearch Releas Process](#opensearch-release-process) + - **[Preparation](#preparation)** + - [Release Terminology and Knowledge Center](#release-terminology-and-knowledge-center) + - [Definitions](#definitions) + - [Types of Manifests](#types-of-manifests) + - [Input Manifest](#input-manifest) + - [Test Manifest](#test-manifest) + - [Build Manifest](#build-manifest) + - [Bundle Manifest](#bundle-manifest) + - [AUTOCUT issues](#autocut-issues) + - [Build Workflows](#build-workflows) + - [Release Workflows](#release-workflows) + - [Creating a New Version](#creating-a-new-version) + - [Release Manager](#release-manager) + - [Release label](#release-label) + - [Release issue](#release-issue) + - [Release Issue Update](#release-issue-update) + - [Increase the build frequency](#increase-the-build-frequency) + - **[Campaigns](#campaigns)** + - [Components Release Issue](#components-release-issue) + - [Issue Creation Process Overview](#issue-creation-process-overview) + - [Release Campaigns](#release-campaigns) + - **[Release Branch Readiness](#release-branch-readiness)** + - [Release Branch](#release-branch) + - [Core](#core) + - [Components](#components) + - [Version Increment](#version-increment) + - [Core Version Increment](#core-version-increment) + - [Components Version Increment](#components-version-increment) + - **[Code Complete and Feature Freeze](#code-complete-and-feature-freeze)** + - **[Release Candidate Creation and Testing](#release-candidate-creation-and-testing)** + - [Distribution Build](#distribution-build) + - [Workflow Trigger](#workflow-trigger) + - [Order of Execution](#order-of-execution) + - [OpenSearch](#opensearch) + - [OpenSearch Dashboards](#opensearch-dashboards) + - [Release Candidate](#release-candidate) + - [Sample Build details](#sample-build-details) + - [Integ Test TAR](#integ-test-tar) + - [Integ Test RPM](#integ-test-rpm) + - [Docker Build and Scan](#docker-build-and-scan) + - [Docker RC freeze](#docker-rc-freeze) + - [Benchmark Tests](#benchmark-tests) + - [Backwards Compatibility Tests](#backwards-compatibility-tests) + - [Windows Integ Test](#windows-integ-test) + - [Broadcast and Communication](#broadcast-and-communication) + - [Release Candidate Lock](#release-candidate-lock) + - **[Release](#release)** + - [Pre-Release](#pre-release) + - [Release Labeled Issues](#release-labeled-issues) + - [Go or No-Go](#go-or-no-go) + - [Promote Repos](#promote-repos) + - [Promote artifacts](#promote-artifacts) + - [Release Notes](#release-notes) + - [Main Release](#main-release) + - [Maven Promotion](#maven-promotion) + - [Docker Promotion](#docker-promotion) + - [Collaboration with the Project Management Team](#collaboration-with-the-project-management-team) + - [Website and Documentation Changes](#website-and-documentation-changes) + - [Publish blog posts](#publish-blog-posts) + - [Advertise on Social Media](#advertise-on-social-media) + - [Release Validation](#release-validation) + - **[Post Release](#post-release)** + - [Release Tags](#release-tags) + - [Input Manifest Update](#input-manifest-update) + - [OpenSearch Build Release notes](#opensearch-build-release-notes) + - [Decrease the build frequency](#decrease-the-build-frequency) + - [Retrospective Issue](#retrospective-issue) + - [Helm and Ansible Playbook release](#helm-and-ansible-playbook-release) + - [Upcoming Release Preparation](#upcoming-release-preparation) + - **[Communication Templates](#communication-templates)** + - [Release Announcement](#release-announcement) + - [Release Readiness](#release-readiness) + - [Release Candidate Announcement](#release-candidate-announcement) + - [Release Complete](#release-complete) + +# OpenSearch Release Process + +## Preparation +### Release Terminology and Knowledge Center + +#### Definitions + +**OpenSearch Project**: OpenSearch is a community-driven, Apache 2.0-licensed open source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data.
+ +**OpenSearch/OpenSearch Dashboards Bundle**: An OpenSearch/OpenSearch Dashboards bundle refers to a compressed file that encompasses both the OpenSearch/OpenSearch Dashboards distribution and accompanying plugins. This compressed file acts as a container for the OpenSearch/OpenSearch Dashboards software and its associated extensions, enabling users to conveniently package and deploy the entire system.
+ +**OpenSearch/OpenSearch Dashboards Components/Plugins**: OpenSearch/OpenSearch Dashboards components/plugins are extensions that can be added to OpenSearch/OpenSearch Dashboards, to add new features or functionality. There are a wide variety of plugins available refer [OpenSearch available plugins](https://opensearch.org/docs/latest/install-and-configure/plugins/#available-plugins) and [OpenSearch Dashboards available plugins](https://opensearch.org/docs/latest/install-and-configure/install-dashboards/plugins/#available-plugins) sections.
+ +#### Types of Manifests + +##### Input Manifest + +These manifests serve as the initial input for driving the build workflow. These manifests are located in [build repository](https://github.com/opensearch-project/opensearch-build/tree/main/manifests) and are generated by the [manifest workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/manifests_workflow). Once the manifest is created, the maintainers of the build repository review and merge it into the `main` branch. The entire build repository operates exclusively on the `main` branch. + +##### Test Manifest + +These manifests are integral to the comprehensive testing of the core and components/plugins, as they contain numerous settings and configurations that facilitate various tests within the [test_workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/test_workflow). + +###### Sample Test Manifests + +| OpenSearch | OpenSearch Dashboards | +| --- | --- | +| [opensearch-2.8.0-test.yml](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/2.8.0/opensearch-2.8.0-test.yml) | [opensearch-dashboards-2.8.0-test.yml](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/2.8.0/opensearch-dashboards-2.8.0-test.yml) + +##### Build Manifest + +Output of the [build workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/build_workflow), used as input to the [assemble workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/assemble_workflow). + + ###### Sample Generated Build Manifests + + | deb | rpm | tar | windows | + | --- | --- | --- | ------- | + | [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/deb/builds/opensearch/manifest.yml), [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/deb/builds/opensearch/manifest.yml) | [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/rpm/builds/opensearch/manifest.yml), [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/rpm/builds/opensearch/manifest.yml) | [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/tar/builds/opensearch/manifest.yml), [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/tar/builds/opensearch/manifest.yml) | [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/windows/x64/zip/builds/opensearch/manifest.yml) | + + +##### Bundle Manifest + +The final output of the assemble workflow and manifest that is added to the final distribution, this has the commitID (can be used for reproducible builds) and the artifact file links. This final bundle manifest incorporates the assembled components and ensures traceability through the commit ID and accessibility to the artifact files. + + ###### Sample Generated Bundle Manifests + + | deb | rpm | tar | windows | + | --- | --- | --- | ------- | + | [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/deb/dist/opensearch/manifest.yml), [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/deb/dist/opensearch/manifest.yml) | [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/rpm/dist/opensearch/manifest.yml), [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/rpm/dist/opensearch/manifest.yml) | [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/x64/tar/dist/opensearch/manifest.yml), [os-arm64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/linux/arm64/tar/dist/opensearch/manifest.yml) | [os-x64](https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.10/7848/windows/x64/zip/dist/opensearch/manifest.yml) | + + +#### AUTOCUT issues + +These are the issues created by automation with the distribution build and integ-test worklows failure, the automation detects the component failure and raises an issue in the respective component repo. Sample [integ-test failure AUTOCUT issue](https://github.com/opensearch-project/k-NN/issues/914) and [distribution build failure AUTOCUT issue](https://github.com/opensearch-project/k-NN/issues/732). + + +#### Build Workflows + +| Wokflow | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ------------------- | +| [Check for Build](https://build.ci.opensearch.org/job/check-for-build/) | Workflow that peridically triggers the distribution workflows using parameterized cron. | +| [OpenSearch Distribution Build](https://build.ci.opensearch.org/job/distribution-build-opensearch/) | Workflow that is responsible to build/assemble the OpenSearch and its components. | +| [OpenSearch Dashboards Distribution Build](https://build.ci.opensearch.org/job/distribution-build-opensearch-dashboards/) | Workflow that is responsible to build/assemble the OpenSearch Dashboards and its components. | +| [OpenSearch Integ Test](https://build.ci.opensearch.org/job/integ-test/) | Workflow that runs integ tests for OpenSearch and its components. | +| [OpenSearch Dashboards Integ Test](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/) | Workflow that runs integ tests for OpenSearch Dashboards and its components. | +| [Benchmark Tests](https://build.ci.opensearch.org/job/benchmark-test/) | Workflow that runs Performance tests using [opensearch-benchmark](https://github.com/opensearch-project/opensearch-benchmark) on a cluster created with a given version. | +| [BWC Tests](https://build.ci.opensearch.org/job/bwc-test/) | Workflow that runs backward compatibility tests on a cluster created with a given version. | +| [RPM Validation](https://build.ci.opensearch.org/job/rpm-validation/) | Workflow that validates the RPM distribution | +| [Docker Build](https://build.ci.opensearch.org/job/docker-build/) | Workflow that builds the OpenSearch and OpenSearch Dashboards docker images | +| [Docker Copy](https://build.ci.opensearch.org/job/docker-copy/) | Workflow that copies the created docker images to multiple DockerHub and ECR repositories | +| [Docker Scan](https://build.ci.opensearch.org/job/docker-scan/) | Workflow that checks vulnerabilities for a given docker image as an input. | + + +#### Release Workflows + +| Wokflow | Description | +| ---------------------------------------------------------------------------------------- | ------------------- | +| [Release Notes Tracker](https://build.ci.opensearch.org/job/release-notes-tracker/) | Workflow that identifies if a component has a release notes added based on the commit history. | +| [Promote Repos](https://build.ci.opensearch.org/job/distribution-promote-repos/) | Workflow that signs and promotes the APT/YUM repos to the production buckets accessed via the cloudfront. | +| [Promote artifacts](https://build.ci.opensearch.org/job/distribution-promote-artifacts/) | Workflow that signs and promotes all the release artifcats to the production buckets accessed via the cloudfront. | +| [Publish to Maven](https://build.ci.opensearch.org/job/publish-to-maven/) | Workflow that signs and publishes to the central maven repository. | +| [Docker Promotion](https://build.ci.opensearch.org/job/docker-promotion/) | Workflow that promotoes the docker images to production docker repositories. | +| [Validation Workflow](https://build.ci.opensearch.org/job/distribution-validation) | Workflow that validates the released distribution. | + + +#### Creating a New Version + +Each new OpenSearch release process starts when any one component increments a version, typically on the `main` branch. For example, [OpenSearch#1192](https://github.com/opensearch-project/OpenSearch/pull/1192) incremented the version to 2.0. The [version check automation workflow](.github/workflows/versions.yml) will notice this change or it can be triggered [manually](https://github.com/opensearch-project/opensearch-build/actions/workflows/versions.yml), and make a pull request (e.g. [opensearch-build#514](https://github.com/opensearch-project/opensearch-build/pull/514)) that adds a new manifest (e.g. [opensearch-2.0.0.yml](manifests/2.0.0/opensearch-2.0.0.yml). After that's merged, a GitHub issue is automatically opened by [this workflow](.github/workflows/releases.yml) to make a new release using [this release template](.github/ISSUE_TEMPLATE/release_template.md) (e.g. [opensearch-build#566](https://github.com/opensearch-project/opensearch-build/issues/566)). Existing and new components [(re)onboard into every release](ONBOARDING.md) by submitting pull requests to each version's manifest. + +### Release Manager + +The release managers to a specific OpenSearch release will be assigned through volunteer model. The request for release managers will be posted in [OpenSearch public slack workspace](https://opensearch.slack.com/archives/C0561HRK961) (under releases channel) and selected on first come first served (FCFS) model. +Note: The release managers should be maintainers of a repo under OpenSearch GitHub organization. + +### Release Label + +The release label creation is part of the version increment workflows running in the build repo [OpenSearch Version Increment Workflow](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/os-increment-plugin-versions.yml), +[OpenSearch Dashboards Version Increment Workflow](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/osd-increment-plugin-versions.yml). These workflows not only raise a pull request for a version increment but also verify if the release label exists for a given version. If it doesn't, they proceed to create it. + +### Release issue + +This issue captures the state of the OpenSearch release, its assignee is responsible for driving the release. Please contact them or @mention them on this issue for help. There are linked issues on components of the release where individual components can be tracked. More details are included in the Maintainers Release owner section. + + +#### Release Issue Update + +The release issue is created by an [automation workflow](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/releases.yml). Once the release manager is finalized, the release manager should be updating the created release issue. Sample [Release Issue 2.8.0](https://github.com/opensearch-project/opensearch-build/issues/3434). Update the release issue issue so all `__REPLACE_RELEASE-__` placeholders have actual dates. + +### Increase the build frequency + +Increase the build frequency for the this release from once a day (H 1 * * *) to once every hour (H/60 * * * *) in [check-for-build.jenkinsfile](https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/check-for-build.jenkinsfile). This will ensure the [Distribution Build](#distribution-build) workflow is called every hour to build and detect the components failure early that are part of the [Input Manifest](#input-manifest). + +## Campaigns + +This section is not required for a patch release. + +### Components Release Issue + +Create a release issue in each component repository and then update the "components" section of the release issue with the corresponding release issues generated in each component repository. Refer to the sample [component issues](https://github.com/opensearch-project/opensearch-build/issues/3434#issue-1679791812) for a specific release. Utilize the existing [component_release_template.md](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/component_release_template.md) to generate the component release issue. Make sure that all the release issues created earlier are linked to this release issue and assigned to a designated owner within the component team. + +#### Issue Creation Process Overview + +Inside the template [component_release_template.md](https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/component_release_template.md), replace the fields `RELEASE_VERSION`, `RELEASE_BRANCH_X`, `RELEASE_BRANCH` and `RELEASE_ISSUE` to desired release values before creating the release issues across the component/plugin repos. Once the fields are replaced use the `meta` and `gh` cli to create the issues. Find the list of components/plugins from the [opensearch-plugins](https://github.com/opensearch-project/opensearch-plugins) repo (for [OpenSearch](https://github.com/opensearch-project/opensearch-plugins/tree/main/plugins), for [OpenSearch Dashboards](https://github.com/opensearch-project/opensearch-plugins/tree/main/dashboards-plugins)) and use the `meta` cli to create the release issues. For more details check the [create-an-issue-in-all-plugin-repos](https://github.com/opensearch-project/opensearch-plugins/blob/main/META.md#create-an-issue-in-all-plugin-repos) section. + +``` +meta exec "gh issue create --label v2.8.0 --title 'Release version 2.8.0' --body-file /tmp/opensearch-build/.github/ISSUE_TEMPLATE/component_release_template.md" +``` + +### Release Campaigns + +If exists any release specific issues/campaigns link it back to the release issue. Sample linked [issues/campaigns](https://github.com/opensearch-project/opensearch-build/issues/3434#issuecomment-1552138916) + +## Release Branch Readiness + +The `Release Branch Readiness date` is determined as the release date minus 14 days. + +### Release Branch + +Not applicable for patch release. +#### Core + +This step requires both OpenSearch and OpenSearch Dashboards to create a release branch that will be used for the release. +#### Components + +This step requires that every team participating in a release has their release branch created for the corresponding release by the date listed on this step. The [Distribution Build](#distribution-build) workflow will also start using the release branch to create release candidate instead of `.x` branches. + + +### Version Increment + +Versions are incremented as soon as development starts on a given version to avoid confusion. Following is the example that depicts the version increment. + +* OpenSearch: `main` = 3.0.0, `2.x` = 2.9.0, and `2.8` = 2.8.1 +* common-utils: `main` = 3.0.0.0, `2.x` = 2.9.0.0 and `2.8` = 2.8.1.0 + +#### Core Version Increment + +To ensure the version incrementation process is handled correctly, it is important to follow to increment the version of the release branch. Currently, the version incrementation is being done manually by an individual from the core repositories. Sample OpenSearch Version Increment [PR](https://github.com/opensearch-project/OpenSearch/pull/7864/) for the release branch. + + +#### Components Version Increment + +The next step is to identify the pending component version increment pull requests. The creation of component version increment pull requests is automated with workflows running in the build repo [OpenSearch Version Increment Workflow](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/os-increment-plugin-versions.yml), +[OpenSearch Dashboards Version Increment Workflow](https://github.com/opensearch-project/opensearch-build/blob/main/.github/workflows/osd-increment-plugin-versions.yml). Sample component version increment [PR](https://github.com/opensearch-project/job-scheduler/pull/398). + +The objective is to merge these pull requests in order to synchronize all the components with the core version. It is not as simple as submitting a pull request and having it merged. When a pull request is submitted, CI checks are triggered for each repository. These CI checks assess the dependencies. Thus, prior to merging the pull requests that involve version increments, the release manager must confirm that the dependencies have been updated, built, and pushed to Maven and S3. This crucial stage requires the release manager to coordinate with the component teams, address any dependency issues, and ultimately merge the pull requests that involve version increments. + +## Code Complete and Feature Freeze + +Coordinate with the Core and component teams to ensure that the code for this particular release version is fully prepared and that the corresponding branch has been included in the release version [Input Manifest](#input-manifest). Update Jenkins workflows that execute daily snapshot builds for both OpenSearch and OpenSearch Dashboards (Ref [Increase the build frequency](#increase-the-build-frequency)). Submit pull requests to incorporate each component into the respective version level [Input Manifest](#input-manifest) along with the necessary checks. Sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3501/files). The `Feature Freeze date` and the `Code Complete date` is determined as the release date minus 4 days. + +## Release Candidate Creation and Testing + +### Distribution Build + +Refer the [Build Workflows](#build-workflows) section to get the details about the distribution build job for OpenSearch and OpenSearch Dashboards. This section covers how to sequentially handle the distribution build job during the release. + +#### Workflow Trigger + +Ensure the proper inputs are used to initiate the distribution. For instance, here's an example for OpenSearch. It's important that the OpenSearch Dashboard distribution aligns accordingly. + +![Alt Text](./assests/distribution_build_os.png) + +**COMPONENT_NAME**: To trigger a specific component, this includes standalone OpenSearch or specific plugin.
+ +**INPUT_MANIFEST**: The release input manifest that drives the workflow.
+ +**TEST_MANIFEST**: The release test input manifest that is used for the integ tests.
+ +**INTEG_TEST_JOB_NAME**: The integ test job name. Default already added to this input `integ-test` for OpenSearch and `integ-test-opensearch-dashboards` for OpenSearch Dashboards.
+ +**BUILD_PLATFORM**: The input used to build for a specific platform, followed by its own distributions within the `platform`.
+ +**BUILD_DISTRIBUTION**: Input to build selected distribution related artifacts, choices include 'tar', 'rpm', 'deb', 'zip'. Can combine multiple distributions with space in between (docker is only available on tar).
+ +**BUILD_DOCKER**: Input with a dropdown that has 3 options `build_docker`, `build_docker_with_build_number_tag`, `do_not_build_docker`, the release manager has to take a call with right inputs.
+ +**UPDATE_LATEST_URL**: To update the `/latest` CFN URL, Visit [latest-distribution-url](https://github.com/opensearch-project/opensearch-build#latest-distribution-url) for more details.
+ +##### Order of Execution + +Following is the order of execution of the distribution build to address the components dependencies. + +Note: The execution order specified is necessary only for versions up to `1.3.x`. For `2.x` and above Maven dependencies are published through each component repository using the GH workflow. For more details check the [META issue](https://github.com/opensearch-project/opensearch-build/issues/3185). + +###### OpenSearch +``` +OpenSearch +OpenSearch + common-utils + job-scheduler +OpenSearch + common-utils + job-scheduler + performance-analyzer +OpenSearch + common-utils + job-scheduler + performance-analyzer + security +OpenSearch + common-utils + job-scheduler + ml-commons + performance-analyzer + security +All components (which are ready after completion of version increment) +``` + +###### OpenSearch Dashboards +``` +OpenSearch Dashboards +All components (which are ready after completion of version increment) +``` + +### Release Candidate + +Now once all the version increment PR’s are completed and all the components are part of the input manifest, now its time to generate the RC. Use the [Distribution Build](#distribution-build) to generate the release candidate. Use the following section as the reference to generate the RC, validate it and broadcast it for a given release. The process of `Release Candidate Generation and Testing` should commence at least 6 days prior to the release date. + +#### Sample Build details + +Following is the generated build number after triggering the [Distribution Build](#distribution-build) workflow. The distribution build number denotes the RC, now with the example below the finalized RC’s are `OS: 7848`, `OSD: 6126`. + +| OpenSearch | OpenSearch Dashboards | +|----------|----------| +| [build_7848](https://build.ci.opensearch.org/job/distribution-build-opensearch/7848/console) | [build_6126](https://build.ci.opensearch.org/job/distribution-build-opensearch-dashboards/6126/) | + + +#### Integ Test TAR + +Following are the TAR integ test jobs for a given RC based on the above section [Sample Build details](#sample-build-details). The integ tests are executed for artifacts generated as part of the builds `OS: 7848`, `OSD: 6126`. + +| Integ Test Tar | x64 | arm64 | +|----------|----------|----------| +| OpenSearch | [x64](https://build.ci.opensearch.org/job/integ-test/4906/console) | [arm64](https://build.ci.opensearch.org/job/integ-test/4897/console) | +| OpenSearch Dashboards | [x64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3531/console) | [arm64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3530/console) | + +#### Integ Test RPM + +Following are the RPM integ test jobs for a given RC based on the above section [Sample Build details](#sample-build-details). The integ tests for rpm are executed for artifacts generated as part of the builds `OS: 7848`, `OSD: 6126`. + +| Integ Test RPM | x64 | arm64 | +|----------|----------|----------| +| OpenSearch | [x64](https://build.ci.opensearch.org/job/integ-test/4908/console) | [arm64](https://build.ci.opensearch.org/job/integ-test/4907/console) | +| OpenSearch Dashboards | [x64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3532/console) | [arm64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3533/console) | + +#### Docker Build and Scan + +Following are the details for the docker image build and scan. The docker images are built using the TAR artifact generated as part of the [Distribution Build](#distribution-build) (From the above example `OS: 7848`, `OSD: 6126`). The [Distribution Build](#distribution-build) workflow with input `BUILD_DOCKER` (Ref [Workflow Trigger](#workflow-trigger)) triggers the [docker-build] workflow as dowmstream. + +| Docker | build | scan | +|----------|----------|----------| +| OpenSearch | [Build](https://build.ci.opensearch.org/job/docker-build/3371/) | [Scan](https://build.ci.opensearch.org/job/docker-scan/1558/artifact/scan_docker_image.txt) | +| OpenSearch Dashboards | [Build](https://build.ci.opensearch.org/job/docker-build/3370/) | [Scan](https://build.ci.opensearch.org/job/docker-scan/1557/artifact/scan_docker_image.txt) | + + +##### Docker RC freeze + +This to ensure that [check-for-build.jenkinsfile](https://github.com/opensearch-project/opensearch-build/blob/main/jenkins/check-for-build.jenkinsfile) wont re-build periodically and override the docker, the RC docker is created with build number. This step can be skipped if the input `BUILD_DOCKER: build_docker_with_build_number_tag` (Ref [Workflow Trigger](#workflow-trigger) used in the [Distribution Build](#distribution-build). + +| Docker Freeze | copy | +|----------|----------| +| OpenSearch | [docker-copy](https://build.ci.opensearch.org/job/docker-copy/466/console) | +| OpenSearch Dashboards | [docker-copy](https://build.ci.opensearch.org/job/docker-copy/467/console) | + +#### Benchmark Tests + +For running the benchmark tests, use the `benchmark-test` job part of the [Build Workflows](#build-workflows). For more details in running the benchmark tests refer [Benchmarking Tests](https://github.com/opensearch-project/opensearch-build/tree/main/src/test_workflow#benchmarking-tests) section part of the [test workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/test_workflow). This job offers multiple options to test the performance of a specific version cluster using various metrics. The performance results can be accessed via the [OpenSearch Performance Benchmarks dashboard](https://opensearch.org/benchmarks). + + +#### Backwards Compatibility Tests + +For more details in running the BWC tests refer [Backwards Compatibility Tests](https://github.com/opensearch-project/opensearch-plugins/blob/main/TESTING.md#bwc-tests-on-distribution-bundle-level) section. +On board the components/plugins to the test [Test Manifest](#test-manifest) with the `bwc-test` setting. Example as follows. +``` + - name: index-management + bwc-test: + test-configs: + - with-security +``` + +#### Windows Integ Test + +Currently, the windows integration tests for a release is manual. The manually tested windows zip is being evaluated and approved by the plugin teams for sign off. In order to test the windows distribution, two instances need to be created: one with security features enabled and another without security. Afterward, API calls should be tested by launching the OpenSearch and Dashboard processes through direct execution of the `.bat` file. + +#### Broadcast and Communication + +Broadcast the release candidate in OpenSearch public slack workspace and the release GitHub issue using format [sample broadcast mesaage](https://github.com/opensearch-project/opensearch-build/issues/3434#issuecomment-1571201919) to gather votes. + +As a release manager it is essential to ensure the successful completion of all the above mentioned jobs. In the event of failures during integration tests or scans, the release manager should collaborate with the component teams and initiate a re-run to ensure that all jobs are executed successfully. + +Post all the job related failures in the `Release issue`, Sample [post](https://github.com/opensearch-project/opensearch-build/issues/3331#issuecomment-1550461519). + +Note: Sometimes the integ-test jobs are flaky and might not pass due to several reasons with the component code, in that case coordinate with the respective component team and get a manual sign off. Sample [manual sign off](https://github.com/opensearch-project/opensearch-build/issues/3331#issuecomment-1552191673). +All the failed logs are in s3 accessed through the cloudfront. Sample [link](https://github.com/opensearch-project/opensearch-build/issues/3331#issuecomment-1552148546). + + +#### Release Candidate Lock + +Stop builds for this version of OpenSearch and/or OpenSearch Dashboards in order to avoid accidental commits going in unknowingly. Restart only if necessary else manually run the build workflow and declare new release candidate. + +Once the RC is finalized, in order to exclude the release from running periodically, at this point it is necessary for the release manager to lock the input manifest and update the `check-for-build.jenkins` to remove it from the scheduled execution, sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3523/files). + + +## Release + +### Pre-Release + +Ensure that all pre-release activities listed below are completed before proceeding with the final release. These activities hold great significance as they determine whether the release should progress further and, if approved, they contribute to saving a substantial amount of time during the release window. + +#### Release Labeled Issues + +Verify all issues labeled with with this release have been resolved. Coordinate with the core/components team to close the gaps in resolving the issues labeled with with this release. + +#### Go or No-Go + +Get the Go / No-Go votes from project management committee (PMC) before staging the release artifacts for production publishing process, + +#### Promote Repos + +| Repo | OpenSearch (Sample Runs) | OpenSearch Dashboards (Sample Runs) | +| ---- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| YUM | [yum-os](https://build.ci.opensearch.org/job/distribution-promote-repos/46/) | [yum-osd](https://build.ci.opensearch.org/job/distribution-promote-repos/48/) | +| APT | [apt-os](https://build.ci.opensearch.org/job/distribution-promote-repos/) | [apt-osd](https://build.ci.opensearch.org/job/distribution-promote-repos/49/) | + + +#### Promote artifacts + +| Artifacts | OpenSearch (Sample Runs) | OpenSearch Dashboards (Sample Runs) | +| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Windows | [os-windows-zip-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/233/) | [osd-windows-zip-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/234/) | +| Debian | [os-deb-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/235/), [os-deb-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/236/) | [osd-deb-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/237/), [osd-deb-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/238/) | +| TAR | [os-tar-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/243/), [os-tar-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/246/) | [osd-tar-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/244/), [osd-tar-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/245/) | +| RPM | [os-rpm-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/239/), [os-rpm-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/240/) | [osd-rpm-arm64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/241/), [osd-rpm-x64](https://build.ci.opensearch.org/job/distribution-promote-artifacts/242/) | + + +#### Release Notes + +Coordinate with the plugin teams and create a consolidates release notes. Sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3532). Release manager can check if a plugin team has created a release notes or not using the [release notes tracker tool](https://github.com/opensearch-project/opensearch-build/tree/main/src/release_notes_workflow). Sample [run](https://build.ci.opensearch.org/job/release-notes-tracker/). + + +### Main Release + +Release the artifacts to production distribution channels, update the website and inform the community of the release. + +#### Maven Promotion +Promote OpenSearch to maven, trigger the `publish-to-maven worfklow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/publish-to-maven/17/console). + +#### Docker Promotion +Publish the images to docker and ECR, trigger the `docker promotion workflow` (Ref [Release Workflows](#release-workflows)), sample [run](https://build.ci.opensearch.org/job/docker-promotion/32/console). + +#### Collaboration with the Project Management Team + +While not directly under the responsibility of a Release Manager, the following sections require coordination with the Project Management Team to ensure that the tasks are successfully fulfilled. + +##### Website and Documentation Changes + +Coordinate with the documentation website team to ensure the changes are in place and close the gaps in promoting the website changes to prod. At this point the maintainers of the repos [documentation-website](https://github.com/opensearch-project/documentation-website) and [project-website](https://github.com/opensearch-project/project-website) will handle this task. + +##### Publish blog posts + +[Sample Blog Post](https://opensearch.org/blog/opensearch-2.8.0-released/) + +##### Advertise on Social Media + +Coordinate with the project management team to ensure the social media advertisement is completed + +#### Release Validation + +Use the validation workflow (Ref [Release Workflows](#release-workflows)) to validate the published artifcats, sample [validation workflow run](https://build.ci.opensearch.org/job/distribution-validation/3/console). + +## Post Release + +Once the release is completed following are the activities that needs to be completed by the release manager: + +### Release Tags + +Create release tags for each OpenSearch and Dashboard components. Sample [OpenSearch](https://build.ci.opensearch.org/job/distribution-release-tag-creation/78/), [OpenSearch Dashboards](https://build.ci.opensearch.org/job/distribution-release-tag-creation/77/) workflow runs. + +### Input Manifest Update + +Replace `refs` in input manifest with tags. The `refs` can be identified from the bundle or build manifest, sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3534) that updates the input manifest. + +### OpenSearch Build Release notes + +Generate distribution release notes for opensearch-build repository, sample [1.3.10](https://github.com/opensearch-project/opensearch-build/releases/tag/1.3.10) release details. + +### Decrease the build frequency + +Lower the frequency of builds for the release version of OpenSearch and/or OpenSearch Dashboards, sample [PR](https://github.com/opensearch-project/opensearch-build/pull/3523). + +### Retrospective Issue + +Create an issue for a retrospective, solicit feedback, and publish a summary. Sample [retro issue](https://github.com/opensearch-project/opensearch-build/issues/3535). + +### Helm and Ansible Playbook release + +Update and release the [Helm chart](https://github.com/opensearch-project/helm-charts) and [ansible playbook](https://github.com/opensearch-project/ansible-playbook) with the new OpenSearch and Dashboard version. Sample helm chart [PR](https://github.com/opensearch-project/helm-charts/pull/431/files) and ansible [PR](https://github.com/opensearch-project/ansible-playbook/pull/131). + +### Upcoming Release Preparation + +The release manager for the current release should ensure that a release manager is assigned for the upcoming release. This can be achieved by coordinating in a Slack channel and [@opensearch-project/engineering-effectiveness](https://github.com/orgs/opensearch-project/teams/engineering-effectiveness) team should assist in assigning the user to the upcoming [Release issue](#release-issue). + +## Communication Templates + +Please utilize the provided communication templates to effectively coordinate with the teams involved in the release process. These templates are designed to assist you in communicating through the GitHub release issue and the public Slack channel called `#release`. + +### Release Announcement + +``` +We are starting the process of release. +Release Issue: +Release Manager: + +Kindly review the following information provided below regarding the release dates: + +Release Branch and Version Increment: +Feature freeze: +Code Complete: +RC creation and : +Pre Release: +Release date: +Post Release: +``` + +### Release Readiness + +``` +The version increment pull requests are still awaiting attention. We kindly request the plugin/component owners to review them and make an effort to merge them promptly. + +OpenSearch: https://github.com/pulls?q=is%3Aopen+is%3Apr+org%3Aopensearch-project+increment++in%3Atitle+ + +OpenSearch Dashboards: https://github.com/pulls?q=is%3Aopen+is%3Apr+org%3Aopensearch-project+increment+.0+in%3Atitle+ +``` + + +### Release Candidate Announcement + +Refer the [sample rc announcement](https://github.com/opensearch-project/opensearch-build/issues/3331#issuecomment-1549876307) from past `1.3.10` release. + +### Release Complete + +``` +OpenSearch 2.8.0 version has been released to public :tada:! + +Thanks everyone for the help to bring release out. +Component repo owners please create a github release based on the tags of . +Presenting the retrospective for the release. Please feel free to provide your valuable feedback for further improvements in the upcoming release. +``` diff --git a/assests/distribution_build_os.png b/assests/distribution_build_os.png new file mode 100644 index 0000000000..23fcb9f793 Binary files /dev/null and b/assests/distribution_build_os.png differ