Skip to content

Commit 027ac89

Browse files
authoredMar 28, 2025··
Add instructions about using jenkins auth (#5429)
Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>
1 parent bf9c8c6 commit 027ac89

4 files changed

+16
-3
lines changed
 

‎docs/Building-an-OpenSearch-and-OpenSearch-Dashboards-Distribution.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@ Manifests are the single source of truth for building and testing the distributi
1212

1313
### Building from Source
1414

15-
Input manifests are the source of building the distributions. Each input manifest also contains the docker image that can be used to build these distributions and avoid installing bunch of packages. See [CI image details](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/3.0.0/opensearch-3.0.0.yml#L8-L9) in the manifest.
15+
Input manifests are the source of building the distributions. Each input manifest also contains the docker image that can be used to build these distributions and avoid installing bunch of packages. See [CI image details](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/3.0.0/opensearch-3.0.0.yml#L8-L9) in the manifest along with java version used to build the distribution.
1616

1717
To run locally:
1818
```bash
19-
docker run -it -d --entrypoint bash opensearchstaging/ci-runner:ci-runner-centos7-opensearch-build-v2 -e JAVA_HOME=/opt/java/openjdk-20
19+
docker run -it --entrypoint bash opensearchstaging/ci-runner:ci-runner-al2-opensearch-build-v1
2020
```
21+
Once you are inside the container set JAVA_HOME as stated in the [manifest](https://github.com/opensearch-project/opensearch-build/blob/main/manifests/3.0.0-alpha1/opensearch-3.0.0-alpha1.yml#L10):
22+
```
23+
export JAVA_HOME=/opt/java/openjdk-21
24+
git clone https://github.com/opensearch-project/opensearch-build.git
25+
```
26+
2127
Then build from source:
2228

2329
```bash
@@ -67,7 +73,8 @@ OpenSearch is often released with changes in `opensearch-min`, and no changes to
6773

6874
#### CI/CD Environment
6975

70-
We use Jenkins as our CI/CD infrastructure to build, test and release OpenSearch and OpenSearch Dashboards. Access it [here](https://build.ci.opensearch.org/)
76+
We use Jenkins as our CI/CD infrastructure to build, test and release OpenSearch and OpenSearch Dashboards.
77+
[OpenSearch CI/CD system](https://build.ci.opensearch.org/) now requires authentication for readOnly access as well. Please proceed to login using your GitHub.
7178

7279
We build, assemble, and test our artifacts on docker containers. We provide docker files in [docker/ci](https://github.com/opensearch-project/opensearch-build/tree/main/docker/ci) folder, and images on [staging docker hub repositories](https://hub.docker.com/r/opensearchstaging/ci-runner/). All Jenkins pipelines can be found in [jenkins](https://github.com/opensearch-project/opensearch-build/tree/main/jenkins). The Jenkins is deployed using infrastructure as a Code and can be found in [opensearch-ci](https://github.com/opensearch-project/opensearch-ci) repository.
7380

‎docs/OpenSearch-Project-Build-System-Quick-Overview.md

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The **Standalone Component Release**, on the other hand, primarily utilizes GitH
2222

2323
This group consists of workflows that clone, build, assemble, and store OpenSearch/OpenSearch-Dashboards and its related plugin artifacts in one take.
2424

25+
__Note: [OpenSearch CI/CD system](https://build.ci.opensearch.org/) now requires authentication for readOnly access as well. Please proceed to login using your GitHub.__
26+
2527
##### **2.1.1.1 Check-for-build**
2628
The "[check-for-build](https://build.ci.opensearch.org/job/check-for-build/)" workflow is used to periodically check out the latest change in opensearch-project repositories and is usually set to trigger every 60 minutes. It compares the head commit of the given branch in all component repositories with the stored caches on the staging S3 bucket. If any discrepancies are identified, it would then trigger the build/assemble workflows, specifically the "[distribution-build-opensearch](https://build.ci.opensearch.org/job/distribution-build-opensearch/)" and "[distribution-build-opensearch-dashboards](https://build.ci.opensearch.org/job/distribution-build-opensearch-dashboards/)" workflows.
2729

‎docs/Releasing-the-Distribution.md

+2
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ These are the issues created by automation with the distribution build and integ
5858

5959
#### Build Workflows
6060

61+
__Note: [OpenSearch CI/CD system](https://build.ci.opensearch.org/) now requires authentication for readOnly access as well. Please proceed to login using your GitHub.__
62+
6163
| Workflow | Description |
6264
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------- |
6365
| [Check for Build](https://build.ci.opensearch.org/job/check-for-build/) | Workflow that periodically triggers the distribution workflows using parameterized cron. |

‎docs/Testing-the-Distribution.md

+2
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ The `build` workflow automates the process to generate all OpenSearch and OpenSe
151151

152152
### Integration tests
153153

154+
__Note: [OpenSearch CI/CD system](https://build.ci.opensearch.org/) now requires authentication for readOnly access as well. Please proceed to login using your GitHub account.__
155+
154156
The integration tests for OpenSearch are run via [integ-test](https://build.ci.opensearch.org/view/Test/job/integ-test/) job and for OpenSearch-Dashboards via [integ-test-opensearch-dashboards](https://build.ci.opensearch.org/view/Test/job/integ-test-opensearch-dashboards/) job. These jobs are mainly triggered via distribution build jobs after a distribution is created successfully. They are also triggered manually when required such as during releases or via cronjobs.
155157
The job reads the build artifact composition from the associated manifest files and spins up parallel, independent integrationTest runs for each component built inside the artifact. For instance, if the artifact is a full distribution, which has all OpenSearch plugins, the job will kick off integration test suite for each individual plugin. Each plugin is run on an independent cluster and in independent container. After the test runs are complete, a test-report is generated using [report-workflow](https://github.com/opensearch-project/opensearch-build/tree/main/src/report_workflow).
156158

0 commit comments

Comments
 (0)
Please sign in to comment.