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 download steps to adapt to changes to admin password #2526

Merged
merged 8 commits into from
Feb 27, 2024
Merged

Updates docker download steps to adapt to changes to admin password #2526

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7a24c3c
Updates docker download steps to adapt to changes to admin password
DarshitChanpura Jan 5, 2024
7a2779e
Updates sample docker compose file to accept a new environment variable
DarshitChanpura Jan 8, 2024
16ef0c3
Updates note text
DarshitChanpura Jan 8, 2024
077d55f
Updates step 6
DarshitChanpura Jan 17, 2024
f27a111
Merge remote-tracking branch 'upstream/main' into update-docker-setup…
DarshitChanpura Feb 16, 2024
727118b
Address PR feedback
DarshitChanpura Feb 16, 2024
d22e63c
Address more feedback
DarshitChanpura Feb 17, 2024
06503e9
Merge remote-tracking branch 'upstream/main' into update-docker-setup…
DarshitChanpura Feb 21, 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: 3 additions & 1 deletion _includes/downloads/opensearch-docker.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ The best way to try out OpenSearch is to use [Docker Compose](https://docs.docke
- **macOS & Windows**: In Docker _Preferences_ > _Resources_, set RAM to at least 4 GB.
- **Linux**: Ensure `vm.max_map_count` is set to at least 262144 as per the [documentation](/docs/opensearch/install/important-settings/).
2. Download [docker-compose.yml](/samples/docker-compose.yml) into your desired directory
- **Note for OpenSearch 2.12 and Higher:**
DarshitChanpura marked this conversation as resolved.
Show resolved Hide resolved
When setting up the security demo configuration, set the initial admin password using the `OPENSEARCH_INITIAL_ADMIN_PASSWORD` environment variable. Create a `.env` file in the same folder as your `docker-compose.yml` and add the variable to `.env` file. Set the value to `OPENSEARCH_INITIAL_ADMIN_PASSWORD` variable to a strong admin password. This configuration will be automatically utilized during the setup process.
DarshitChanpura marked this conversation as resolved.
Show resolved Hide resolved
3. Run `docker-compose up`
4. Have a nice coffee while everything is downloading and starting up
5. Navigate to [http://localhost:5601/](http://localhost:5601) for OpenSearch Dashboards
6. Login with the default username (`admin`) and password (`admin`)
6. Login with the default username (`admin`) and password (`<custom-admin-password>`)
2 changes: 2 additions & 0 deletions samples/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,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
ulimits:
memlock:
soft: -1
Expand All @@ -36,6 +37,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}
ulimits:
memlock:
soft: -1
Expand Down
Loading