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.

Sign up for GitHub

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

Updates Docker and windows distribution build files to reflect to changes in admin user setup #4274

Merged
merged 12 commits into from
Jan 19, 2024
Merged

Updates Docker and windows distribution build files to reflect to changes in admin user setup #4274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
278aa72
Updates docker and windows distribution to reflect changes with admin…
DarshitChanpura Dec 8, 2023
1f7eb92
Updates info log
DarshitChanpura Dec 8, 2023
db0447f
Updates the info message to reflect env variable name change
DarshitChanpura Dec 13, 2023
c4653ef
Merge remote-tracking branch 'upstream/main' into docker-win-update
DarshitChanpura Dec 13, 2023
5333171
Corrects info logs
DarshitChanpura Dec 14, 2023
6813935
Captializes security plugin name in info logs
DarshitChanpura Dec 14, 2023
e59d8fc
Updates sample docker compose files to accept admin password as envir…
DarshitChanpura Jan 4, 2024
44f6832
Fixes too few spaces error
DarshitChanpura Jan 4, 2024
c504889
Merge remote-tracking branch 'upstream/main' into docker-win-update
DarshitChanpura Jan 11, 2024
85ef16c
Updates multiple echos with a single printf
DarshitChanpura Jan 11, 2024
583d580
Change to echo -e
DarshitChanpura Jan 16, 2024
4a34e4e
Updates comment in docker compose files
DarshitChanpura Jan 18, 2024
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
4 changes: 2 additions & 2 deletions docker/release/config/opensearch/opensearch-docker-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ function setupSecurityPlugin {
if [ "$DISABLE_INSTALL_DEMO_CONFIG" = "true" ]; then
echo "Disabling execution of install_demo_configuration.sh for OpenSearch Security Plugin"
else
echo "Enabling execution of install_demo_configuration.sh for OpenSearch Security Plugin"
bash $OPENSEARCH_HOME/plugins/$SECURITY_PLUGIN/tools/install_demo_configuration.sh -y -i -s
echo -e "Enabling execution of install_demo_configuration.sh for OpenSearch Security Plugin \nOpenSearch 2.12.0 onwards, the OpenSearch Security Plugin a change that requires an initial password for 'admin' user. \nPlease define an environment variable 'OPENSEARCH_INITIAL_ADMIN_PASSWORD' with a strong password string. \nIf a password is not provided, the setup will quit."
bash $OPENSEARCH_HOME/plugins/$SECURITY_PLUGIN/tools/install_demo_configuration.sh -y -i -s || exit 1
peterzhuamazon marked this conversation as resolved.
Show resolved Hide resolved
fi

if [ "$DISABLE_SECURITY_PLUGIN" = "true" ]; then
Expand Down
2 changes: 2 additions & 0 deletions docker/release/dockercomposefiles/docker-compose-2.x.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ services:
- cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
- bootstrap.memory_lock=true # along with the memlock settings below, disables swapping
- OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m # minimum and maximum Java heap size, recommend setting both to 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
ulimits:
memlock:
soft: -1
Expand All @@ -35,6 +36,7 @@ services:
- cluster.initial_cluster_manager_nodes=opensearch-node1,opensearch-node2
- bootstrap.memory_lock=true
- OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m
- OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_INITIAL_ADMIN_PASSWORD}
Copy link
Member Author

Choose a reason for hiding this comment

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

these changes the default docker-compose files for 2.x line to now include an additional env variable (to be passed by user) to set the admin password.

This will be accompanied by the change in download instructions on the project-website (file to change) to reflect the new requirement as an additional step.

Copy link
Member

Choose a reason for hiding this comment

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

We need to add a comment for this line, so that people knows it is only for 2.12.0 and up.
Also, the documentation and the download page needs to be tweaked with the same changes as well.

https://opensearch.org/docs/2.11/install-and-configure/install-opensearch/docker/
https://opensearch.org/downloads.html

Copy link
Member

Choose a reason for hiding this comment

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

Hey @DarshitChanpura please take a look at 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.

I added it above, and following the convention, I didn't add it second time as no other settings that have comments on the first one have comments here.

Copy link
Member Author

Choose a reason for hiding this comment

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

@prudhvigodithi @peterzhuamazon ^^

Copy link
Member Author

Choose a reason for hiding this comment

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

I have updated the comment to mention that it is required for 2.12 and higher

ulimits:
memlock:
soft: -1
Expand Down
4 changes: 2 additions & 2 deletions scripts/opensearch-onetime-setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ if [ -d "$OPENSEARCH_HOME/plugins/$SECURITY_PLUGIN" ]; then
if [ "$DISABLE_INSTALL_DEMO_CONFIG" = "true" ]; then
echo "Disabling execution of install_demo_configuration.sh for OpenSearch Security Plugin"
else
echo "Enabling execution of install_demo_configuration.sh for OpenSearch Security Plugin"
bash $OPENSEARCH_HOME/plugins/$SECURITY_PLUGIN/tools/install_demo_configuration.sh -y -i -s
echo -e "Enabling execution of install_demo_configuration.sh for OpenSearch Security Plugin \nOpenSearch 2.12.0 onwards, the OpenSearch Security Plugin a change that requires an initial password for 'admin' user. \nPlease define an environment variable 'OPENSEARCH_INITIAL_ADMIN_PASSWORD' with a strong password string. \nIf a password is not provided, the setup will quit."
bash $OPENSEARCH_HOME/plugins/$SECURITY_PLUGIN/tools/install_demo_configuration.sh -y -i -s || exit 1
DarshitChanpura marked this conversation as resolved.
Show resolved Hide resolved
fi

if [ "$DISABLE_SECURITY_PLUGIN" = "true" ]; then
Expand Down
5 changes: 4 additions & 1 deletion scripts/startup/zip/windows/opensearch-windows-install.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ ECHO "OPENSEARCH_PATH_CONF: %OPENSEARCH_PATH_CONF%"
:: Security Plugin Setups
IF EXIST "%OPENSEARCH_HOME%\plugins\opensearch-security" (
ECHO "Running Security Plugin Install Demo Configuration"
CALL "%OPENSEARCH_HOME%/plugins/opensearch-security/tools/install_demo_configuration.bat" -y -i -s
ECHO "OpenSearch 2.12.0 onwards, the OpenSearch Security Plugin a change that requires an initial password for 'admin' user."
ECHO "Please define an environment variable 'OPENSEARCH_INITIAL_ADMIN_PASSWORD' with a strong password string."
ECHO "If a password is not provided, the setup will quit."
CALL "%OPENSEARCH_HOME%\plugins\opensearch-security\tools\install_demo_configuration.bat" -y -i -s || exit /b 1
DarshitChanpura marked this conversation as resolved.
Show resolved Hide resolved
)

:: k-NN Plugin Setups
Expand Down
Loading