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

Update docker.md #6519

Merged
merged 6 commits into from
Mar 1, 2024
Merged

Update docker.md #6519

merged 6 commits into from
Mar 1, 2024

Conversation

pawelw1
Copy link
Contributor

@pawelw1 pawelw1 commented Feb 26, 2024

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch node for version 2.12.0.

Description

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch nodes in example docker-compose.yml file for version 2.12.0.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch node for version 2.12.0.

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>
@hdhalter
Copy link
Contributor

@derek-ho or @peterzhuamazon - Can you please approve this from a technical standpoint? Thanks!

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress backport 2.12 PR: Backport label for 2.12 labels Feb 27, 2024
@@ -170,6 +170,7 @@ services:
- cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2 # Nodes eligible to serve as cluster manager
- bootstrap.memory_lock=true # Disable JVM heap memory swapping
- "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" # Set min and max JVM heap sizes to at least 50% of system RAM
- OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_INITIAL_ADMIN_PASSWORD} # Sets the demo admin user password when using demo configuration, required for OpenSearch 2.12 and higher
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks good to me, but I think we may want to call out whether this is set here, or whether this env variable is present from outside or an .env file. Tagging @DarshitChanpura @peterzhuamazon to leave their comments here as well.

Copy link
Member

Choose a reason for hiding this comment

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

we should add a note on line 157 stating the requirement to either define the variable in a .env and exporting it in the same terminal session where docker-compose is run from.

Copy link
Member

@DarshitChanpura DarshitChanpura Feb 27, 2024

Choose a reason for hiding this comment

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

Also, I have a companion PR to update the download steps for docker: opensearch-project/project-website#2526

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Mar 1, 2024
hdhalter and others added 2 commits March 1, 2024 08:18
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

One last change then LGTM.

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
@hdhalter hdhalter merged commit 083496a into opensearch-project:main Mar 1, 2024
3 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 1, 2024
* Update docker.md

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch node for version 2.12.0.

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>

* Added note about 2.12

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update docker.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
(cherry picked from commit 083496a)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
hdhalter added a commit that referenced this pull request Mar 1, 2024
* Update docker.md

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch node for version 2.12.0.



* Added note about 2.12



* Update _install-and-configure/install-opensearch/docker.md



* Update _install-and-configure/install-opensearch/docker.md




* Update docker.md



* Update _install-and-configure/install-opensearch/docker.md




---------





(cherry picked from commit 083496a)

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
oeyh pushed a commit to oeyh/documentation-website that referenced this pull request Mar 14, 2024
* Update docker.md

Adding OPENSEARCH_INITIAL_ADMIN_PASSWORD variable to OpenSearch node for version 2.12.0.

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>

* Added note about 2.12

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update docker.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _install-and-configure/install-opensearch/docker.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

---------

Signed-off-by: Pawel Wlodarczyk <pawel.wlodarczyk@eliatra.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4 - Doc review PR: Doc review in progress backport 2.12 PR: Backport label for 2.12
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants