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

Mention bind-mounting plugins dir in Docker docs #82622

Merged

Conversation

pugnascotia
Copy link
Contributor

Closes #69533.

The Docker docs mention bind-mounting the config, data and logs directories when using an arbitrary UID / GID, but they fail to mention that the plugins dir must also be mounted in order to install plugins.

@pugnascotia pugnascotia added >docs General docs changes :Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts v8.0.0 v8.1.0 labels Jan 14, 2022
@elasticmachine elasticmachine added Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team labels Jan 14, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@mark-vieira mark-vieira left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, Rory.

@pugnascotia pugnascotia requested a review from jrodewig January 24, 2022 10:25
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. I left some suggestions and comments, but none of those are blocking.

docs/reference/setup/install/docker.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/install/docker.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/install/docker.asciidoc Outdated Show resolved Hide resolved
docs/reference/setup/install/docker.asciidoc Outdated Show resolved Hide resolved
Comment on lines 435 to 438
* Alternatively, you must bind-mound the `config`, `data` and `logs`
directories. You must also bind-mount the `plugins` directory if you
intend to install plugins and prefer not to <<_c_customized_image, create a
custom Docker image>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we move the bind-mounting bullet first? I imagine most admins are using Docker compose in production so I'm not sure if we want to highlight the docker run option first.

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'm honestly not sure which option an admin would prefer, but I do suspect that people following the guide to get something up-and-running would be better off using the bind-mounts, so I've swapped the options.

Copy link
Contributor

Choose a reason for hiding this comment

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

I imagine most admins are using Docker compose in production so I'm not sure if we want to highlight the docker run option first.

FWIW, I don't think folks using our Docker images in production are using either of these options. They are likely using Kubernetes or some other orchestrator or config as code mechanism to deploy. That's just my intuition though.

@pugnascotia pugnascotia merged commit 997880f into elastic:master Jan 24, 2022
@pugnascotia
Copy link
Contributor Author

Thanks @jrodewig!

pugnascotia added a commit that referenced this pull request Jan 24, 2022
Closes #69533.

The Docker docs mention bind-mounting the `config`, `data` and
`logs` directories when using an arbitrary UID / GID, but they fail
to mention that the `plugins` dir must also be mounted in order to
install plugins.
pugnascotia added a commit that referenced this pull request Jan 24, 2022
Closes #69533.

The Docker docs mention bind-mounting the `config`, `data` and
`logs` directories when using an arbitrary UID / GID, but they fail
to mention that the `plugins` dir must also be mounted in order to
install plugins.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts >docs General docs changes Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team v8.0.0 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Verify Elasticsearch Docker container writes on plugin installation
4 participants