https://github.com/ems-project/elasticms-cli-docker

Command client of the ElasticMS suite in Docker container.
https://github.com/ems-project/elasticms-cli-docker

Last synced: 7 days ago
JSON representation

Command client of the ElasticMS suite in Docker container.

• Host: GitHub
• URL: https://github.com/ems-project/elasticms-cli-docker
• Owner: ems-project
• Created: 2022-12-08T13:45:00.000Z (almost 2 years ago)
• Default Branch: 5.x
• Last Pushed: 2024-10-28T10:06:38.000Z (23 days ago)
• Last Synced: 2024-10-28T10:36:11.033Z (23 days ago)
• Language: Shell
• Size: 66.4 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ElasticMS Client [![Docker Build](https://github.com/ems-project/elasticms-cli-docker/actions/workflows/docker-build.yml/badge.svg?branch=5.x)](https://github.com/ems-project/elasticms-cli-docker/actions/workflows/docker-build.yml)

This docker image is not intended to run containers permanently as a webserver or nodeJS server, it should be used to run single commands to execute tasks.  

Some schedulers like Kubernetes or Openshift give the possibility to run tasks at regular intervals like Cronjobs.  This image can be used in this context.  

# Build

To automate the build and testing of this image, we rely on a Makefile that facilitates the construction and testing of a container image for ElasticMS Client.  The Makefile supports both Docker and Podman with Buildah as options for building and testing the image.  Additionally, the Dockerfile used for image creation is templated using m4.  

## Prerequisites

To use this Makefile, you need to have the following installed on your system:

- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/getting-started/installation) with [Buildah](https://buildah.io/install) (for building and managing containers)

- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (for version control)

- [Make](https://www.gnu.org/software/make/) (for running the Makefile commands)

- [M4](https://www.gnu.org/software/m4/) (for generating the Dockerfile from templates)

Make sure to follow the links provided to install the required tools according to your operating system and platform.

## Getting Started

1. Clone the repository containing the Makefile and navigate to its directory:

   ```bash

   git clone 

   cd 

   ```

2. (Optional) If you want to customize the build process, create a `.build.env` file in the repository directory. This file can define the following environment variables:

   - `ELASTICMS_CLI_VERSION`: The version of ElasticMS Client to build (default: 5.0.0)

   - `DOCKER_IMAGE_NAME`: The name of the Docker image to build (default: docker.io/elasticms/cli)

   Make sure to define these variables in the `.build.env` file using the `KEY=VALUE` format.

## Usage

To use the Makefile, you can run the following commands:

- `make build`: Build the Docker image for the production (`prd`) variant of ElasticMS Client.

- `make build-dev`: Build the Docker image for the development (`dev`) variant of ElasticMS Client.

- `make build-all`: Build Docker images for both the production and development variants of ElasticMS Client.

- `make test`: Test the Docker image for the production (`prd`) variant of ElasticMS Client.

- `make test-dev`: Test the Docker image for the development (`dev`) variant of ElasticMS Client.

- `make test-all`: Test Docker images for both the production and development variants of ElasticMS Client.

- `make Dockerfile`: Generate the Dockerfile from the provided templates.

You can also run `make help` to see a list of available commands.

**Note:** By default, the Makefile uses Docker as the container engine. If you want to use Podman with Buildah instead, you have two options:

1. Set the `CONTAINER_ENGINE` variable in the `.build.env` file. Create a `.build.env` file in the repository directory and define `CONTAINER_ENGINE=podman` in the file.

2. Set the `CONTAINER_ENGINE` environment variable directly when running the Makefile commands:

   ```bash

   make build CONTAINER_ENGINE=podman

   ```

Using an environment variable allows you to dynamically switch between Docker and Podman with Buildah without modifying the `.build.env` file.

Additionally, if you are using Podman as the container engine, you can specify the `CONTAINER_TARGET_IMAGE_FORMAT` environment variable to choose the image format. By default, the image format is Docker. To create the image in the OCI format, use the following command:

   ```bash

   make build CONTAINER_ENGINE=podman CONTAINER_TARGET_IMAGE_FORMAT=oci

   ```

To customize the Docker image name and ElasticMS Client version, you have two options:

1. Set the `DOCKER_IMAGE_NAME` and `ELASTICMS_CLI_VERSION` variables in the `.build.env` file. Create a `.build.env` file in the repository directory and define the desired values for these variables.

2. Set the `DOCKER_IMAGE_NAME` and `ELASTICMS_CLI_VERSION` environment variables directly when running the Makefile commands:

   ```bash

   make build DOCKER_IMAGE_NAME=my-custom-image ELASTICMS_CLI_VERSION=6.0.0

   ```

Setting these variables allows you to customize the image name and ElasticMS Client version without modifying the `.build.env` file.

Please ensure that you have the necessary dependencies installed as mentioned earlier in the documentation.

## Customizing the Build

If you want to customize the build process further, you can modify the `.build.env` file to set the desired values for the environment variables mentioned earlier. Additionally, you can modify the Dockerfile templates located in the `Dockerfiles` directory. The Makefile uses `m4` to generate the final Dockerfile from the templates.

To regenerate the Dockerfile after modifying the templates, run the following command:

```bash

make Dockerfile

```

## Testing

The Makefile uses Bats (Bash Automated Testing System) to test the Docker images. The test cases are defined in the `test/tests.bats` file. Before running the tests, make sure you have the following dependencies installed:

- Bats: Bats is a TAP-compliant testing framework for Bash. Install Bats by following the instructions in the [Bats documentation](https://github.com/bats-core/bats-core#installation).  

- AWS CLI: The AWS CLI is required to execute certain tests. Install the AWS CLI by following the instructions in the [AWS CLI user guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html).  

- npm: npm is the package manager for JavaScript. Install npm by following the instructions in the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).  

- gettext: gettext is a package that provides internationalization (i18n) support. Install gettext by following the instructions for your specific operating system.  

- Docker: If you're using Docker as the container engine, you need to have Docker installed. Follow the instructions in the [Docker documentation](https://docs.docker.com/get-docker/) to install Docker.  

- Docker Compose: Docker Compose is required for certain tests that use Docker Compose functionality. Install Docker Compose by following the instructions in the [Docker Compose documentation](https://docs.docker.com/compose/install/).  

- Podman (with Podman Compose): If you're using Podman as the container engine, you need to have Podman and Podman Compose installed. Install Podman by following the instructions in the [Podman documentation](https://podman.io/getting-started/installation). Install Podman Compose by following the instructions in the [Podman Compose documentation](https://github.com/containers/podman-compose#installation).  

To run the tests, make sure to configure the desired container engine (Docker or Podman) using the CONTAINER_ENGINE environment variable. The Makefile will execute the tests accordingly.

To run the tests, use the following commands:

- `make test`: Test the Docker image for the production (`prd`) variant of ElasticMS Client using the configured container engine.

- `make test-dev`: Test the Docker image for the development (`dev`) variant of ElasticMS Client using the configured container engine.

- `make test-all`: Test Docker images for both the production and development variants of ElasticMS Client using the configured container engine.

You can also specify the `DOCKER_IMAGE_NAME` and `ELASTICMS_CLI_VERSION` variables to customize the image name and version used for testing. For example:

```shell

make test DOCKER_IMAGE_NAME=my-custom-image ELASTICMS_CLI_VERSION=6.0.0 CONTAINER_ENGINE=podman

```

The Bats test suite includes multiple test cases that validate the functionality and behavior of the ElasticMS Client container image. It covers various aspects of the image, including its configuration, dependencies, and expected output. The test suite ensures the integrity and correctness of the container image.  

# Releases

Releases are done via GitHub actions and uploaded on Docker Hub.

# Supported tags and respective Dockerfile links

- [`5.x.y`, `5.x`, `5`, `5.x.y-prd`, `5.x-prd`, `5-prd`, `5.x.y-dev`, `5.x-dev`, `5-dev`](Dockerfiles/Dockerfile.in)

# Image Variants

The elasticms/cli images come in many flavors, each designed for a specific use case.

## `docker.io/elasticms/cli:[-prd]`  

This variant contains the [ElasticMS CLI tool](https://github.com/ems-project/elasticms-cli) installed in a Production PHP environment.  

## `docker.io/elasticms/cli:-dev`

This variant contains the [ElasticMS CLI tool](https://github.com/ems-project/elasticms-cli) installed in a Development PHP environment.  

# Usage

## [elasticms-client](https://github.com/ems-project/elasticms-cli)

```

docker run -it --rm docker.io/elasticms/cli: 

docker run -it --rm -e TZ=Europe/Brussels \

                    -e ELASTICMS_CLI_CROND_SCHEDULE="*/1 * * * *" \

                    docker.io/elasticms/cli: cron ems:version

docker run -it --rm -e ELASTICMS_CLI_CROND_SCHEDULE="*/1 * * * *" \

                    docker.io/elasticms/cli: cron ems:version

docker run -it --rm -e TZ=Europe/Brussels \

                    -e ELASTICMS_CLI_CROND_SCHEDULE="*/1 * * * *" \

                    -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_HOST=0.0.0.0 \

                    -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_PORT=9746 \

                    docker.io/elasticms/cli: cron ems:version

docker run -it --rm -v -p 9746:9746 \

                       -p 9744:9744 \

                       -e TZ=Europe/Brussels \

                       -e ELASTICMS_CLI_CROND_SCHEDULE="*/1 * * * *" \

                       -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_HOST=0.0.0.0 \

                       -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_PORT=9746 \

                       -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_INET_HOST=0.0.0.0 \

                       -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_INET_PORT=9744 \

                       --name cron \

                       docker.io/elasticms/cli: cron ems:version

docker run -it --rm -p 9746:9746 \

                    -p 9744:9744 \

                    -e TZ=Europe/Brussels \

                    -e ELASTICMS_CLI_CROND_SCHEDULE="*/1 * * * *" \

                    -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_HOST=0.0.0.0 \

                    -e ELASTICMS_CLI_SUPERCRONIC_PROMETHEUS_LISTEN_PORT=9746 \

                    -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_INET_HOST=0.0.0.0 \

                    -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_INET_PORT=9744 \

                    -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_UNIX_SOCKET_PATH=/tmp/supervisor/supervisor.sock \

                    -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_UNIX_SOCKET_CHMOD=0700 \

                    -e ELASTICMS_CLI_SUPERVISOR_XMLRPC_UNIX_SOCKET_CHOWN=1001:0 \

                    --name cron \

                    docker.io/elasticms/cli: cron ems:version

```