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

[DOCS] Update Docker getting started for the Stack #1888

Conversation

lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented Nov 22, 2021

This PR replaces the steps for Running the Stack with Docker Compose with steps to start the Stack on Docker using auto-configured security.

Preview link: https://stack-docs_1888.docs-preview.app.elstc.co/guide/en/elastic-stack-get-started/master/get-started-stack-docker.html

A follow-up PR will address updating the steps for Running the Stack with Docker Compose.

Copy link
Contributor

@bytebilly bytebilly left a comment

Choose a reason for hiding this comment

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

@lockewritesdocs I left suggestions for improvements and I marked commands that fail if run as-is. Ping me if you need extra technical details.

docs/en/getting-started/get-started-docker.asciidoc Outdated Show resolved Hide resolved
docs/en/getting-started/get-started-docker.asciidoc Outdated Show resolved Hide resolved
docs/en/getting-started/get-started-docker.asciidoc Outdated Show resolved Hide resolved
docs/en/getting-started/get-started-docker.asciidoc Outdated Show resolved Hide resolved
docs/en/getting-started/get-started-docker.asciidoc Outdated Show resolved Hide resolved
@lockewritesdocs
Copy link
Contributor Author

@bytebilly -- I addressed your comments and made a few other improvements that I'll port to the other Docker docs. Let me know if additional changes are needed!

Copy link
Member

@jkakavas jkakavas left a comment

Choose a reason for hiding this comment

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

LGTM

you can use Docker Compose.
You can also <<get-started-docker-tls,start the {stack} with Docker Compose>> to
create a secured, multi-node cluster with a connected {kib} instance. This
option requires more manual steps, but results in a more resilient cluster with
Copy link
Member

Choose a reason for hiding this comment

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

we're trying to make it a single step too, so maybe we don't need defensive language here anymore ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll update this language in the subsequent PR that introduces the simplified Docker Compose configuration.

Comment on lines +131 to +145
[source,sh]
----
docker exec -it es-node01 /bin/bash -c "find /usr/share/elasticsearch -name http_ca.crt"
----

. Copy the `http_ca.crt` security certificate from your Docker container to
your local machine.
+
[source,sh]
----
docker cp es-node01:/usr/share/elasticsearch/config/tls_auto_config_<timestamp>/http_ca.crt .
----
`<timestamp>`:: The timestamp of when the auto-configuration process created
the security files directory in your Docker container.

Copy link
Member

Choose a reason for hiding this comment

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

we will update that as we remove the timestamp from the dirname, but I haven't had the time to do this change yet. I'll make sure I'll adjust docs as part of that change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We'll need to make that change across the docs where it's used, but will be an easy change.

@lockewritesdocs lockewritesdocs merged commit af89863 into elastic:main Dec 3, 2021
@lockewritesdocs lockewritesdocs deleted the docs__update-docker-getting-started branch December 3, 2021 14:09
lockewritesdocs pushed a commit to lockewritesdocs/stack-docs that referenced this pull request Dec 3, 2021
* [DOCS] Update Docker getting started for the Stack

* Adding redirect file

* Update reset password syntax

* Incorporating review feedback, adding response, updating commands, adding remove container section

* Update if statements for unreleased versions

* Fix typo

* Apply suggestions from code review

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

* More review feedback, plus some optimizations

* Create section for generating passwords and enrollment tokens

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
lockewritesdocs pushed a commit that referenced this pull request Dec 3, 2021
* [DOCS] Update Docker getting started for the Stack

* Adding redirect file

* Update reset password syntax

* Incorporating review feedback, adding response, updating commands, adding remove container section

* Update if statements for unreleased versions

* Fix typo

* Apply suggestions from code review

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

* More review feedback, plus some optimizations

* Create section for generating passwords and enrollment tokens

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>

Co-authored-by: Ioannis Kakavas <ikakavas@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants