diff options
author | Juraj Lutter <otis@FreeBSD.org> | 2022-11-26 10:37:44 +0100 |
---|---|---|
committer | Juraj Lutter <otis@FreeBSD.org> | 2022-11-26 22:03:17 +0100 |
commit | a6b3049a936800484f0a0505211046a8a5a49c07 (patch) | |
tree | 11ab6ae5870f9656061b6ceac114fadb0d75d5ea /textproc/elasticsearch8/files | |
parent | textproc/kibana8: Add new port (diff) |
textproc/elasticsearch8: Add new port
Add elasticsearch8, a distributed, RESTful search and analytics engine.
For release notes since version 8.0 see
https://www.elastic.co/guide/en/elasticsearch/reference/8.5/es-release-notes.html
Diffstat (limited to 'textproc/elasticsearch8/files')
5 files changed, 234 insertions, 0 deletions
diff --git a/textproc/elasticsearch8/files/elasticsearch.in b/textproc/elasticsearch8/files/elasticsearch.in new file mode 100644 index 000000000000..002a2335bf0b --- /dev/null +++ b/textproc/elasticsearch8/files/elasticsearch.in @@ -0,0 +1,128 @@ +#!/bin/sh + +# PROVIDE: elasticsearch +# REQUIRE: DAEMON +# BEFORE: LOGIN +# KEYWORD: shutdown +# +# Add the following line to /etc/rc.conf to enable elasticsearch: +# +# elasticsearch_enable="YES" +# +# elasticsearch_user (username): Set to elasticsearch by default. +# Set it to required username. +# elasticsearch_group (group): Set to elasticsearch by default. +# Set it to required group. +# elasticsearch_config (path): Set to %%PREFIX%%/etc/elasticsearch/elasticsearch.yml by default. +# Set it to the config file location. +# elasticsearch_java_home (path): Set to %%JAVA_HOME%% by default. +# Set it to the root of the JDK to use. +# +. /etc/rc.subr + +name=elasticsearch +rcvar=elasticsearch_enable + +load_rc_config ${name} + +: ${elasticsearch_enable:=NO} +: ${elasticsearch_user=elasticsearch} +: ${elasticsearch_group=elasticsearch} +: ${elasticsearch_config=%%PREFIX%%/etc/elasticsearch} +: ${elasticsearch_login_class=root} +: ${elasticsearch_java_home="%%JAVA_HOME%%"} + +required_files="${elasticsearch_config}/elasticsearch.yml" +_pidprefix=/var/run/elasticsearch/elasticsearch +pidfile=${_pidprefix}.pid +procname=${elasticsearch_java_home}/bin/java + +extra_commands="console status" +console_cmd=elasticsearch_console +start_precmd=elasticsearch_precmd +command=%%PREFIX%%/lib/elasticsearch/bin/elasticsearch +command_args="-d --pidfile=${pidfile}" + +export ES_PATH_CONF=${elasticsearch_config} +export ES_JAVA_HOME=${elasticsearch_java_home} + +elasticsearch_precmd() +{ + /usr/bin/install -d -o ${elasticsearch_user} -g ${elasticsearch_group} -m 755 ${pidfile%/*} + /usr/bin/install -d -o ${elasticsearch_user} -g ${elasticsearch_group} -m 755 /var/db/elasticsearch + /usr/bin/install -d -o ${elasticsearch_user} -g ${elasticsearch_group} -m 755 /var/log/elasticsearch +} + +elasticsearch_console() +{ + command_args="" + run_rc_command "start" +} + +if [ -n "$2" ]; then + profile="$2" + if [ "x${elasticsearch_profiles}" != "x" ]; then + eval elasticsearch_config="\${elasticsearch_${profile}_config:-}" + if [ "x${elasticsearch_config}" = "x" ]; then + echo "You must define a configuration (elasticsearch_${profile}_config)" + exit 1 + fi + export ES_PATH_CONF=${elasticsearch_config} + required_files="${elasticsearch_config}/elasticsearch.yml" + required_files="${elasticsearch_config}/jvm.options" + eval elasticsearch_enable="\${elasticsearch_${profile}_enable:-${elasticsearch_enable}}" + pidfile="${_pidprefix}.${profile}.pid" + command_args="-d --pidfile=${pidfile}" + echo "===> elasticsearch profile: ${profile}" + else + echo "$0: extra argument ignored" + fi +else + if [ "x${elasticsearch_profiles}" != "x" -a "x$1" != "x" ]; then + for profile in ${elasticsearch_profiles}; do + eval _enable="\${elasticsearch_${profile}_enable}" + case "x${_enable:-${elasticsearch_enable}}" in + x|x[Nn][Oo]|x[Nn][Oo][Nn][Ee]) + continue + ;; + x[Yy][Ee][Ss]) + ;; + *) + if test -z "$_enable"; then + _var=elasticsearch_enable + else + _var=elasticsearch_"${profile}"_enable + fi + echo "Bad value" \ + "'${_enable:-${elasticsearch_enable}}'" \ + "for ${_var}. " \ + "Profile ${profile} skipped." + continue + ;; + esac + %%PREFIX%%/etc/rc.d/elasticsearch $1 ${profile} + retcode="$?" + if [ "0${retcode}" -ne 0 ]; then + failed="${profile} (${retcode}) ${failed:-}" + else + success="${profile} ${success:-}" + fi + done + exit 0 + fi +fi + +if [ "x${elasticsearch_mem_min}" != "x" ]; then + echo "The elasticsearch_mem_min variable is no longer supported please set this in ${elasticsearch_config}/jvm.options" + exit 1; +fi +if [ "x${elasticsearch_mem_max}" != "x" ]; then + echo "The elasticsearch_mem_max variable is no longer supported please set this in ${elasticsearch_config}/jvm.options" + exit 1; +fi +if [ "x${elasticsearch_props}" != "x" ]; then + echo "The elasticsearch_props variable is no longer supported please set this in ${elasticsearch_config}/jvm.options" + exit 1; +fi + +run_rc_command "$1" diff --git a/textproc/elasticsearch8/files/patch-bin_elasticsearch-env b/textproc/elasticsearch8/files/patch-bin_elasticsearch-env new file mode 100644 index 000000000000..4409d733fb25 --- /dev/null +++ b/textproc/elasticsearch8/files/patch-bin_elasticsearch-env @@ -0,0 +1,26 @@ +--- bin/elasticsearch-env.orig 2022-11-26 09:28:22 UTC ++++ bin/elasticsearch-env +@@ -46,12 +46,17 @@ if [ ! -z "$ES_JAVA_HOME" ]; then + "$JAVA" -cp "$ES_HOME/lib/java-version-checker/*" org.elasticsearch.tools.java_version_checker.JavaVersionChecker + else + # use the bundled JDK (default) +- if [ "$(uname -s)" = "Darwin" ]; then +- # macOS has a different structure +- JAVA="$ES_HOME/jdk.app/Contents/Home/bin/java" +- else +- JAVA="$ES_HOME/jdk/bin/java" +- fi ++ case "$(uname -s)" in ++ "Darwin") ++ JAVA="$ES_HOME/jdk.app/Contents/Home/bin/java" ++ ;; ++ "FreeBSD") ++ JAVA=%%LOCALBASE%%/bin/java ++ ;; ++ *) ++ JAVA="$ES_HOME/jdk/bin/java" ++ ;; ++ esac + JAVA_TYPE="bundled JDK" + fi + diff --git a/textproc/elasticsearch8/files/patch-config_elasticsearch.yml b/textproc/elasticsearch8/files/patch-config_elasticsearch.yml new file mode 100644 index 000000000000..e0bff4afd738 --- /dev/null +++ b/textproc/elasticsearch8/files/patch-config_elasticsearch.yml @@ -0,0 +1,25 @@ +--- config/elasticsearch.yml.orig 2022-11-17 18:55:38 UTC ++++ config/elasticsearch.yml +@@ -31,10 +31,12 @@ + # Path to directory where to store the data (separate multiple locations by comma): + # + #path.data: /path/to/data ++path.data: /var/db/elasticsearch + # + # Path to log files: + # + #path.logs: /path/to/logs ++path.logs: /var/log/elasticsearch + # + # ----------------------------------- Memory ----------------------------------- + # +@@ -80,6 +82,9 @@ + # Enable an unauthenticated TCP readiness endpoint on localhost + # + #readiness.port: 9399 ++ ++# ml is not supported on FreeBSD ++xpack.ml.enabled: false + # + # ---------------------------------- Various ----------------------------------- + # diff --git a/textproc/elasticsearch8/files/patch-config_jvm.options b/textproc/elasticsearch8/files/patch-config_jvm.options new file mode 100644 index 000000000000..eca6128fd579 --- /dev/null +++ b/textproc/elasticsearch8/files/patch-config_jvm.options @@ -0,0 +1,12 @@ +--- config/jvm.options.orig 2022-11-17 18:55:38 UTC ++++ config/jvm.options +@@ -69,7 +69,7 @@ + -XX:HeapDumpPath=data + + # specify an alternative path for JVM fatal error logs +--XX:ErrorFile=logs/hs_err_pid%p.log ++-XX:ErrorFile=${ES_TMPDIR}/hs_err_pid%p.log + + ## GC logging +--Xlog:gc*,gc+age=trace,safepoint:file=logs/gc.log:utctime,pid,tags:filecount=32,filesize=64m ++-Xlog:gc*,gc+age=trace,safepoint:file=${ES_TMPDIR}/gc.log:utctime,pid,tags:filecount=32,filesize=64m diff --git a/textproc/elasticsearch8/files/pkg-message.in b/textproc/elasticsearch8/files/pkg-message.in new file mode 100644 index 000000000000..06e0d7d83f64 --- /dev/null +++ b/textproc/elasticsearch8/files/pkg-message.in @@ -0,0 +1,43 @@ +[ +{ type: install + message: <<EOM +Please see %%ETCDIR%% for sample versions of +elasticsearch.yml and logging.yml. + +ElasticSearch requires memory locking of large amounts of RAM. +You may need to set: + +sysctl security.bsd.unprivileged_mlock=1 + +When running within a jail, it's highly advisable to set: + +enforce_statfs = 1 + +for the jail running elasticsearch instance. + +NOTICE: elasticsearch port now installs elasticsearch-specific utilities +as symbolic links into %%BINDIR%%. + +!!! PLUGINS NOTICE !!! + +ElasticSearch plugins should only be installed via the elasticsearch-plugin +included with this software. As we strive to provide a minimum semblance +of security, the files installed by the package are owned by root:wheel. +This is different than upstream which expects all of the files to be +owned by the user and for you to execute the elasticsearch-plugin script +as said user. + +You will encounter permissions errors with configuration files and +directories created by plugins which you will have to manually correct. +This is the price we have to pay to protect ourselves in the face of +a poorly designed security model. + +e.g., after installing X-Pack you will have to correct: + +%%ETCDIR%%/elasticsearch.keystore file to be owned by elasticsearch:elasticsearch +%%ETCDIR%%/x-pack directory/files to be owned by elasticsearch:elasticsearch + +!!! PLUGINS NOTICE !!! +EOM +} +] |