salewski / opensearch-build Goto Github PK

• Releasing OpenSearch
  • Creating a New Version
  • Onboarding a New Plugin
  • Building and Testing an OpenSearch Distribution
    • Building from Source
    • Assembling a Distribution
    • Building Patches
    • CI/CD Environment
    • Testing the Distribution
    • Signing Artifacts
  • Making a Release
    • Releasing for Linux
    • Releasing for FreeBSD
    • Releasing for Windows
    • Releasing for MacOS
  • Utilities
    • Checking Out Source
    • Cross-Platform Builds
    • Sanity Checking the Bundle
    • Auto-Generating Manifests
  • Deploying Infrastructure
• Contributing
• Getting Help
• Code of Conduct
• Security
• License
• Copyright

OpenSearch and OpenSearch Dashboards are distributed as bundles that include both core engines and plugins. Each new OpenSearch release process starts when any one component increments a version, typically on the main branch. For example, OpenSearch#1192 incremented the version to 2.0. The manifest automation workflow will notice this change, and make a pull request (e.g. opensearch-build#514) that adds a new manifest (e.g. opensearch-2.0.0.yml. After that's merged, a GitHub issue is automatically opened by this workflow to make a new release using this release template (e.g. opensearch-build#566). Existing and new components (re)onboard into every release by submitting pull requests to each version's manifest.

Plugin owners can follow the Onboarding Process to onboard their plugins to the release process.

The distribution workflow builds a complete OpenSearch and OpenSearch Dashboards distribution from source. You can currently build 1.0, 1.1, 1.1-SNAPSHOT and 1.2 versions. This system performs a top-down build of all components required for a specific OpenSearch and OpenSearch Dashboards release, then assembles a distribution. The input to the system is a manifest that defines the order in which components should be built. All manifests for our current releases are here.

./build.sh manifests/1.2.0/opensearch-1.2.0.yml

This builds OpenSearch 1.2.0 from source, placing the output into ./builds/opensearch.

See build workflow for more information.

./assemble.sh builds/opensearch/manifest.yml

The assembling step takes output from the build step, installs plugins, and assembles a full distribition into the dist folder.

See assemble workflow for more information.

A patch release contains output from previous versions mixed with new source code. Manifests can mix such references. See opensearch-1.1.1.yml for an example.

OpenSearch is often released with changes in opensearch-min, and no changes to plugins other than a version bump. This can be performed by a solo Engineer following a cookbook. See also opensearch-build#1375 which aims to automate incrementing versions for the next development iteration.

We build, assemble, and test our artifacts on docker containers. We provide docker files in docker/ci folder, and images on staging docker hub repositories. All Jenkins pipelines can be found in jenkins. Jenkins itself is in the process of being made public and its CDK open-sourced.

See jenkins and docker for more information.

Tests the OpenSearch distribution, including integration, backwards-compatibility and performance tests.

./test.sh <test-type> <test-manifest-path> <path>

See src/test_workflow for more information.

The signing step takes the manifest file created from the build step and signs all its component artifacts using a tool called opensearch-signer-client (in progress of being open-sourced). The input requires a path to the build manifest and is expected to be inside the artifacts directory with the same directories mentioned in the build step.

./sign.sh builds/opensearch/manifest.yml

See src/sign_workflow for more information.

The Linux release is managed by a team at Amazon following this release template (e.g. opensearch-build#566).

The FreeBSD ports and packages for OpenSearch are managed by a community OpenSearch Team at FreeBSD. When a new release is rolled out, this team will update the port and commit it to the FreeBSD ports tree. Anybody is welcome to help the team by providing patches for upgrading the ports following the FreeBSD Porter's Handbook instructions.

At this moment there's no official Windows distribution. However, this project does support building and assembling OpenSearch for Windows, with some caveats. See opensearch-build#33 for details.

At this moment there's no official MacOS distribution. However, this project does support building and assembling OpenSearch for MacOS. See opensearch-build#37 and #38 for more details.

The checkout workflow checks out source code for a given manifest for further examination.

./checkout.sh manfiests/1.2.0/opensearch-1.2.0.yml

See src/checkout_workflow for more information.

You can perform cross-platform builds. For example, build and assemble a Windows distribution on MacOS.

export JAVA_HOME=$(/usr/libexec/java_home) # required by OpenSearch install-plugin during assemble
./build.sh manifests/1.2.0/opensearch-1.2.0.yml --snapshot --platform windows
./assemble.sh builds/opensearch/manifest.yml

This will produce dist/opensearch-1.2.0-SNAPSHOT-windows-x64.zip on Linux and MacOS.

This workflow runs sanity checks on every component present in the bundle, executed as part of the manifests workflow in this repository. It ensures that the component GitHub repositories are correct and versions in those components match the OpenSearch version.

The following example sanity-checks components in the the OpenSearch 1.2.0 manifest.

./ci.sh manifests/1.2.0/opensearch-1.2.0.yml --snapshot

See src/ci_workflow for more information.

The manifests workflow reacts to version increments in OpenSearch and its components by extracting Gradle properties from project branches. When a new version is found, a new input manifest is added to manifests, and a pull request is opened (e.g. opensearch-build#491).

Show information about existing manifests.

./manifests.sh list

Check for updates and create any new manifests.

./manifests.sh update

See src/manifests_workflow for more information.

Storage and access roles for the OpenSearch release process are codified in a CDK project.

See developer guide and how to contribute to this project.

If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.

For more information, see project website and documentation. If you need help and are unsure where to open an issue, try forums.

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact [email protected] with any additional questions or comments.

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

This project is licensed under the Apache v2.0 License.

Copyright OpenSearch Contributors. See NOTICE for details.