Remove admin:admin default and update instructions for demo setup #5887

derek-ho · 2023-12-15T16:38:57Z

Description

Starting with the 2.12 release, admin will no longer be set as the default password when running the install demo configuration script. Instead, it will require user input (via an environment variable) to set the initial admin password, otherwise the script will fail. This PR updates the documentation to remove references of admin:admin, as well as updates some instructions on how to set this variable for the different distributions.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].
Related to #5946

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.

Signed-off-by: Derek Ho <dxho@amazon.com>

derek-ho · 2023-12-15T16:41:58Z

@prudhvigodithi / @rishabh6788 / @DarshitChanpura adding you folks as tech reviewers, especially on the install files to double check that this is feasible/makes sense

DarshitChanpura

We should also Docker and Helm documentation. This can also be done in a follow-up PR that address the changes made to demo configuration.

DarshitChanpura · 2023-12-15T16:41:25Z

_install-and-configure/install-opensearch/debian.md

@@ -40,10 +40,10 @@ This guide assumes that you are comfortable working from the Linux command line
 1. From the CLI, install using `dpkg`.
   ```bash
   # x64
-   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=< Admin password > dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb


we should add a comment about why this password is required.

This applies to all updated distributions

DarshitChanpura · 2023-12-15T16:43:21Z

_install-and-configure/install-opensearch/tar.md

+   export OPENSEARCH_INITIAL_ADMIN_PASSWORD=< Admin password >
+   ```
+   {% include copy.html %}
+
 1. Run the OpenSearch startup script with the security demo configuration.


this step should be numbered as 2

All of them are 1

This is correct, I believe the numbers are handled on the website side.

DarshitChanpura · 2023-12-15T16:43:41Z

_install-and-configure/install-opensearch/windows.md

+         set OPENSEARCH_INITIAL_ADMIN_PASSWORD=< Admin password >
+         ```
+         {% include copy.html %}
+
      1. Run the batch script.


this step should be numbered as 2

All of them are numbered as 1

Markdown automatically will number these in sequence. So if you put "1. 1. 1.", the output will be "1. 2. 3"

Signed-off-by: Derek Ho <dxho@amazon.com>

stephen-crawford

A couple small comments but this seems good to me!

stephen-crawford · 2023-12-18T16:58:09Z

_install-and-configure/install-opensearch/debian.md


   # arm64
-   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=< Admin password> dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb


Missing trailing space inside ">".

stephen-crawford · 2023-12-18T17:06:16Z

_api-reference/tasks.md

@@ -267,7 +267,7 @@ To associate requests with tasks for better tracking, you can provide a `X-Opaqu
 Usage:

 ```bash
-curl -i -H "X-Opaque-Id: 111111" "https://localhost:9200/_tasks" -u 'admin:admin' --insecure
+curl -i -H "X-Opaque-Id: 111111" "https://localhost:9200/_tasks" -u 'admin:< Admin password >' --insecure


You will want to ask @kolchfa-aws etc. about the style guidelines for these placeholders. I am not sure whether leading/trailing spaces should be trimmed or whether underscores should be used instead of spaces in between the terms.

Sorry for the late reply, just saw this. Generally we don't use spaces within angular brackets and separate the words with a hyphen or underscore so <custom-admin-password> looks good to me.

stephen-crawford · 2023-12-18T17:08:25Z

_install-and-configure/install-opensearch/helm.md

+
+   ```yml
+   - name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
+#    value: < Admin password >


Is this meant to be commented out?

stephen-crawford · 2023-12-18T17:09:16Z

_install-and-configure/install-opensearch/tar.md

