Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change stack dependency and update readme #149

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions nightly-playground/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenSearch Nightly Playground

This project is an extension of [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk) that deploys nightly built artifacts daily. The source code concentrates on taking care of regular deployments, permissions, access, etc. For more customization, please feel free to directly use [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk).
This project is an extension of [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk). It deploys nightly built artifacts daily. The source code concentrates on taking care of regular deployments, non-default permissions, access, etc. For more customization, please feel free to directly use [opensearch-cluster-cdk](https://github.com/opensearch-project/opensearch-cluster-cdk).

## Getting Started

Expand All @@ -14,14 +14,15 @@ This project is an extension of [opensearch-cluster-cdk](https://github.com/open

In order to deploy the stack the user needs to provide a set of required parameters listed below:

| Name | Requirement | Type | Description |
|-------------------------------|:------------|:------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| distVersion | Required | string | The OpenSearch distribution version (released/un-released) the user wants to deploy |
| distributionUrl | Required | string | OpenSearch tarball distribution URL plugin |
| dashboardsUrl | Required | string | OpenSearch-Dashboards tarball distribution URL version |
| Name | Requirement | Type | Description |
|-------------------------------|:------------|:----------|:------------|
| distVersion | Required | string | The OpenSearch distribution version (released/un-released) the user wants to deploy |
| distributionUrl | Required | string | OpenSearch tarball distribution URL plugin |
| dashboardsUrl | Required | string | OpenSearch-Dashboards tarball distribution URL version |
| dashboardPassword | Required | string | OpenSearch-Dashboards password for kibanaserver user |

#### Sample command to set up multi-node cluster with security enabled
#### Sample command to set up nightly playground cluster

```
npm run cdk deploy "*" -- -c distVersion=2.3.0 -c distributionUrl=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/2.3.0/latest/linux/x64/tar/dist/opensearch/opensearch-2.3.0-linux-x64.tar.gz -c dashboardsUrl=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch-dashboards/2.3.0/latest/linux/x64/tar/dist/opensearch-dashboards/opensearch-dashboards-2.3.0-linux-x64.tar.gz
npm run cdk deploy "*" -- -c distVersion=2.3.0 -c distributionUrl=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/2.3.0/latest/linux/x64/tar/dist/opensearch/opensearch-2.3.0-linux-x64.tar.gz -c dashboardsUrl=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch-dashboards/2.3.0/latest/linux/x64/tar/dist/opensearch-dashboards/opensearch-dashboards-2.3.0-linux-x64.tar.gz -c dashboardPassword=fooBar
```
3 changes: 1 addition & 2 deletions nightly-playground/lib/nightly-playground-stack.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ export class NightlyPlaygroundStack {
});

this.stacks.push(networkStack);
networkStack.addDependency(commonToolsStack);

// @ts-ignore
const infraStack = new InfraStack(scope, `infraStack-${id}`, {
...props,
Expand All @@ -77,5 +75,6 @@ export class NightlyPlaygroundStack {
this.stacks.push(infraStack);

infraStack.addDependency(networkStack);
infraStack.addDependency(commonToolsStack);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means commonsStack needs to be ready before infra stack is deployed

}
}
Loading