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

Remove initContainer section in Logstash plugin docs #7557

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Remove initContainer section in Logstash plugin docs #7557

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bafaaf
Fix plugin docs
robbavey Feb 9, 2024
313de9e
Update docs/orchestrating-elastic-stack-applications/logstash.asciidoc
thbkrkr Feb 14, 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
33 changes: 3 additions & 30 deletions docs/orchestrating-elastic-stack-applications/logstash.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,43 +1054,16 @@ spec:

experimental[]

When running {ls} with plugins outside of those included in the standard, distribution, you can install those plugins in one of two ways - either by using an `initContainer` to install plugins before the main container starts, or creating a custom Docker image that includes the installed plugins. Refer to <<{p}-bundles-plugins>> for a run down of which option might be most suitable for you.
When running {ls} with plugins outside of those included in the standard {ls} distribution, you can install those plugins by creating a custom Docker image that includes the installed plugins, using the `bin/logstash-plugin install` utility to add further plugins to the image to enable them to be used by {ls} pods.

To add plugins, both of these options require the `bin/logstash-plugin` utility to be run to add the plugin(s) to the {ls} pod before it starts.

=== Adding a plugin using an initContainer

This example sets up an `initContainer` to install the `logstash-filter-tld` plugin:

[source,yaml]
----
spec:
podTemplate:
spec:
initContainers:
- name: install-plugins
command: ["/bin/sh"]
args: ["-c", "bin/logstash-plugin install logstash-filter-tld"]
----

The init container inherits:

* The image of the main container image, if one is not explicitly set.
* The volume mounts from the main container unless a volume mount with the same name and mount path is present in the init container definition.
* The Pod name and IP address environment variables.


=== Adding a plugin using a custom image

This example installs the same plugin, but uses a custom image to install the plugin.

First, create a Dockerfile based on the {ls} Docker image, running `bin/logstash-plugin install` to install the appropriate plugin(s):
This sample Dockerfile installs the `logstash-filter-tld` and `logstash-filter-elastic_integration` plugins to the official {ls} docker image:
thbkrkr marked this conversation as resolved.
Show resolved Hide resolved

[subs="attributes,+macros,callouts"]
----
FROM docker.elastic.co/logstash/logstash:{version}

RUN bin/logstash-plugin install logstash-filter-tld
RUN bin/logstash-plugin install logstash-filter-tld logstash-filter-elastic_integration
----

Then after building and deploying the custom image (refer to <<{p}-custom-images>> for more details), include it in the {ls} manifest:
Expand Down