+   export OPENSEARCH_INITIAL_ADMIN_PASSWORD=< Admin password >
+   ```
+   {% include copy.html %}
+
 1. Run the OpenSearch startup script with the security demo configuration.


This is correct, I believe the numbers are handled on the website side.

hdhalter · 2023-12-21T22:19:23Z

@derek-ho , @scrawfor99 - I'll add the 2.12 label for now because you said "and likely to be backported to 2.12 release". We'll check in with you to confirm before 2.12 is released. Thanks!

derek-ho · 2023-12-27T21:28:17Z

@hdhalter yes this is planned for 2.12.0 release. Can we get a tech/doc review for these changes to ensure that we have supporting documentation released in the 2.12.0 release? Thanks!

hdhalter · 2023-12-27T22:18:19Z

@hdhalter yes this is planned for 2.12.0 release. Can we get a tech/doc review for these changes to ensure that we have supporting documentation released in the 2.12.0 release? Thanks!

Thanks, @derek-ho. @Naarcha-AWS is assigned to do the doc review.

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

_about/quickstart.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

natebower

@Naarcha-AWS Please see my comments and changes and tag me when complete. I'd like to reread line 114 in the first file before approving. Thanks!

_about/quickstart.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_about/quickstart.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

natebower

LGTM

hdhalter · 2024-01-25T20:48:29Z

@DarshitChanpura - Do we need to modify step 6? It says to enter admin/admin: https://opensearch.org/docs/latest/security/authentication-backends/saml/#docker-example.

DarshitChanpura · 2024-01-29T16:43:26Z

@DarshitChanpura - Do we need to modify step 6? It says to enter admin/admin: https://opensearch.org/docs/latest/security/authentication-backends/saml/#docker-example.

Ahh..great catch. We can modify this, but then we will also need to modify the steps above to point to 2.12 instead of 2.8. if we plan to leave it as 2.8 we should leave it as admin.

hdhalter · 2024-01-29T17:43:45Z

@DarshitChanpura - Do we need to modify step 6? It says to enter admin/admin: https://opensearch.org/docs/latest/security/authentication-backends/saml/#docker-example.

Ahh..great catch. We can modify this, but then we will also need to modify the steps above to point to 2.12 instead of 2.8. if we plan to leave it as 2.8 we should leave it as admin.

Let's update. We can add a variable for the version, and "<admin user name/password>" will still apply to all versions. @Naarcha-AWS - can you update this? Thanks.

Naarcha-AWS · 2024-01-29T18:14:24Z

@DarshitChanpura - Do we need to modify step 6? It says to enter admin/admin: https://opensearch.org/docs/latest/security/authentication-backends/saml/#docker-example.

Ahh..great catch. We can modify this, but then we will also need to modify the steps above to point to 2.12 instead of 2.8. if we plan to leave it as 2.8 we should leave it as admin.

Let's update. We can add a variable for the version, and "<admin user name/password>" will still apply to all versions. @Naarcha-AWS - can you update this? Thanks.

Made this change in a separate PR: #6279

Update some admin:admin references

92e9f22

Signed-off-by: Derek Ho <dxho@amazon.com>

derek-ho requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, ananzh, AMoo-Miki and natebower as code owners December 15, 2023 16:38

derek-ho marked this pull request as draft December 15, 2023 16:39

DarshitChanpura mentioned this pull request Dec 15, 2023

[META] Update all instances of admin:admin across different repositories opensearch-project/security#3624

Closed

2 tasks

derek-ho requested review from rishabh6788, prudhvigodithi and DarshitChanpura December 15, 2023 16:42

DarshitChanpura reviewed Dec 15, 2023

View reviewed changes

derek-ho added 2 commits December 15, 2023 12:28

Update all references except for helm

2c05e39

Signed-off-by: Derek Ho <dxho@amazon.com>

Update helm

d4d1551

Signed-off-by: Derek Ho <dxho@amazon.com>

derek-ho marked this pull request as ready for review December 18, 2023 15:25

stephen-crawford reviewed Dec 18, 2023

View reviewed changes

hdhalter added the 4 - Doc review PR: Doc review in progress label Dec 18, 2023

hdhalter assigned Naarcha-AWS Dec 19, 2023

hdhalter added the v2.12.0 label Dec 21, 2023

hdhalter added this to the v2.12 milestone Dec 21, 2023

hdhalter mentioned this pull request Dec 26, 2023

[v2.12.0] Ensure CI/documentation reflect changes to default admin credentials #5946

Closed

2 tasks

hdhalter mentioned this pull request Jan 8, 2024

Adds documentation for security demo configuration setup #6058

Merged

1 task

DarshitChanpura added 2 commits January 8, 2024 15:58

Reverts changes made to _install-and-configure folder

7606020

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Merge branch 'main' into admin

18c4dbb

DarshitChanpura requested a review from Naarcha-AWS January 16, 2024 20:46

DarshitChanpura added 3 commits January 17, 2024 10:52

Merge branch 'main' into admin

9af6b27

Merge branch 'main' into admin

56497be

Merge branch 'main' into admin

a6b2b9e

Naarcha-AWS reviewed Jan 23, 2024

View reviewed changes

_about/quickstart.md Outdated Show resolved Hide resolved

Naarcha-AWS and others added 2 commits January 23, 2024 10:08

Update _about/quickstart.md

2165d52

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Merge branch 'main' into admin

14baf92

natebower requested changes Jan 23, 2024

View reviewed changes

_about/quickstart.md Outdated Show resolved Hide resolved

_about/quickstart.md Outdated Show resolved Hide resolved

_about/quickstart.md Outdated Show resolved Hide resolved

_about/quickstart.md Outdated Show resolved Hide resolved

Apply suggestions from code review

be5762d

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS reviewed Jan 23, 2024

View reviewed changes

_about/quickstart.md Outdated Show resolved Hide resolved

Update quickstart.md

e0f1c21

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS added 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 5 - Editorial review PR: Editorial review in progress labels Jan 23, 2024

natebower approved these changes Jan 24, 2024

View reviewed changes

Merge branch 'main' into admin

5902f2e

Merge branch 'main' into admin

5a10f61

Naarcha-AWS mentioned this pull request Jan 29, 2024

Update SAML tutorial with new default Admin settings #6279

Merged

1 task

hdhalter added the release-notes PR: Include this PR in the automated release notes label Jan 29, 2024

DarshitChanpura added 5 commits January 29, 2024 13:17

Merge branch 'main' into admin

24b46c4

Merge branch 'main' into admin

1acb1c1

Merge branch 'main' into admin

7ed50ca

Merge branch 'main' into admin

cc1b44f

Merge branch 'main' into admin

fcbc313

hdhalter merged commit 6af6650 into opensearch-project:main Feb 1, 2024
3 checks passed

hdhalter added 3 - Done Issue is done/complete and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Feb 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove admin:admin default and update instructions for demo setup #5887

Remove admin:admin default and update instructions for demo setup #5887

derek-ho commented Dec 15, 2023 •

edited by hdhalter

Loading

derek-ho commented Dec 15, 2023 •

edited

Loading

DarshitChanpura left a comment

DarshitChanpura Dec 15, 2023

DarshitChanpura Dec 15, 2023

DarshitChanpura Dec 15, 2023

derek-ho Dec 15, 2023

stephen-crawford Dec 18, 2023

DarshitChanpura Dec 15, 2023

derek-ho Dec 15, 2023

kolchfa-aws Jan 18, 2024

stephen-crawford left a comment

stephen-crawford Dec 18, 2023

stephen-crawford Dec 18, 2023

kolchfa-aws Jan 18, 2024

stephen-crawford Dec 18, 2023

stephen-crawford Dec 18, 2023

hdhalter commented Dec 21, 2023

derek-ho commented Dec 27, 2023

hdhalter commented Dec 27, 2023

natebower left a comment

natebower left a comment

hdhalter commented Jan 25, 2024

DarshitChanpura commented Jan 29, 2024 •

edited

Loading

hdhalter commented Jan 29, 2024 •

edited

Loading

Naarcha-AWS commented Jan 29, 2024

Remove admin:admin default and update instructions for demo setup #5887

Remove admin:admin default and update instructions for demo setup #5887

Conversation

derek-ho commented Dec 15, 2023 • edited by hdhalter Loading

Description

Issues Resolved

Checklist

derek-ho commented Dec 15, 2023 • edited Loading

DarshitChanpura left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephen-crawford left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdhalter commented Dec 21, 2023

derek-ho commented Dec 27, 2023

hdhalter commented Dec 27, 2023

natebower left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

hdhalter commented Jan 25, 2024

DarshitChanpura commented Jan 29, 2024 • edited Loading

hdhalter commented Jan 29, 2024 • edited Loading

Naarcha-AWS commented Jan 29, 2024

derek-ho commented Dec 15, 2023 •

edited by hdhalter

Loading

derek-ho commented Dec 15, 2023 •

edited

Loading

DarshitChanpura commented Jan 29, 2024 •

edited

Loading

hdhalter commented Jan 29, 2024 •

edited

Loading