From 9b4d5a1e5db77d2a73d8629ad075dca8e469ddad Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Mon, 4 Mar 2024 19:53:05 +0000 Subject: [PATCH 1/8] Auto-update README --- README.md | 4 ++-- README_fr.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 899ef0b..f18992c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -54,4 +54,4 @@ or sudo yunohost app upgrade opensearch -u https://github.com/YunoHost-Apps/opensearch_ynh/tree/testing --debug ``` -**More info regarding app packaging:** +**More info regarding app packaging:** \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 11c52db..4a93bb2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,5 @@ From 4dc89aee5dd0dcafbf870addf31df3a5d22a07d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Mon, 4 Mar 2024 21:04:30 +0100 Subject: [PATCH 2/8] Manifest v2 --- .github/workflows/updater.sh | 114 ------------------------------- .github/workflows/updater.yml | 49 -------------- check_process | 22 ------ conf/amd64.src | 6 -- conf/arm64.src | 6 -- conf/opensearch.yml | 2 +- conf/systemd.service | 8 +-- doc/DESCRIPTION.md | 7 +- doc/DISCLAIMER.md | 4 -- doc/PRE_INSTALL.md | 5 ++ manifest.json | 31 --------- manifest.toml | 52 ++++++++++++++ scripts/backup | 27 +------- scripts/install | 114 ++++++------------------------- scripts/remove | 86 +++--------------------- scripts/restore | 90 +++++-------------------- scripts/upgrade | 123 ++++++---------------------------- tests.toml | 5 ++ 18 files changed, 139 insertions(+), 612 deletions(-) delete mode 100755 .github/workflows/updater.sh delete mode 100644 .github/workflows/updater.yml delete mode 100644 check_process delete mode 100644 conf/amd64.src delete mode 100644 conf/arm64.src delete mode 100644 doc/DISCLAIMER.md create mode 100644 doc/PRE_INSTALL.md delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100755 index 50785a2..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,114 +0,0 @@ -#!/bin/bash - -#================================================= -# PACKAGE UPDATING HELPER -#================================================= - -# This script is meant to be run by GitHub Actions -# The YunoHost-Apps organisation offers a template Action to run this script periodically -# Since each app is different, maintainers can adapt its contents so as to perform -# automatic actions when a new upstream release is detected. - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') -# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) -version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) - -# Later down the script, we assume the version has only digits and dots -# Sometimes the release name starts with a "v", so let's filter it out. -# You may need more tweaks here if the upstream repository has different naming conventions. -if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then - version=${version:1} -fi - -# Setting up the environment variables -echo "Current version: $current_version" -echo "Latest release from upstream: $version" -echo "VERSION=$version" >> $GITHUB_ENV -echo "REPO=$repo" >> $GITHUB_ENV -# For the time being, let's assume the script will fail -echo "PROCEED=false" >> $GITHUB_ENV - -# Proceed only if the retrieved version is greater than the current one -if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - echo "::warning ::No new version available" - exit 0 -# Proceed only if a PR for this new version does not already exist -elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then - echo "::warning ::A branch already exists for this update" - exit 0 -fi - -# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) -echo "1 available asset(s)" - -#================================================= -# UPDATE SOURCE FILES -#================================================= - -for arch in "x64" "arm64"; do -asset_url="https://artifacts.opensearch.org/releases/bundle/opensearch/$version/opensearch-$version-linux-$arch.tar.gz" -echo "Handling asset at $asset_url" - -# Assign the asset to a source file in conf/ directory -# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) -# Leave $src empty to ignore the asset -case $arch in - "x64") - src="amd64" - ;; - "arm64") - src="arm64" - ;; -esac - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename=${asset_url##*/} -curl --silent -4 -L $asset_url -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) - -# Delete temporary directory -rm -rf $tempdir - -extension=tar.gz - -# Rewrite source file -cat < conf/$src.src -SOURCE_URL=$asset_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT -echo "... conf/$src.src updated" - -done - -#================================================= -# SPECIFIC UPDATE STEPS -#================================================= - -# Any action on the app's source code can be done. -# The GitHub Action workflow takes care of committing all changes after this script ends. - -#================================================= -# GENERIC FINALIZATION -#================================================= - -# Replace new version in manifest -echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json - -# No need to update the README, yunohost-bot takes care of it - -# The Action will proceed only if the PROCEED environment variable is set to true -echo "PROCEED=true" >> $GITHUB_ENV -exit 0 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index a56d7cb..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. -# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. -# This file should be enough by itself, but feel free to tune it to your needs. -# It calls updater.sh, which is where you should put the app-specific update steps. -name: Check for new upstream releases -on: - # Allow to manually trigger the workflow - workflow_dispatch: - # Run it every day at 6:00 UTC - schedule: - - cron: '0 6 * * *' -jobs: - updater: - runs-on: ubuntu-latest - steps: - - name: Fetch the source code - uses: actions/checkout@v3 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Run the updater script - id: run_updater - run: | - # Setting up Git user - git config --global user.name 'yunohost-bot' - git config --global user.email 'yunohost-bot@users.noreply.github.com' - # Run the updater script - /bin/bash .github/workflows/updater.sh - - name: Commit changes - id: commit - if: ${{ env.PROCEED == 'true' }} - run: | - git commit -am "Upgrade to v$VERSION" - - name: Create Pull Request - id: cpr - if: ${{ env.PROCEED == 'true' }} - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - base: testing - branch: ci-auto-update-v${{ env.VERSION }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - draft: false diff --git a/check_process b/check_process deleted file mode 100644 index b27ef58..0000000 --- a/check_process +++ /dev/null @@ -1,22 +0,0 @@ -# See here for more information -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - -;; Test complet - ; Manifest - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=0 - setup_nourl=1 - setup_private=0 - setup_public=0 - upgrade=1 - backup_restore=1 - multi_instance=1 - port_already_use=1 - change_url=0 -;;; Options -Email= -Notification=none diff --git a/conf/amd64.src b/conf/amd64.src deleted file mode 100644 index f550fab..0000000 --- a/conf/amd64.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://artifacts.opensearch.org/releases/bundle/opensearch/2.9.0/opensearch-2.9.0-linux-x64.tar.gz -SOURCE_SUM=03d623c2d99a7100c2f0faddc8ffda8ba27eae8aa63ff6f3f7dad2337be8b68c -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/arm64.src b/conf/arm64.src deleted file mode 100644 index af09ef1..0000000 --- a/conf/arm64.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://artifacts.opensearch.org/releases/bundle/opensearch/2.9.0/opensearch-2.9.0-linux-arm64.tar.gz -SOURCE_SUM=ba6045e58d433f64f09d92565e308553647bfd3f1193346a1716f7f66e4aad5a -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/opensearch.yml b/conf/opensearch.yml index d80aa0b..806b523 100644 --- a/conf/opensearch.yml +++ b/conf/opensearch.yml @@ -11,7 +11,7 @@ http.port: __PORT__ # # Path to directory where to store the data (separate multiple locations by comma): # -path.data: __DATADIR__ +path.data: __DATA_DIR__ # # Unless you have already configured a cluster, you should set diff --git a/conf/systemd.service b/conf/systemd.service index 14719aa..eb01e54 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -8,12 +8,12 @@ Type=simple User=__APP__ Group=__APP__ RuntimeDirectory=__APP__ -Environment="OPENSEARCH_JAVA_HOME=__FINALPATH__/jdk" -Environment="OPENSEARCH_PATH_CONF=__FINALPATH__/config" +Environment="OPENSEARCH_JAVA_HOME=__INSTALL_DIR__/jdk" +Environment="OPENSEARCH_PATH_CONF=__INSTALL_DIR__/config" Environment="PID_DIR=/run/__APP__" Environment="OPENSEARCH_SD_NOTIFY=true" -WorkingDirectory=__FINALPATH__/ -ExecStart=__FINALPATH__/bin/opensearch -p ${PID_DIR}/__APP__.pid --quiet +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=__INSTALL_DIR__/bin/opensearch -p ${PID_DIR}/__APP__.pid --quiet StandardOutput=append:/var/log/__APP__/__APP__.log StandardError=inherit diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index ffc0c4c..f421fa7 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,6 +1,11 @@ OpenSearch makes it easy to ingest, search, visualize, and analyze your data. - ### Features OpenSearch is a scalable, flexible, and extensible open-source software suite for search, analytics, and observability applications licensed under Apache 2.0. Powered by Apache Lucene and driven by the OpenSearch Project community, OpenSearch offers a vendor-agnostic toolset you can use to build secure, high-performance, cost-efficient applications. Use OpenSearch as an end-to-end solution or connect it with your preferred open-source tools or partner projects. + +### Limitations + +- Currently the security is disabled +- Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) +- Not scalable for now diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index b82819b..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,4 +0,0 @@ -### Limitations - - Currently the security is disabled - - Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) - - Not scalable for now diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md new file mode 100644 index 0000000..ef521fb --- /dev/null +++ b/doc/PRE_INSTALL.md @@ -0,0 +1,5 @@ +### Limitations + +- Currently the security is disabled +- Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) +- Not scalable for now diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 0b9721c..0000000 --- a/manifest.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "name": "OpenSearch", - "id": "opensearch", - "packaging_format": 1, - "description": { - "en": "Open source distributed and RESTful search engine", - "fr": "Moteur de recherche RESTful et open-source" - }, - "version": "2.9.0~ynh1", - "url": "https://github.com/opensearch-project/OpenSearch", - "upstream": { - "license": "Apache-2.0", - "website": "https://opensearch.org", - "demo": "https://playground.opensearch.org/app/home", - "admindoc": "https://opensearch.org/docs/latest/", - "code": "https://github.com/opensearch-project/OpenSearch" - }, - "license": "Apache-2.0", - "maintainer": { - "name": "fflorent", - "email": "florent.git@zeteo.me" - }, - "requirements": { - "yunohost": ">= 11.0.0" - }, - "multi_instance": true, - "services": [], - "arguments": { - "install": [] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..dfe9f67 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,52 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "opensearch" +name = "OpenSearch" +description.en = "Open source distributed and RESTful search engine" +description.fr = "Moteur de recherche RESTful et open-source" + +version = "2.9.0~ynh1" + +maintainers = ["fflorent"] + +[upstream] +license = "Apache-2.0" +website = "https://opensearch.org" +demo = "https://playground.opensearch.org/app/home" +admindoc = "https://opensearch.org/docs/latest/" +code = "https://github.com/opensearch-project/OpenSearch" +cpe = "cpe:2.3:a:amazon:opensearch" + +[integration] +yunohost = ">= 11.0.0" +architectures = ["amd64", "arm64"] +multi_instance = true +ldap = "not_relevant" +sso = "not_relevant" +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + +[resources] + [resources.sources.main] + amd64.url = "https://artifacts.opensearch.org/releases/bundle/opensearch/2.9.0/opensearch-2.9.0-linux-x64.tar.gz" + amd64.sha256 = "03d623c2d99a7100c2f0faddc8ffda8ba27eae8aa63ff6f3f7dad2337be8b68c" + arm64.url = "https://artifacts.opensearch.org/releases/bundle/opensearch/2.9.0/opensearch-2.9.0-linux-arm64.tar.gz" + arm64.sha256 = "ba6045e58d433f64f09d92565e308553647bfd3f1193346a1716f7f66e4aad5a" + + # FIXME: autoupdate + + [resources.system_user] + + [resources.install_dir] + + [resources.data_dir] + + [resources.permissions] + + [resources.ports] + main.default = 9200 diff --git a/scripts/backup b/scripts/backup index bbc5726..cd05903 100755 --- a/scripts/backup +++ b/scripts/backup @@ -1,7 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,27 +8,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -40,13 +17,13 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE DATA DIR #================================================= -ynh_backup --src_path="$datadir" --is_big +ynh_backup --src_path="$data_dir" --is_big #================================================= # SPECIFIC BACKUP diff --git a/scripts/install b/scripts/install index a69e5de..0b23b62 100755 --- a/scripts/install +++ b/scripts/install @@ -1,7 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -9,95 +7,40 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/opt/yunohost/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." --weight=1 - -# Find an available port -port=$(ynh_find_port --port=9200) -ynh_app_setting_set --app=$app --key=port --value=$port - #================================================= # DEFAULT VALUES FOR CONFIGURATION #================================================= xms=256m -ynh_app_setting_set --app=$app --key=xms --value=$xms +ynh_app_setting_set --app="$app" --key="xms" --value="$xms" xmx=1g -ynh_app_setting_set --app=$app --key=xmx --value=$xmx - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" +ynh_app_setting_set --app="$app" --key="xmx" --value="$xmx" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=15 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" --source_id="$YNH_ARCH" +ynh_setup_source --dest_dir="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" - -#================================================= -# CREATE DATA DIRECTORY -#================================================= -ynh_script_progression --message="Creating a data directory..." --weight=1 - -datadir=/home/yunohost.app/$app -ynh_app_setting_set --app=$app --key=datadir --value=$datadir - -mkdir -p $datadir - -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" +chmod -R o-rwx "$install_dir" +chown -R "$app:$app" "$install_dir" +chmod -R o-rwx "$data_dir" +chown -R "$app:www-data" "$data_dir" #================================================= # ADD CONFIGURATIONS #================================================= -ynh_script_progression --message="Adding the configuration files..." --weight=1 +ynh_script_progression --message="Adding $app's configuration files..." --weight=1 -ynh_add_config --template="opensearch.yml" --destination="$final_path/config/opensearch.yml" -ynh_add_config --template="jvm.options" --destination="$final_path/config/jvm.options.d/yunohost.options" - -chmod 400 "$final_path/config/opensearch.yml" "$final_path/config/jvm.options.d/yunohost.options" -chown $app:$app "$final_path/config/opensearch.yml" "$final_path/config/jvm.options.d/yunohost.options" +ynh_add_config --template="opensearch.yml" --destination="$install_dir/config/opensearch.yml" +ynh_add_config --template="jvm.options" --destination="$install_dir/config/jvm.options.d/yunohost.options" +chmod 400 "$install_dir/config/opensearch.yml" "$install_dir/config/jvm.options.d/yunohost.options" +chown "$app:$app" "$install_dir/config/opensearch.yml" "$install_dir/config/jvm.options.d/yunohost.options" #================================================= # INCREASE MAX_MAP_COUNT @@ -105,47 +48,32 @@ chown $app:$app "$final_path/config/opensearch.yml" "$final_path/config/jvm.opti ynh_script_progression --message="Increasing maximum map count (sysctl)..." # Increase the maximum number of files inotify can monitor. -cp -a ../conf/90-max_map_count-opensearch.conf /etc/sysctl.d/ +ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" + # Then, reload the kernel configuration. -if ! [ "${container:-}" = "lxc" ] # lxc doesn't allow sysctl to play with kernel options. -then - sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf +if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi - #================================================= -# SETUP SYSTEMD +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 # Create a dedicated systemd config ynh_add_systemd_config - - -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP LOGROTATE -#================================================= -ynh_script_progression --message="Configuring log rotation..." --weight=1 +yunohost service add "$app" --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" # Use logrotate to manage application logfile(s) ynh_use_logrotate -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - -yunohost service add $app --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" - #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 +ynh_script_progression --message="Starting $app's systemd service..." --weight=1 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 3cdd40c..66ce61b 100755 --- a/scripts/remove +++ b/scripts/remove @@ -1,7 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,98 +8,32 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -port=$(ynh_app_setting_get --app=$app --key=port) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE SERVICE INTEGRATION IN YUNOHOST +# REMOVE SYSTEM CONFIGURATIONS #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) -if ynh_exec_warn_less yunohost service status $app >/dev/null -then - ynh_script_progression --message="Removing $app service integration..." --weight=1 - yunohost service remove $app +if ynh_exec_warn_less yunohost service status "$app" >/dev/null; then + yunohost service remove "$app" fi -#================================================= -# STOP AND REMOVE SERVICE -#================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1 - # Remove the dedicated systemd config ynh_remove_systemd_config -#================================================= -# REMOVE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Removing logrotate configuration..." --weight=1 - # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE DATA DIR -#================================================= - -# Remove the data directory if --purge option is used -if [ "${YNH_APP_PURGE:-0}" -eq 1 ] -then - ynh_script_progression --message="Removing app data directory..." --weight=1 - ynh_secure_remove --file="$datadir" -fi - -#================================================= -# CLOSE A PORT -#================================================= - -if yunohost firewall list | grep -q "\- $port$" -then - ynh_script_progression --message="Closing port $port..." --weight=1 - ynh_exec_warn_less yunohost firewall disallow TCP $port -fi - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - -#================================================= -# SPECIFIC REMOVE #================================================= # REMOVE VARIOUS FILES #================================================= ynh_script_progression --message="Removing various files..." if [ -e "/etc/sysctl.d/90-max_map_count-opensearch.conf" ]; then - ynh_secure_remove --file="/etc/sysctl.d/90-max_map_count-opensearch.conf" - # Reload the kernel configuration. - if ! [ "${container:-}" = "lxc" ] # lxc doesn't allow sysctl to play with kernel options. - then - sysctl --system - fi + ynh_secure_remove --file="/etc/sysctl.d/90-max_map_count-opensearch.conf" + # Reload the kernel configuration. + if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + sysctl --system + fi fi #================================================= diff --git a/scripts/restore b/scripts/restore index 1f2fcc0..daddc7f 100755 --- a/scripts/restore +++ b/scripts/restore @@ -1,7 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,111 +8,53 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) -port=$(ynh_find_port --port=9200) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # RESTORE THE DATA DIRECTORY #================================================= ynh_script_progression --message="Restoring the data directory..." --weight=1 -ynh_restore_file --origin_path="$datadir" --not_mandatory +ynh_restore_file --origin_path="$data_dir" --not_mandatory -mkdir -p $datadir +chmod -R o-rwx "$data_dir" +chown -R "$app:www-data" "$data_dir" -chmod 750 "$datadir" -chmod -R o-rwx "$datadir" -chown -R $app:www-data "$datadir" - -#================================================= -# SPECIFIC RESTORATION #================================================= # RESTORE VARIOUS FILES #================================================= ynh_script_progression --message="Restoring various files..." ynh_restore_file --origin_path="/etc/sysctl.d/90-max_map_count-opensearch.conf" -if ! [ "${container:-}" = "lxc" ] # lxc doesn't allow sysctl to play with kernel options. -then - sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf +if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi #================================================= -# RESTORE SYSTEMD +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet - -#================================================= -# RESTORE THE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1 +systemctl enable "$app.service" --quiet +yunohost service add "$app" --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" ynh_restore_file --origin_path="/etc/logrotate.d/$app" #================================================= -# INTEGRATE SERVICE IN YUNOHOST +# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE #================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 +ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 -yunohost service add $app --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" - -#================================================= -# START SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 - -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/scripts/upgrade b/scripts/upgrade index c5a341c..0e5228c 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,7 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -9,108 +7,39 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -datadir=$(ynh_app_setting_get --app=$app --key=datadir) -port=$(ynh_app_setting_get --app=$app --key=port) -xms=$(ynh_app_setting_get --app=$app --key=xms) -xmx=$(ynh_app_setting_get --app=$app --key=xmx) - -#================================================= -# CHECK VERSION -#================================================= - -upgrade_type=$(ynh_check_app_version_changed) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# STANDARD UPGRADE STEPS #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." --weight=1 +ynh_script_progression --message="Stopping $app's systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app" --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# -# N.B. : the followings setting migrations snippets are provided as *EXAMPLES* -# of what you may want to do in some cases (e.g. a setting was not defined on -# some legacy installs and you therefore want to initiaze stuff during upgrade) -# - -# If db_name doesn't exist, create it -#if [ -z "$db_name" ]; then -# db_name=$(ynh_sanitize_dbid --db_name=$app) -# ynh_app_setting_set --app=$app --key=db_name --value=$db_name -#fi - -# If final_path doesn't exist, create it -#if [ -z "$final_path" ]; then -# final_path=/var/www/$app -# ynh_app_setting_set --app=$app --key=final_path --value=$final_path -#fi - -### If nobody installed your app before 4.1, -### then you may safely remove these lines - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" +# ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=20 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=20 +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep="config/opensearch.yml config/jvm.options.d/yunohost.conf" - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --source_id="$YNH_ARCH" --keep="config/opensearch.yml config/jvm.options.d/yunohost.conf" -fi - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" +chmod -R o-rwx "$install_dir" +chown -R "$app:$app" "$install_dir" #================================================= # UPDATE A CONFIG FILE #================================================= ynh_script_progression --message="Updating a configuration file..." --weight=1 -ynh_add_config --template="opensearch.yml" --destination="$final_path/config/opensearch.yml" -ynh_add_config --template="jvm.options" --destination="$final_path/config/jvm.options.d/yunohost.options" +ynh_add_config --template="opensearch.yml" --destination="$install_dir/config/opensearch.yml" +ynh_add_config --template="jvm.options" --destination="$install_dir/config/jvm.options.d/yunohost.options" -chmod 400 "$final_path/config/opensearch.yml" "$final_path/config/jvm.options.d/yunohost.options" -chown $app:$app "$final_path/config/opensearch.yml" "$final_path/config/jvm.options.d/yunohost.options" +chmod 400 "$install_dir/config/opensearch.yml" "$install_dir/config/jvm.options.d/yunohost.options" +chown "$app:$app" "$install_dir/config/opensearch.yml" "$install_dir/config/jvm.options.d/yunohost.options" #================================================= # INCREASE MAX_MAP_COUNT @@ -118,44 +47,30 @@ chown $app:$app "$final_path/config/opensearch.yml" "$final_path/config/jvm.opti ynh_script_progression --message="Increasing maximum map count (sysctl)..." # Increase the maximum number of files inotify can monitor. -cp -a ../conf/90-max_map_count-opensearch.conf /etc/sysctl.d/ +ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" # Then, reload the kernel configuration. -if ! [ "${container:-}" = "lxc" ] # lxc doesn't allow sysctl to play with kernel options. -then - sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf +if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi #================================================= -# SETUP SYSTEMD +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 # Create a dedicated systemd config ynh_add_systemd_config - -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP LOGROTATE -#================================================= -ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1 +yunohost service add "$app" --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" # Use logrotate to manage app-specific logfile(s) ynh_use_logrotate --non-append -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - -yunohost service add $app --description="OpenSearch - Open source distributed and RESTful search engine" --log="/var/log/$app/$app.log" - #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name="$app" --action="start" --log_path="/var/log/$app/$app.log" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..94abb79 --- /dev/null +++ b/tests.toml @@ -0,0 +1,5 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] From 390d5a3d554f6846f81f4147d2036dd789390e81 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Mon, 4 Mar 2024 20:04:37 +0000 Subject: [PATCH 3/8] Auto-update README --- README.md | 18 ++++++++---------- README_fr.md | 16 +++++++--------- 2 files changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 899ef0b..fb6a346 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -18,22 +18,20 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in OpenSearch makes it easy to ingest, search, visualize, and analyze your data. - ### Features OpenSearch is a scalable, flexible, and extensible open-source software suite for search, analytics, and observability applications licensed under Apache 2.0. Powered by Apache Lucene and driven by the OpenSearch Project community, OpenSearch offers a vendor-agnostic toolset you can use to build secure, high-performance, cost-efficient applications. Use OpenSearch as an end-to-end solution or connect it with your preferred open-source tools or partner projects. +### Limitations + +- Currently the security is disabled +- Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) +- Not scalable for now + **Shipped version:** 2.9.0~ynh1 **Demo:** https://playground.opensearch.org/app/home -## Disclaimers / important information - -### Limitations - - Currently the security is disabled - - Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) - - Not scalable for now - ## Documentation and resources * Official app website: @@ -54,4 +52,4 @@ or sudo yunohost app upgrade opensearch -u https://github.com/YunoHost-Apps/opensearch_ynh/tree/testing --debug ``` -**More info regarding app packaging:** +**More info regarding app packaging:** \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 11c52db..9235a2a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,5 +1,5 @@ @@ -18,22 +18,20 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po OpenSearch makes it easy to ingest, search, visualize, and analyze your data. - ### Features OpenSearch is a scalable, flexible, and extensible open-source software suite for search, analytics, and observability applications licensed under Apache 2.0. Powered by Apache Lucene and driven by the OpenSearch Project community, OpenSearch offers a vendor-agnostic toolset you can use to build secure, high-performance, cost-efficient applications. Use OpenSearch as an end-to-end solution or connect it with your preferred open-source tools or partner projects. +### Limitations + +- Currently the security is disabled +- Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) +- Not scalable for now + **Version incluse :** 2.9.0~ynh1 **Démo :** https://playground.opensearch.org/app/home -## Avertissements / informations importantes - -### Limitations - - Currently the security is disabled - - Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) - - Not scalable for now - ## Documentations et ressources * Site officiel de l’app : From 3c48c68801369b00bdbead75602ac508dc929403 Mon Sep 17 00:00:00 2001 From: Florent Date: Tue, 5 Mar 2024 13:21:14 +0100 Subject: [PATCH 4/8] Fix issue with CI which cannot install files under /etc/sysctl.d/ --- scripts/backup | 4 +++- scripts/install | 10 +++++----- scripts/restore | 4 ++-- scripts/upgrade | 9 +++++---- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/scripts/backup b/scripts/backup index cd05903..6598df5 100755 --- a/scripts/backup +++ b/scripts/backup @@ -37,7 +37,9 @@ ynh_backup --src_path="/etc/logrotate.d/$app" # BACKUP VARIOUS FILES #================================================= -ynh_backup --src_path="/etc/sysctl.d/90-max_map_count-opensearch.conf" +if [ "${container:-}" != "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + ynh_backup --src_path="/etc/sysctl.d/90-max_map_count-opensearch.conf" +fi #================================================= # BACKUP SYSTEMD diff --git a/scripts/install b/scripts/install index 0b23b62..77f4389 100755 --- a/scripts/install +++ b/scripts/install @@ -23,7 +23,7 @@ ynh_app_setting_set --app="$app" --key="xmx" --value="$xmx" ynh_script_progression --message="Setting up source files..." --weight=15 # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$install_dir" +ynh_setup_source --dest_dir="$install_dir" chmod -R o-rwx "$install_dir" chown -R "$app:$app" "$install_dir" @@ -47,11 +47,11 @@ chown "$app:$app" "$install_dir/config/opensearch.yml" "$install_dir/config/jvm. #================================================= ynh_script_progression --message="Increasing maximum map count (sysctl)..." -# Increase the maximum number of files inotify can monitor. -ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" +if [ "${container:-}" != "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + # Increase the maximum number of files inotify can monitor. + ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" -# Then, reload the kernel configuration. -if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + # Then, reload the kernel configuration. sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi diff --git a/scripts/restore b/scripts/restore index daddc7f..8060058 100755 --- a/scripts/restore +++ b/scripts/restore @@ -33,8 +33,8 @@ chown -R "$app:www-data" "$data_dir" #================================================= ynh_script_progression --message="Restoring various files..." -ynh_restore_file --origin_path="/etc/sysctl.d/90-max_map_count-opensearch.conf" -if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. +if [ "${container:-}" != "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + ynh_restore_file --origin_path="/etc/sysctl.d/90-max_map_count-opensearch.conf" sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi diff --git a/scripts/upgrade b/scripts/upgrade index 0e5228c..d15bcdc 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -46,10 +46,11 @@ chown "$app:$app" "$install_dir/config/opensearch.yml" "$install_dir/config/jvm. #================================================= ynh_script_progression --message="Increasing maximum map count (sysctl)..." -# Increase the maximum number of files inotify can monitor. -ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" -# Then, reload the kernel configuration. -if ! [ "${container:-}" = "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. +if [ "${container:-}" != "lxc" ]; then # lxc doesn't allow sysctl to play with kernel options. + # Increase the maximum number of files inotify can monitor. + ynh_add_config --template="90-max_map_count-opensearch.conf" --destination="/etc/sysctl.d/" + + # Then, reload the kernel configuration. sysctl -p /etc/sysctl.d/90-max_map_count-opensearch.conf fi From 7d5f84d75565c732b02970df6733aed179109da9 Mon Sep 17 00:00:00 2001 From: Florent Date: Tue, 5 Mar 2024 13:42:24 +0100 Subject: [PATCH 5/8] Add test of upgrade from version 2.5.0 --- tests.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/tests.toml b/tests.toml index 94abb79..c99241e 100644 --- a/tests.toml +++ b/tests.toml @@ -3,3 +3,4 @@ test_format = 1.0 [default] + test_upgrade_from.ecec6fec.name = "Upgrade from version 2.5.0" From e031f54dba9d63644353b018c368db4b8311af85 Mon Sep 17 00:00:00 2001 From: Florent Date: Tue, 5 Mar 2024 20:28:56 +0100 Subject: [PATCH 6/8] Add RAM and disk estimations --- manifest.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/manifest.toml b/manifest.toml index dfe9f67..6fe7803 100644 --- a/manifest.toml +++ b/manifest.toml @@ -25,9 +25,9 @@ architectures = ["amd64", "arm64"] multi_instance = true ldap = "not_relevant" sso = "not_relevant" -disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... -ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... -ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +disk = "300M" +ram.build = "600M" +ram.runtime = "600M" [install] From 263781e79856682e167c84d4dcacfe371335e946 Mon Sep 17 00:00:00 2001 From: Florent Date: Tue, 5 Mar 2024 20:55:56 +0100 Subject: [PATCH 7/8] Add POST_INSTALL doc --- doc/POST_INSTALL.md | 4 ++++ doc/PRE_INSTALL.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 doc/POST_INSTALL.md diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md new file mode 100644 index 0000000..0e5977b --- /dev/null +++ b/doc/POST_INSTALL.md @@ -0,0 +1,4 @@ +Congratulation, Open Search is installed! + +You may try its API right now. Try this command: +curl http://localhost:**PORT** diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md index ef521fb..08cceb6 100644 --- a/doc/PRE_INSTALL.md +++ b/doc/PRE_INSTALL.md @@ -1,4 +1,4 @@ -### Limitations +LIMITATIONS - Currently the security is disabled - Therefore, the package is configured to remain not public for now (i.e. not accessible through the web, the apps depending on it should be installed on the same server) From 9822941df5f59e1c9edda43962d0e0f564c38b24 Mon Sep 17 00:00:00 2001 From: Florent Date: Wed, 6 Mar 2024 12:01:19 +0100 Subject: [PATCH 8/8] Update doc/POST_INSTALL.md Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> --- doc/POST_INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index 0e5977b..7f59f50 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -1,4 +1,4 @@ Congratulation, Open Search is installed! You may try its API right now. Try this command: -curl http://localhost:**PORT** +`curl http://localhost:__PORT__`