Skip to content

Commit

Permalink
Add blog announcing nightly playgrounds launch
Browse files Browse the repository at this point in the history 
Signed-off-by: Sayali Gaikawad <[email protected]>
  • Loading branch information
@gaiksaya
gaiksaya committed Oct 21, 2024
1 parent 2e1cc63 commit b27aea5
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 1 deletion.
2 changes: 1 addition & 1 deletion _community_members/sayaligaikawad.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ conference_id:
redirect_from: '/authors/sayaligaikawad/'
---

I am a software development engineer at OpenSearch (Amazon). I work with Engineering Effectiveness team at OpenSearch that concentrates on release processes, build and test tools, and re-usable infrastructure for the OpenSearch project making life of developers a little bit easier.
Sayali Gaikawad is a software development engineer at OpenSearch Project at Amazon. She works with Engineering Effectiveness team at OpenSearch that concentrates on release processes, build and test tools, and re-usable infrastructure for the OpenSearch project making the life of developers a little bit easier.

Check failure on line 32 in _community_members/sayaligaikawad.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Sayali. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Sayali. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_community_members/sayaligaikawad.md", "range": {"start": {"line": 32, "column": 1}}}, "severity": "ERROR"}

Check failure on line 32 in _community_members/sayaligaikawad.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Gaikawad. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Gaikawad. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_community_members/sayaligaikawad.md", "range": {"start": {"line": 32, "column": 8}}}, "severity": "ERROR"}

69 changes: 69 additions & 0 deletions _posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
layout: post
title: Introducing the Nightly Playgrounds
authors:
- sayaligaikawad
date: 2024-10-21
categories:
- technical-posts
excerpt:
meta_keywords:
meta_description:
---

We are pleased to announce the launch of [Nightly Playgrounds](https://playground.nightly.opensearch.org/). This environment provides a dynamic preview of your work within a fully deployed distribution cluster for the upcoming versions of OpenSearch and OpenSearch Dashboards. As the name suggest, this live demo environment hosts clusters deployed using the latest successful and validated nightly build artifacts of both OpenSearch and OpenSearch Dashboards. The [OpenSearch](https://build.ci.opensearch.org/view/Build/job/distribution-build-opensearch/) and [OpenSearch Dashboards](https://build.ci.opensearch.org/view/Build/job/distribution-build-opensearch-dashboards/) distributions are built daily that includes actively developed features for upcoming 2.x and 3.0 version.


### What can you do in Nightly Playground environment?

Similar to current [playground](https://playground.opensearch.org/app/home), every user has anonymous, read-only access, allowing you to try new features and explore preconfigured sample data. You can interact with sample dashboards, data visualizations, and data sources without installing and configuring OpenSearch or OpenSearch Dashboards in your own environment. In order to enhance the permissions in future, the nightly playgrounds are integrated with GitHub as an OpenID Connect.


### High Level Architecture Diagram:

Nightly playground environments are provisioned utilizing daily-built x64 Linux tarballs of OpenSearch and OpenSearch Dashboards on AWS EC2 instances, orchestrated through the AWS Cloud Development Kit (CDK). The deployment process is facilitated by GitHub Actions, ensuring seamless integration with cloud infrastructure. In addition to the default configurations, the security settings have been meticulously tailored to enable GitHub as an OpenID Connect (OIDC) provider. The nightly playgrounds use [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk) as the upstream dependency to deploy the highly customizable cluster.

![High-Level-Architecture-Diagram](/assets/media/blog-images/2024-10-21-Introducing-the-nightly-playgrounds/nightly_playground.png){:class="img-centered"}

### Frequently Asked Questions

* **Where can we access the nightly playgrounds?**
Nightly playgrounds can be accessed at https://playground.nightly.opensearch.org/. You can select the version you wish to explore, with current support for the upcoming 2.x and 3.0 releases.



* **Which commit was used to build this distribution that is current deployed?**
Every user by default has the read-only access to these clusters. The entire distribution manifest containing details such as component name, repository, GitHub reference and commit_id is indexed in the cluster as a part of the automation. Simply go to the `dev-tools` and run the below query:

Check failure on line 36 in _posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: commit_id. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: commit_id. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown", "range": {"start": {"line": 36, "column": 180}}}, "severity": "ERROR"}

For OpenSearch components’ details:

```
GET opensearch/_doc/1
```

For OpenSearch Dashboards components' details:

```
GET opensearch-dashboards/_doc/1
```

This will give you components present in the deployed cluster along with the commit_id and the artifact location.

Check failure on line 50 in _posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: commit_id. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: commit_id. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown", "range": {"start": {"line": 50, "column": 78}}}, "severity": "ERROR"}

* **Why are certain components/plugins missing from the cluster/distribution?**
If a component is absent from the distribution, it indicates that it failed to build during the distribution process. However, the nightly builds will continue even if a component encounters an error. This ensures that the overall build process remains unaffected by individual component failures, allowing for uninterrupted progress. Please visit the corresponding component repository and search for build failure autocut issues. Example: https://github.com/opensearch-project/security-analytics/issues/904

Check failure on line 53 in _posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: autocut. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: autocut. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown", "range": {"start": {"line": 53, "column": 421}}}, "severity": "ERROR"}

Check failure on line 53 in _posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'GitHub' instead of 'github'.

Raw Output:
{"message": "[Vale.Terms] Use 'GitHub' instead of 'github'.", "location": {"path": "_posts/2024-10-21-Introducing-the-nightly-playgrounds.markdown", "range": {"start": {"line": 53, "column": 454}}}, "severity": "ERROR"}

* **What if we need more data indexed into these cluster?**
Please feel free to create a GitHub [issue](https://github.com/opensearch-project/opensearch-devops/issues) or pull request with the required data that you need in these clusters. The maintainers will review the data for security and sensitive information and help it index into the cluster.



* **What if we need more permissions to test different features on these clusters?**
We recently integrated nightly playgrounds with GitHub as an OIDC. As of now, all logged in users have read-only access to the cluster. We plan to enhance these permissions using their GitHub handles in future. Please create a GitHub [issue](https://github.com/opensearch-project/opensearch-devops/issues) to request required permissions along with your GitHub handle.


### Wrapping it up!

The primary motivation of this project is to facilitate experimentation with new and forthcoming features, gather early feedback and allow users to witness enhancements in real-time as they are integrated into the distribution. One of the future objectives for the nightly playgrounds is to utilize them during release cycles to facilitate efficient debugging of the release candidates.
Check out the reproducible infrastructure as a code in [GitHub](https://github.com/opensearch-project/opensearch-devops/tree/main/nightly-playground). More details can be found in the meta [issue](https://github.com/opensearch-project/opensearch-devops/issues/129).
Please feel free to provide us feedback, request features and contribute to make nightly playgrounds better.

Binary file added ...og-images/2024-10-21-Introducing-the-nightly-playgrounds/nightly_playground.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b27aea5

Please sign in to comment.