Add OpenSearch images (#20)

.github/workflows/build.yml

@@ -153,6 +153,15 @@ jobs:
          - path: jupyter
            tags:
              - riptidepy/jupyter:latest
+         - path: opensearch/latest
+           tags:
+             - riptidepy/opensearch:latest
+         - path: opensearch/2
+           tags:
+             - riptidepy/opensearch:2
+         - path: opensearch/1
+           tags:
+             - riptidepy/opensearch:1
     name: Build Image
     steps:
       - name: Checkout

opensearch/1/Dockerfile

@@ -0,0 +1,8 @@
+# THIS IS AUTO-GENERATED by builder/build.sh. DO NOT EDIT.
+FROM opensearchproject/opensearch:1
+
+USER root
+
+RUN yum install -y util-linux
+
+USER opensearch

opensearch/1/README.md

@@ -0,0 +1,56 @@
+# Supported tags and respective `Dockerfile` links
+-	[`latest`, (*latest/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/latest/Dockerfile)
+-	[`2`,  (*2/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/2/Dockerfile)
+-	[`1` (*1/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/1/Dockerfile)
+
+# Quick reference
+
+-	**Where to get help**:
+	[the Riptide Docker Images Github Repository](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Where to file issues**:
+	[https://github.com/theCapypara/riptide-docker-images/issues](https://github.com/theCapypara/riptide-docker-images/issues)
+
+-	**Maintained by**:
+	[the Riptide Community](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Source of this description**:
+	[README in riptide-docker-images repo](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch) ([history](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch))
+
+# What is OpenSearch?
+
+OpenSearch images based on the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+
+These images work like their official counterpart, but:
+
+- They include `util-linux`, which allows Riptide to utilize the current user instead of the predefined `opensearch` user
+
+# How to use this image.
+
+See the description of the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+The directory used for app data is `/usr/share/opensearch/data`!
+The configuration file used for this app is `/usr/share/opensearch/config/opensearch.yml`!
+
+This image is meant to be used with [Riptide](https://github.com/theCapypara/riptide-cli). 
+Using it without Riptide is probably possible, but not supported.
+
+## Basic Usage with Riptide
+
+For a service using this image, see: [OpenSearch Riptide Service](https://github.com/theCapypara/riptide-repo/tree/master/service/opensearch)
+
+The image is meant to be used only for services.
+
+This image supports ``run_as_current_user: true`` for services (this is the default).
+
+## Basic Usage with Docker Run
+
+```
+docker run \
+      -it \
+      -d \
+      -p 9200:9200 \
+      -p 9600:9600 \
+      -e "discovery.type=single-node" \
+      -v ./data:/usr/share/opensearch/data \
+      riptidepy/opensearch
+```

opensearch/2/Dockerfile

@@ -0,0 +1,8 @@
+# THIS IS AUTO-GENERATED by builder/build.sh. DO NOT EDIT.
+FROM opensearchproject/opensearch:2
+
+USER root
+
+RUN yum install -y util-linux
+
+USER opensearch

opensearch/2/README.md

@@ -0,0 +1,56 @@
+# Supported tags and respective `Dockerfile` links
+-	[`latest`, (*latest/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/latest/Dockerfile)
+-	[`2`,  (*2/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/2/Dockerfile)
+-	[`1` (*1/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/1/Dockerfile)
+
+# Quick reference
+
+-	**Where to get help**:
+	[the Riptide Docker Images Github Repository](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Where to file issues**:
+	[https://github.com/theCapypara/riptide-docker-images/issues](https://github.com/theCapypara/riptide-docker-images/issues)
+
+-	**Maintained by**:
+	[the Riptide Community](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Source of this description**:
+	[README in riptide-docker-images repo](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch) ([history](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch))
+
+# What is OpenSearch?
+
+OpenSearch images based on the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+
+These images work like their official counterpart, but:
+
+- They include `util-linux`, which allows Riptide to utilize the current user instead of the predefined `opensearch` user
+
+# How to use this image.
+
+See the description of the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+The directory used for app data is `/usr/share/opensearch/data`!
+The configuration file used for this app is `/usr/share/opensearch/config/opensearch.yml`!
+
+This image is meant to be used with [Riptide](https://github.com/theCapypara/riptide-cli). 
+Using it without Riptide is probably possible, but not supported.
+
+## Basic Usage with Riptide
+
+For a service using this image, see: [OpenSearch Riptide Service](https://github.com/theCapypara/riptide-repo/tree/master/service/opensearch)
+
+The image is meant to be used only for services.
+
+This image supports ``run_as_current_user: true`` for services (this is the default).
+
+## Basic Usage with Docker Run
+
+```
+docker run \
+      -it \
+      -d \
+      -p 9200:9200 \
+      -p 9600:9600 \
+      -e "discovery.type=single-node" \
+      -v ./data:/usr/share/opensearch/data \
+      riptidepy/opensearch
+```

opensearch/README.md

@@ -0,0 +1,56 @@
+# Supported tags and respective `Dockerfile` links
+-	[`latest`, (*latest/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/latest/Dockerfile)
+-	[`2`,  (*2/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/2/Dockerfile)
+-	[`1` (*1/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/1/Dockerfile)
+
+# Quick reference
+
+-	**Where to get help**:
+	[the Riptide Docker Images Github Repository](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Where to file issues**:
+	[https://github.com/theCapypara/riptide-docker-images/issues](https://github.com/theCapypara/riptide-docker-images/issues)
+
+-	**Maintained by**:
+	[the Riptide Community](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Source of this description**:
+	[README in riptide-docker-images repo](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch) ([history](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch))
+
+# What is OpenSearch?
+
+OpenSearch images based on the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+
+These images work like their official counterpart, but:
+
+- They include `util-linux`, which allows Riptide to utilize the current user instead of the predefined `opensearch` user
+
+# How to use this image.
+
+See the description of the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+The directory used for app data is `/usr/share/opensearch/data`!
+The configuration file used for this app is `/usr/share/opensearch/config/opensearch.yml`!
+
+This image is meant to be used with [Riptide](https://github.com/theCapypara/riptide-cli). 
+Using it without Riptide is probably possible, but not supported.
+
+## Basic Usage with Riptide
+
+For a service using this image, see: [OpenSearch Riptide Service](https://github.com/theCapypara/riptide-repo/tree/master/service/opensearch)
+
+The image is meant to be used only for services.
+
+This image supports ``run_as_current_user: true`` for services (this is the default).
+
+## Basic Usage with Docker Run
+
+```
+docker run \
+      -it \
+      -d \
+      -p 9200:9200 \
+      -p 9600:9600 \
+      -e "discovery.type=single-node" \
+      -v ./data:/usr/share/opensearch/data \
+      riptidepy/opensearch
+```

opensearch/builder/Dockerfile

@@ -0,0 +1,9 @@
+# Dockerfile for all builds. The FROM part is switched out. Built by build.sh. See README. First three lines are stripped.
+FROM opensearchproject/opensearch
+##################################################################################
+
+USER root
+
+RUN yum install -y util-linux
+
+USER opensearch

opensearch/builder/README.md

@@ -0,0 +1,8 @@
+opensearch builder
+===========
+
+Build script to update the individual images.
+
+Creates the Dockerfile's in the other directories based on their name. All steps
+in this directories Dockerfile will be added to those Dockerfiles, only
+the FROM part is modified. 

opensearch/builder/build.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Builder script, see README. Run from ..!
+# This is not run by CI. Run manually and commit the resulting files.
+
+for goal in */; do
+    goal=${goal%*/} # Remove trailing slash
+    IFS='/' read -r -a parts <<< "$goal"
+
+    version="${parts[0]}"
+
+    if [[ "builder" == "$version" ]]
+    then
+        continue
+    fi
+    echo "# THIS IS AUTO-GENERATED by builder/build.sh. DO NOT EDIT." > "$version/Dockerfile"
+
+    echo "FROM opensearchproject/opensearch:$version" >> "$version/Dockerfile"
+
+    # Read base Dockefile, first three lines are skipped.
+    tail -n +4 builder/Dockerfile >> "$version/Dockerfile"
+
+    cp "README.md" "$version/"
+    echo "$version/"
+
+done

opensearch/latest/Dockerfile

@@ -0,0 +1,8 @@
+# THIS IS AUTO-GENERATED by builder/build.sh. DO NOT EDIT.
+FROM opensearchproject/opensearch:latest
+
+USER root
+
+RUN yum install -y util-linux
+
+USER opensearch

opensearch/latest/README.md

@@ -0,0 +1,56 @@
+# Supported tags and respective `Dockerfile` links
+-	[`latest`, (*latest/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/latest/Dockerfile)
+-	[`2`,  (*2/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/2/Dockerfile)
+-	[`1` (*1/Dockerfile*)](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch/1/Dockerfile)
+
+# Quick reference
+
+-	**Where to get help**:
+	[the Riptide Docker Images Github Repository](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Where to file issues**:
+	[https://github.com/theCapypara/riptide-docker-images/issues](https://github.com/theCapypara/riptide-docker-images/issues)
+
+-	**Maintained by**:
+	[the Riptide Community](https://github.com/theCapypara/riptide-docker-images)
+
+-	**Source of this description**:
+	[README in riptide-docker-images repo](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch) ([history](https://github.com/theCapypara/riptide-docker-images/tree/master/opensearch))
+
+# What is OpenSearch?
+
+OpenSearch images based on the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+
+These images work like their official counterpart, but:
+
+- They include `util-linux`, which allows Riptide to utilize the current user instead of the predefined `opensearch` user
+
+# How to use this image.
+
+See the description of the [official OpenSearch images](https://hub.docker.com/r/opensearchproject/opensearch).
+The directory used for app data is `/usr/share/opensearch/data`!
+The configuration file used for this app is `/usr/share/opensearch/config/opensearch.yml`!
+
+This image is meant to be used with [Riptide](https://github.com/theCapypara/riptide-cli). 
+Using it without Riptide is probably possible, but not supported.
+
+## Basic Usage with Riptide
+
+For a service using this image, see: [OpenSearch Riptide Service](https://github.com/theCapypara/riptide-repo/tree/master/service/opensearch)
+
+The image is meant to be used only for services.
+
+This image supports ``run_as_current_user: true`` for services (this is the default).
+
+## Basic Usage with Docker Run
+
+```
+docker run \
+      -it \
+      -d \
+      -p 9200:9200 \
+      -p 9600:9600 \
+      -e "discovery.type=single-node" \
+      -v ./data:/usr/share/opensearch/data \
+      riptidepy/opensearch
+```