From 0d9bf68b5f59f845a6e465312bcaa17621e1d8e1 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 13 Jun 2024 14:56:18 +0800 Subject: [PATCH 01/14] readme: update docker image overview in readme --- mlflow/README.md | 67 +++++++++++++++++--------- mlflow/doc/image-info.yml | 3 +- mlflow/meta.yml | 5 +- nginx/README.md | 67 +++++++++++++++++++------- redis/README.md | 99 +++++++++++++++++++++++++++++---------- 5 files changed, 173 insertions(+), 68 deletions(-) diff --git a/mlflow/README.md b/mlflow/README.md index a10b5353..dcd47cc5 100644 --- a/mlflow/README.md +++ b/mlflow/README.md @@ -1,37 +1,60 @@ -# Mlflow - # Quick reference -- The official mlflow docker image. +- The official MLflow docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Redis | openEuler +Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -# Build reference +MLflow, at its core, provides a suite of tools aimed at simplifying the ML workflow. It is tailored to assist ML practitioners throughout the various stages of ML development and deployment. Despite its expansive offerings, MLflow’s functionalities are rooted in several foundational components: -1. Build images and push: (you may need to replace "openeuler" with your own repo name.) -```shell -docker buildx build -t "openeuler/mlflow:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +- [Tracking](https://mlflow.org/docs/latest/tracking.html#tracking): MLflow Tracking provides both an API and UI dedicated to the logging of parameters, code versions, metrics, and artifacts during the ML process. This centralized repository captures details such as parameters, metrics, artifacts, data, and environment configurations, giving teams insight into their models’ evolution over time. Whether working in standalone scripts, notebooks, or other environments, Tracking facilitates the logging of results either to local files or a server, making it easier to compare multiple runs across different users. + +- [Model Registry](https://mlflow.org/docs/latest/model-registry.html#registry): A systematic approach to model management, the Model Registry assists in handling different versions of models, discerning their current state, and ensuring smooth productionization. It offers a centralized model store, APIs, and UI to collaboratively manage an MLflow Model’s full lifecycle, including model lineage, versioning, aliasing, tagging, and annotations. + +- [MLflow Deployments for LLMs](https://mlflow.org/docs/latest/llms/deployments/index.html#deployments): This server, equipped with a set of standardized APIs, streamlines access to both SaaS and OSS LLM models. It serves as a unified interface, bolstering security through authenticated access, and offers a common set of APIs for prominent LLMs. + +- [Evaluate](https://mlflow.org/docs/latest/models.html#model-evaluation): Designed for in-depth model analysis, this set of tools facilitates objective model comparison, be it traditional ML algorithms or cutting-edge LLMs. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +- [Prompt Engineering UI](https://mlflow.org/docs/latest/llms/prompt-engineering/index.html#prompt-engineering): A dedicated environment for prompt engineering, this UI-centric component provides a space for prompt experimentation, refinement, evaluation, testing, and deployment. -2. Run: +- [Recipes](https://mlflow.org/docs/latest/recipes.html#recipes): Serving as a guide for structuring ML projects, Recipes, while offering recommendations, are focused on ensuring functional end results optimized for real-world deployment scenarios. -Specify a port in your host so that you can access the Web UI at 127.0.0.1:{YOUR_PORT}. -```shell -docker run -it --name mlflow -p {YOUR_PORT}:5000 openeuler/mlflow:{TAG} +- [Projects](https://mlflow.org/docs/latest/projects.html#projects): MLflow Projects standardize the packaging of ML code, workflows, and artifacts, akin to an executable. Each project, be it a directory with code or a Git repository, employs a descriptor or convention to define its dependencies and execution method. + +Learn more on [MLflow website](https://mlflow.org/docs/latest/introduction/index.html). +# Supported tags and respective Dockerfile links +The tag of each mlflow docker image is consist of the version of redis and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[2.11.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.1/22.03-lts-sp3/Dockerfile)| MLflow 2.11.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | +|[2.13.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.13.1/22.03-lts-sp3/Dockerfile)| MLflow 2.13.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` based on their requirements. + +- Pull the `openeuler/mlflow` image from docker +```bash +docker pull openeuler/mlflow:{Tag} ``` +- Start a mlflow instance -If you want to store the data permanently, use parameter ```-v``` to specify a volume such as ```mlruns```. -```shell -docker run -it --name mlflow -p {YOUR_PORT}:5000 -v mlruns:/mlflow openeuler/mlflow:{TAG} +```bash +docker run -d --name my-mlflow -p 5000:5000 openeuler/mlflow:{Tag} ``` +After the instance `my-mlflow` is started, access the mlflow service through `http://localhost:5000`. -# Supported tags and respective Dockerfile links +- View container running logs -- 2.11.1-oe2203sp3: mlflow v2.11.1, openEuler 22.03-LTS-SP3 +```bash +docker logs -f my-mlflow +``` +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +```bash +docker exec -it my-mlflow /bin/bash +``` +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/mlflow/doc/image-info.yml b/mlflow/doc/image-info.yml index 3f305a3e..f1031401 100644 --- a/mlflow/doc/image-info.yml +++ b/mlflow/doc/image-info.yml @@ -11,7 +11,8 @@ tags: | | Tag | Currently | Architectures | |----------|-------------|------------------| - |[2.11.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.0/22.03-lts-sp3/Dockerfile)| MLflow 2.11.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + |[2.11.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.1/22.03-lts-sp3/Dockerfile)| MLflow 2.11.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + |[2.13.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.13.1/22.03-lts-sp3/Dockerfile)| MLflow 2.13.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | download: | 拉取镜像到本地 diff --git a/mlflow/meta.yml b/mlflow/meta.yml index 9e162829..c7ee2f0b 100644 --- a/mlflow/meta.yml +++ b/mlflow/meta.yml @@ -1,2 +1,5 @@ 2.11.1-oe2203sp3: - mlflow/2.11.1/22.03-lts-sp3/Dockerfile \ No newline at end of file + mlflow/2.11.1/22.03-lts-sp3/Dockerfile + +2.13.1-oe2203sp3: + mlflow/2.13.1/22.03-lts-sp3/Dockerfile \ No newline at end of file diff --git a/nginx/README.md b/nginx/README.md index ba26a710..9b0d720a 100644 --- a/nginx/README.md +++ b/nginx/README.md @@ -1,32 +1,63 @@ -# Nginx - # Quick reference - The official Nginx docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). + +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Nginx | openEuler +Current Nginx docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. + +Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer, HTTP cache, and a web server (origin server). The nginx project started with a strong focus on high concurrency, high performance and low memory usage. It is licensed under the 2-clause BSD-like license and it runs on Linux, BSD variants, Mac OS X, Solaris, AIX, HP-UX, as well as on other *nix flavors. It also has a proof of concept port for Microsoft Windows. Learn more on [https://en.wikipedia.org/wiki/Nginx](https://en.wikipedia.org/wiki/Nginx)⁠. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +Features: +- Nginx is easy to configure in order to serve static [web content](https://en.wikipedia.org/wiki/Web_content) or to act as a [proxy server](https://en.wikipedia.org/wiki/Proxy_server). -# Build reference +- Nginx can be deployed to also serve [dynamic content](https://en.wikipedia.org/wiki/Dynamic_web_pagehttps://en.wikipedia.org/wiki/Dynamic_web_page) on the network using [FastCGI](https://en.wikipedia.org/wiki/FastCGI), [SCGI](https://en.wikipedia.org/wiki/Simple_Common_Gateway_Interface) handlers for [scripts](https://en.wikipedia.org/wiki/Scripting_languagehttps://en.wikipedia.org/wiki/Scripting_language), [WSGI](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) application servers or [Phusion Passenger](https://en.wikipedia.org/wiki/Phusion_Passenger) modules, and can serve as a software load balancer[load balancer](https://en.wikipedia.org/wiki/Load_balancing_%28computing%29). -1. Build images and push: -```shell -docker buildx build -t "openeuler/nginx:$VERSION" --platform linux/amd64,linux/arm64 . --push +- Nginx uses an [asynchronous](https://en.wikipedia.org/wiki/Asynchronous_system) [event-driven](https://en.wikipedia.org/wiki/Event_%28computing%29) approach, rather than threads, to handle requests. Nginx's modular [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture) can provide predictable performance under high loads. +# Supported tags and respective Dockerfile links +The tag of each `nginx` docker image is consist of the version of `nginx` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | + |----------|-------------|------------------| + |[1.16.1-oe2003sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.16.1/20.03-lts-sp1/Dockerfile)| Nginx 1.16.1 on openEuler 20.03-LTS-SP1 | amd64, arm64 | + |[1.21.5-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.21.5/22.03-lts/Dockerfile)| Nginx 1.21.5 on openEuler 22.03-LTS | amd64, arm64 | + |[1.25.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.25.4/22.03-lts-sp3/Dockerfile)| Nginx 1.25.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/nginx` image from docker +```bash +docker pull openeuler/nginx:{Tag} ``` -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +- Start a nginx instance -2. Run: -```shell -docker run -d openeuler/nginx:$VERSION +```bash +docker run -d --name my-nginx -p 8080:80 openeuler/nginx:{Tag} ``` +After the instance `my-nginx` is started, access the Nginx service through `http://localhost:8080`. -# Supported tags and respective Dockerfile links +- View container running logs + +```bash +docker logs -f my-nginx +``` + +- To get an interactive shell + +```bash +docker exec -it my-nginx /bin/bash +``` -- 1.16.1-oe2003sp1: nginx v1.16.1, openEuler 20.03 LTS SP1 -- 1.21.5-oe2203lts: nginx v1.21.5, openEuler 22.03 LTS -- 1.25.4-oe2203sp3: nginx v1.25.4, openEuler 22.03 LTS SP3 +- Container startup options -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +| Option | Description | +|--|--| +| -p 8080:80 | Expose nginx on `localhost:8080`. | +| -v /local/path/to/website:/var/www/html | Mount local web pages for service | +| -v /path/to/conf.template:/etc/nginx/templates/conf.template | Mount the template file to `/etc/nginx/templates` | +| v /path/to/nginx.conf:/etc/nginx/nginx.conf | Use a local configuration file | +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/redis/README.md b/redis/README.md index be582e08..f8e3ab74 100644 --- a/redis/README.md +++ b/redis/README.md @@ -1,52 +1,99 @@ -#redis +# Quick reference +- The official Redis docker image. -# Quick reference +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). + +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Redis | openEuler +Current Redis docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. + +Redis is the world’s fastest in-memory database. It provides cloud and on-prem solutions for caching, vector search, and NoSQL databases that seamlessly fit into any tech stack—making it simple for digital customers to build, scale, and deploy the fast apps our world runs on. Learn more on the [Redis website](https://redis.io/about/)⁠. + +- License +Starting on March 20th, 2024, Redis follows a dual-licensing model with the choice of the [Redis Source Available License v2 - RSALv2](https://redis.io/legal/rsalv2-agreement/)⁠ or the [Server Side Public License v1 - SSPLv1](https://redis.io/legal/server-side-public-license-sspl/)⁠. Older versions of Redis (<=7.2.4) are licensed under ⁠[3-Clause BSD](https://opensource.org/license/bsd-3-clause). -- The official redis docker image. +Please also view the ⁠[Redis License Overview](https://redis.io/legal/licenses/) and the [Redis Trademark Policy](https://redis.io/legal/trademark-policy/)⁠. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Redis data structures -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) + - [strings](https://redis.io/docs/latest/develop/data-types/strings/) + - [hashes](https://redis.io/docs/latest/develop/data-types/hashes/) + - [lists](https://redis.io/glossary/lists-in-redis/) + - [sets](https://redis.io/docs/latest/develop/data-types/sets/) + - [sorted-sets](https://redis.io/docs/latest/develop/data-types/sorted-sets/) + - [bitmaps](https://redis.io/docs/latest/develop/data-types/bitmaps/) + - [hyperloglogs](https://redis.io/docs/latest/develop/data-types/probabilistic/hyperloglogs/) + - [geospatial-indexes](https://redis.io/glossary/geospatial-indexing/) + - [streams](https://redis.io/docs/latest/develop/data-types/streams/) -# Build reference +- Redis data persistences + + - [dumping the dataset to disk](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#snapshotting) + - [appending each command to a disk-based log](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#append-only-file) +# Supported tags and respective Dockerfile links +The tag of each redis docker image is consist of the version of redis and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[6.2.7-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/6.2.7/22.03-lts/Dockerfile)| Redis 6.2.7 on openEuler 22.03-LTS | amd64, arm64 | + |[7.2.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/7.2.4/22.03-lts-sp3/Dockerfile)| Redis 7.2.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/redis` image from docker +```bash +docker pull openeuler/redis:{Tag} +``` +- Start a redis instance -1. Build images and push: +```bash +docker run -d --name my-redis -p 6379:6379 openeuler/redis:{Tag} +``` +- Start with persistent storage +As follows, this will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed. ```shell -docker buildx build -t "openeuler/redis:$VERSION" --platform linux/amd64,linux/arm64 . --push +docker run --name my-redis -d openeuler/redis:{Tag} redis-server --save 60 1 --loglevel warning ``` -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +- View container running logs -# How to use this image -## start a redis instance -```shell -docker run --name my-redis -d openeuler/redis:{TAG} +```bash +docker logs -f my-redis ``` +- To get an interactive shell -## Start with persistent storage -```shell -docker run --name my-redis -d openeuler/redis:{TAG} redis-server --save 60 1 --loglevel warning +```bash +docker exec -it my-redis /bin/bash ``` -As shows above, this will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed. -## connect to a redis instance +- Connect to a redis instance + Connect to a local redis instance using loopback address ```shell -docker run --name my-redis -d -p 6379:6379 openeuler/redis:{TAG} +docker run --name my-redis -d -p 6379:6379 openeuler/redis:{Tag} redis-cli -h 127.0.0.1 -p 6379 ``` - If you want connect the redis instance using hostip, you should connect to the instance using loopback, and then configure as belows -```shell + +```bash config set protected-mode no ``` -# Supported tags and respective Dockerfile links +- Container startup options + +| Option | Description | +|--|--| +| `-p 6379:6379` | Expose redis on `localhost:6379`. | +| `-e ALLOW_EMPTY_PASSWORD=yes` | Set to `yes` to allow connections to redis-server without a password. **This setting is not recommended in production environments**. | +| `-e REDIS_PASSWORD` | Set the desired password to be used. | +| `-e REDIS_RANDOM_PASSWORD=1` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`). | +| `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only). | +| `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it. | +| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Local [configuration file](https://redis.io/docs/latest/operate/oss_and_stack/management/config/) `redis.conf` (try [this example](https://git.launchpad.net/~ubuntu-docker-images/ubuntu-docker-images/+git/redis/plain/examples/config/redis.conf?h=6.2-22.04)⁠). **To enable TLS** mode, comment the `port 6379` line and uncomment the `# port 0` and `# tls-port 6379` lines. | + -- 6.2.7-oe2203lts: redis v{TAG}, openEuler 22.03 LTS -- 7.2.4-oe2203sp3: redis v7.2.4, openEuler 22.03 LTS SP3 -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee From a21f4746c642d80a68469639890ee9c3deca9f98 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 13 Jun 2024 16:17:09 +0800 Subject: [PATCH 02/14] readme: local commit --- mlflow/README.md | 7 +++++++ nginx/README.md | 29 ++++++++++++++++++----------- redis/README.md | 31 +++++++++++++++++-------------- 3 files changed, 42 insertions(+), 25 deletions(-) diff --git a/mlflow/README.md b/mlflow/README.md index dcd47cc5..e218a1cb 100644 --- a/mlflow/README.md +++ b/mlflow/README.md @@ -5,6 +5,8 @@ - Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). + + # Redis | openEuler Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -25,6 +27,8 @@ MLflow, at its core, provides a suite of tools aimed at simplifying the ML workf - [Projects](https://mlflow.org/docs/latest/projects.html#projects): MLflow Projects standardize the packaging of ML code, workflows, and artifacts, akin to an executable. Each project, be it a directory with code or a Git repository, employs a descriptor or convention to define its dependencies and execution method. Learn more on [MLflow website](https://mlflow.org/docs/latest/introduction/index.html). + + # Supported tags and respective Dockerfile links The tag of each mlflow docker image is consist of the version of redis and the version of basic image. The details are as follows | Tags | Currently | Architectures| @@ -32,6 +36,7 @@ The tag of each mlflow docker image is consist of the version of redis and the v |[2.11.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.1/22.03-lts-sp3/Dockerfile)| MLflow 2.11.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | |[2.13.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.13.1/22.03-lts-sp3/Dockerfile)| MLflow 2.13.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + # Usage In this usage, users can select the corresponding `{Tag}` based on their requirements. @@ -56,5 +61,7 @@ docker logs -f my-mlflow ```bash docker exec -it my-mlflow /bin/bash ``` + + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/nginx/README.md b/nginx/README.md index 9b0d720a..02ca934e 100644 --- a/nginx/README.md +++ b/nginx/README.md @@ -5,6 +5,8 @@ - Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). + + # Nginx | openEuler Current Nginx docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -16,13 +18,16 @@ Features: - Nginx can be deployed to also serve [dynamic content](https://en.wikipedia.org/wiki/Dynamic_web_pagehttps://en.wikipedia.org/wiki/Dynamic_web_page) on the network using [FastCGI](https://en.wikipedia.org/wiki/FastCGI), [SCGI](https://en.wikipedia.org/wiki/Simple_Common_Gateway_Interface) handlers for [scripts](https://en.wikipedia.org/wiki/Scripting_languagehttps://en.wikipedia.org/wiki/Scripting_language), [WSGI](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) application servers or [Phusion Passenger](https://en.wikipedia.org/wiki/Phusion_Passenger) modules, and can serve as a software load balancer[load balancer](https://en.wikipedia.org/wiki/Load_balancing_%28computing%29). - Nginx uses an [asynchronous](https://en.wikipedia.org/wiki/Asynchronous_system) [event-driven](https://en.wikipedia.org/wiki/Event_%28computing%29) approach, rather than threads, to handle requests. Nginx's modular [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture) can provide predictable performance under high loads. + + # Supported tags and respective Dockerfile links The tag of each `nginx` docker image is consist of the version of `nginx` and the version of basic image. The details are as follows | Tag | Currently | Architectures | - |----------|-------------|------------------| - |[1.16.1-oe2003sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.16.1/20.03-lts-sp1/Dockerfile)| Nginx 1.16.1 on openEuler 20.03-LTS-SP1 | amd64, arm64 | - |[1.21.5-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.21.5/22.03-lts/Dockerfile)| Nginx 1.21.5 on openEuler 22.03-LTS | amd64, arm64 | - |[1.25.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.25.4/22.03-lts-sp3/Dockerfile)| Nginx 1.25.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | +|----------|-------------|------------------| +|[1.16.1-oe2003sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.16.1/20.03-lts-sp1/Dockerfile)| Nginx 1.16.1 on openEuler 20.03-LTS-SP1 | amd64, arm64 | +|[1.21.5-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.21.5/22.03-lts/Dockerfile)| Nginx 1.21.5 on openEuler 22.03-LTS | amd64, arm64 | +|[1.25.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/nginx/1.25.4/22.03-lts-sp3/Dockerfile)| Nginx 1.25.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + # Usage In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. @@ -39,6 +44,15 @@ docker run -d --name my-nginx -p 8080:80 openeuler/nginx:{Tag} ``` After the instance `my-nginx` is started, access the Nginx service through `http://localhost:8080`. +- Container startup options + +| Option | Description | +|--|--| +| -p 8080:80 | Expose nginx on `localhost:8080`. | +| -v /local/path/to/website:/var/www/html | Mount and serve a local website. | +| -v /path/to/conf.template:/etc/nginx/templates/conf.template | Mount template files inside `/etc/nginx/templates`. They will be processed and the results will be placed at `/etc/nginx/conf.d`. (e.g. `listen ${NGINX_PORT}`; will generate `listen 80`;). | +| v /path/to/nginx.conf:/etc/nginx/nginx.conf | Local [configuration file](https://nginx.org/en/docs/)⁠ `nginx.conf`. | + - View container running logs ```bash @@ -51,13 +65,6 @@ docker logs -f my-nginx docker exec -it my-nginx /bin/bash ``` -- Container startup options -| Option | Description | -|--|--| -| -p 8080:80 | Expose nginx on `localhost:8080`. | -| -v /local/path/to/website:/var/www/html | Mount local web pages for service | -| -v /path/to/conf.template:/etc/nginx/templates/conf.template | Mount the template file to `/etc/nginx/templates` | -| v /path/to/nginx.conf:/etc/nginx/nginx.conf | Use a local configuration file | # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/redis/README.md b/redis/README.md index f8e3ab74..aa78d373 100644 --- a/redis/README.md +++ b/redis/README.md @@ -5,6 +5,8 @@ - Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). + + # Redis | openEuler Current Redis docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -31,12 +33,15 @@ Please also view the ⁠[Redis License Overview](https://redis.io/legal/licenses - [dumping the dataset to disk](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#snapshotting) - [appending each command to a disk-based log](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#append-only-file) + + # Supported tags and respective Dockerfile links The tag of each redis docker image is consist of the version of redis and the version of basic image. The details are as follows | Tags | Currently | Architectures| |--|--|--| |[6.2.7-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/6.2.7/22.03-lts/Dockerfile)| Redis 6.2.7 on openEuler 22.03-LTS | amd64, arm64 | - |[7.2.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/7.2.4/22.03-lts-sp3/Dockerfile)| Redis 7.2.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | +|[7.2.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/7.2.4/22.03-lts-sp3/Dockerfile)| Redis 7.2.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + # Usage In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. @@ -56,17 +61,6 @@ As follows, this will save a snapshot of the DB every 60 seconds if at least 1 w docker run --name my-redis -d openeuler/redis:{Tag} redis-server --save 60 1 --loglevel warning ``` -- View container running logs - -```bash -docker logs -f my-redis -``` -- To get an interactive shell - -```bash -docker exec -it my-redis /bin/bash -``` - - Connect to a redis instance Connect to a local redis instance using loopback address @@ -85,15 +79,24 @@ config set protected-mode no | Option | Description | |--|--| -| `-p 6379:6379` | Expose redis on `localhost:6379`. | +| `-p 6379:6379` | Expose Redis server on `localhost:6379`. | | `-e ALLOW_EMPTY_PASSWORD=yes` | Set to `yes` to allow connections to redis-server without a password. **This setting is not recommended in production environments**. | | `-e REDIS_PASSWORD` | Set the desired password to be used. | | `-e REDIS_RANDOM_PASSWORD=1` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`). | | `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only). | | `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it. | -| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Local [configuration file](https://redis.io/docs/latest/operate/oss_and_stack/management/config/) `redis.conf` (try [this example](https://git.launchpad.net/~ubuntu-docker-images/ubuntu-docker-images/+git/redis/plain/examples/config/redis.conf?h=6.2-22.04)⁠). **To enable TLS** mode, comment the `port 6379` line and uncomment the `# port 0` and `# tls-port 6379` lines. | +| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Local [configuration file](https://redis.io/docs/latest/operate/oss_and_stack/management/config/) `redis.conf`. **To enable TLS** mode, comment the `port 6379` line and uncomment the `# port 0` and `# tls-port 6379` lines. | +- View container running logs + +```bash +docker logs -f my-redis +``` +- To get an interactive shell +```bash +docker exec -it my-redis /bin/bash +``` # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee From e0fa40cb3f02d0f8210195d9bbce9a74a4ba9ebf Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Mon, 17 Jun 2024 19:43:09 +0800 Subject: [PATCH 03/14] spark: submit readme --- spark/3.5.1/24.03-lts/Dockerfile | 82 ++++++++++++++++++ spark/3.5.1/24.03-lts/entrypoint.sh | 130 ++++++++++++++++++++++++++++ spark/README.md | 76 +++++++++++----- spark/doc/image-info.yml | 1 + spark/meta.yml | 11 ++- 5 files changed, 275 insertions(+), 25 deletions(-) create mode 100644 spark/3.5.1/24.03-lts/Dockerfile create mode 100644 spark/3.5.1/24.03-lts/entrypoint.sh diff --git a/spark/3.5.1/24.03-lts/Dockerfile b/spark/3.5.1/24.03-lts/Dockerfile new file mode 100644 index 00000000..1da7e5ab --- /dev/null +++ b/spark/3.5.1/24.03-lts/Dockerfile @@ -0,0 +1,82 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +FROM openeuler/openeuler:22.03-lts + +ARG spark_uid=185 + + +RUN set -ex && \ + dnf update -y && \ + ln -s /lib /lib64 && \ + dnf install -y gnupg2 wget bash krb5 procps net-tools shadow dpkg java-11-openjdk && \ + groupadd --system --gid=${spark_uid} spark && \ + useradd --system --uid=${spark_uid} --gid=spark spark && \ + dnf install -y python3 python3-pip && \ + mkdir -p /opt/spark && \ + mkdir /opt/spark/python && \ + mkdir -p /opt/spark/examples && \ + mkdir -p /opt/spark/work-dir && \ + touch /opt/spark/RELEASE && \ + chown -R spark:spark /opt/spark && \ + rm /bin/sh && \ + ln -sv /bin/bash /bin/sh && \ + echo "auth required pam_wheel.so use_uid" >> /etc/pam.d/su && \ + chgrp root /etc/passwd && chmod ug+rw /etc/passwd && \ + rm -rf /var/cache/dnf/* + +# Grab gosu for easy step-down from root +ENV GOSU_VERSION 1.14 +RUN set -ex; \ + wget -nv -O /usr/local/bin/gosu "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$(dpkg --print-architecture)"; \ + chmod +x /usr/local/bin/gosu; \ + gosu nobody true +# Install Apache Spark +# https://downloads.apache.org/spark/KEYS +ENV SPARK_TGZ_URL=https://archive.apache.org/dist/spark/spark-3.5.1/spark-3.5.1-bin-hadoop3.tgz \ + SPARK_TGZ_ASC_URL=https://archive.apache.org/dist/spark/spark-3.5.1/spark-3.5.1-bin-hadoop3.tgz.asc + +RUN set -ex; \ + export SPARK_TMP="$(mktemp -d)"; \ + cd $SPARK_TMP; \ + wget -nv -O spark.tgz "$SPARK_TGZ_URL"; \ + \ + tar -xf spark.tgz --strip-components=1; \ + chown -R spark:spark .; \ + mv jars /opt/spark/; \ + mv bin /opt/spark/; \ + mv sbin /opt/spark/; \ + mv kubernetes/dockerfiles/spark/decom.sh /opt/; \ + mv examples /opt/spark/; \ + mv kubernetes/tests /opt/spark/; \ + mv data /opt/spark/; \ + mv python/pyspark /opt/spark/python/pyspark/; \ + mv python/lib /opt/spark/python/lib/; \ + mv R /opt/spark/; \ + chmod a+x /opt/decom.sh; \ + cd ..; \ + rm -rf "$SPARK_TMP"; + +COPY entrypoint.sh /opt/ + +ENV SPARK_HOME /opt/spark + +WORKDIR /opt/spark/work-dir +RUN chmod g+w /opt/spark/work-dir +RUN chmod a+x /opt/decom.sh +RUN chmod a+x /opt/entrypoint.sh + +ENTRYPOINT [ "/opt/entrypoint.sh" ] diff --git a/spark/3.5.1/24.03-lts/entrypoint.sh b/spark/3.5.1/24.03-lts/entrypoint.sh new file mode 100644 index 00000000..6a5c6d2d --- /dev/null +++ b/spark/3.5.1/24.03-lts/entrypoint.sh @@ -0,0 +1,130 @@ +#!/bin/bash +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Prevent any errors from being silently ignored +set -eo pipefail + +attempt_setup_fake_passwd_entry() { + # Check whether there is a passwd entry for the container UID + local myuid; myuid="$(id -u)" + # If there is no passwd entry for the container UID, attempt to fake one + # You can also refer to the https://github.com/docker-library/official-images/pull/13089#issuecomment-1534706523 + # It's to resolve OpenShift random UID case. + # See also: https://github.com/docker-library/postgres/pull/448 + if ! getent passwd "$myuid" &> /dev/null; then + local wrapper + for wrapper in {/usr,}/lib{/*,}/libnss_wrapper.so; do + if [ -s "$wrapper" ]; then + NSS_WRAPPER_PASSWD="$(mktemp)" + NSS_WRAPPER_GROUP="$(mktemp)" + export LD_PRELOAD="$wrapper" NSS_WRAPPER_PASSWD NSS_WRAPPER_GROUP + local mygid; mygid="$(id -g)" + printf 'spark:x:%s:%s:${SPARK_USER_NAME:-anonymous uid}:%s:/bin/false\n' "$myuid" "$mygid" "$SPARK_HOME" > "$NSS_WRAPPER_PASSWD" + printf 'spark:x:%s:\n' "$mygid" > "$NSS_WRAPPER_GROUP" + break + fi + done + fi +} + +if [ -z "$JAVA_HOME" ]; then + JAVA_HOME=$(java -XshowSettings:properties -version 2>&1 > /dev/null | grep 'java.home' | awk '{print $3}') +fi + +SPARK_CLASSPATH="$SPARK_CLASSPATH:${SPARK_HOME}/jars/*" +for v in "${!SPARK_JAVA_OPT_@}"; do + SPARK_EXECUTOR_JAVA_OPTS+=( "${!v}" ) +done + +if [ -n "$SPARK_EXTRA_CLASSPATH" ]; then + SPARK_CLASSPATH="$SPARK_CLASSPATH:$SPARK_EXTRA_CLASSPATH" +fi + +if ! [ -z "${PYSPARK_PYTHON+x}" ]; then + export PYSPARK_PYTHON +fi +if ! [ -z "${PYSPARK_DRIVER_PYTHON+x}" ]; then + export PYSPARK_DRIVER_PYTHON +fi + +# If HADOOP_HOME is set and SPARK_DIST_CLASSPATH is not set, set it here so Hadoop jars are available to the executor. +# It does not set SPARK_DIST_CLASSPATH if already set, to avoid overriding customizations of this value from elsewhere e.g. Docker/K8s. +if [ -n "${HADOOP_HOME}" ] && [ -z "${SPARK_DIST_CLASSPATH}" ]; then + export SPARK_DIST_CLASSPATH="$($HADOOP_HOME/bin/hadoop classpath)" +fi + +if ! [ -z "${HADOOP_CONF_DIR+x}" ]; then + SPARK_CLASSPATH="$HADOOP_CONF_DIR:$SPARK_CLASSPATH"; +fi + +if ! [ -z "${SPARK_CONF_DIR+x}" ]; then + SPARK_CLASSPATH="$SPARK_CONF_DIR:$SPARK_CLASSPATH"; +elif ! [ -z "${SPARK_HOME+x}" ]; then + SPARK_CLASSPATH="$SPARK_HOME/conf:$SPARK_CLASSPATH"; +fi + +# SPARK-43540: add current working directory into executor classpath +SPARK_CLASSPATH="$SPARK_CLASSPATH:$PWD" + +# Switch to spark if no USER specified (root by default) otherwise use USER directly +switch_spark_if_root() { + if [ $(id -u) -eq 0 ]; then + echo gosu spark + fi +} + +case "$1" in + driver) + shift 1 + CMD=( + "$SPARK_HOME/bin/spark-submit" + --conf "spark.driver.bindAddress=$SPARK_DRIVER_BIND_ADDRESS" + --conf "spark.executorEnv.SPARK_DRIVER_POD_IP=$SPARK_DRIVER_BIND_ADDRESS" + --deploy-mode client + "$@" + ) + attempt_setup_fake_passwd_entry + # Execute the container CMD under tini for better hygiene + exec $(switch_spark_if_root) /usr/bin/tini -s -- "${CMD[@]}" + ;; + executor) + shift 1 + CMD=( + ${JAVA_HOME}/bin/java + "${SPARK_EXECUTOR_JAVA_OPTS[@]}" + -Xms"$SPARK_EXECUTOR_MEMORY" + -Xmx"$SPARK_EXECUTOR_MEMORY" + -cp "$SPARK_CLASSPATH:$SPARK_DIST_CLASSPATH" + org.apache.spark.scheduler.cluster.k8s.KubernetesExecutorBackend + --driver-url "$SPARK_DRIVER_URL" + --executor-id "$SPARK_EXECUTOR_ID" + --cores "$SPARK_EXECUTOR_CORES" + --app-id "$SPARK_APPLICATION_ID" + --hostname "$SPARK_EXECUTOR_POD_IP" + --resourceProfileId "$SPARK_RESOURCE_PROFILE_ID" + --podName "$SPARK_EXECUTOR_POD_NAME" + ) + attempt_setup_fake_passwd_entry + # Execute the container CMD under tini for better hygiene + exec $(switch_spark_if_root) /usr/bin/tini -s -- "${CMD[@]}" + ;; + + *) + # Non-spark-on-k8s command provided, proceeding in pass-through mode... + exec "$@" + ;; +esac \ No newline at end of file diff --git a/spark/README.md b/spark/README.md index 6c64cd52..ae4976c7 100644 --- a/spark/README.md +++ b/spark/README.md @@ -1,32 +1,66 @@ -# Spark - # Quick reference -- The Apache Spark docker image. +- The official Spark docker image. + +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Spark | openEuler +Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +Apache Spark is a multi-language engine for executing data engineering, data science, and machine learning on single-node machines or clusters. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, pandas API on Spark for pandas workloads, MLlib for machine learning, GraphX for graph processing, and Structured Streaming for stream processing. -# Build reference +Learn more on [Spark website](https://spark.apache.org/). +# Supported tags and respective Dockerfile links +The tag of each spark docker image is consist of the version of spark and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[3.3.1-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.3.1/22.03-lts/Dockerfile)| spark 3.3.1 on openEuler 22.03-LTS | amd64, arm64 | +|[3.3.2-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.3.2/22.03-lts/Dockerfile)| spark 3.3.2 on openEuler 22.03-LTS | amd64, arm64 | +|[3.4.0-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.4.0/22.03-lts/Dockerfile)| spark 3.4.0 on openEuler 22.03-LTS | amd64, arm64 | +|[3.5.1-24.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.5.1/24.03-lts/Dockerfile)| spark 3.5.1 on openEuler 24.03-LTS | amd64, arm64 | -1. Build images and push: -```shell -docker buildx build -t "openeuler/spark:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +# Usage +In this usage, users can select the corresponding `{Tag}` based on their requirements. +- Online Documentation +You can find the latest Spark documentation, including a programming guide, on the [project web page](https://spark.apache.org/documentation.html). This README file only contains basic setup instructions. +- Pull the `openeuler/spark` image from docker + ```bash + docker pull openeuler/spark:{Tag} + ``` +- Interactive Scala Shell +The easiest way to start using Spark is through the Scala shell: + ```bash + docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/spark-shell + ``` + Try the following command, which should return 1,000,000,000: + + ```bash + scala> spark.range(1000 * 1000 * 1000).count() + ``` +- Interactive Python Shell +The easiest way to start using PySpark is through the Python shell: + ```bash + docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/pyspark + ``` + And run the following command, which should also return 1,000,000,000: -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) + ```bash + >>> spark.range(1000 * 1000 * 1000).count() + ``` +- Interactive R Shell +The easiest way to start using R on Spark is through the R shell: + + ```bash + docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/sparkR + ``` +- Running Spark on Kubernetes -2. Run: -```shell -docker run -d openeuler/spark:$VERSION -``` + [https://spark.apache.org/docs/latest/running-on-kubernetes.html⁠](https://spark.apache.org/docs/latest/running-on-kubernetes.html). +- Configuration and environment variables -# Supported tags and respective Dockerfile links + See more in [https://github.com/apache/spark-docker/blob/master/OVERVIEW.md#environment-variable](https://github.com/apache/spark-docker/blob/master/OVERVIEW.md#environment-variable). -- 3.3.1-22.03-lts: spark 3.3.1, openEuler 22.03 LTS -- 3.3.2-22.03-lts: spark 3.3.2, openEuler 22.03 LTS -- 3.4.0-22.03-lts: spark 3.4.0, openEuler 22.03 LTS -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/spark/doc/image-info.yml b/spark/doc/image-info.yml index 97c17fff..b48d0b07 100644 --- a/spark/doc/image-info.yml +++ b/spark/doc/image-info.yml @@ -14,6 +14,7 @@ tags: | |[3.3.1-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.3.1/22.03-lts/Dockerfile)| spark 3.3.1 on openEuler 22.03-LTS | amd64, arm64 | |[3.3.2-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.3.2/22.03-lts/Dockerfile)| spark 3.3.2 on openEuler 22.03-LTS | amd64, arm64 | |[3.4.0-22.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.4.0/22.03-lts/Dockerfile)| spark 3.4.0 on openEuler 22.03-LTS | amd64, arm64 | + |[3.5.1-24.03-lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/spark/3.5.1/24.03-lts/Dockerfile)| spark 3.5.1 on openEuler 24.03-LTS | amd64, arm64 | download: | 拉取镜像到本地 diff --git a/spark/meta.yml b/spark/meta.yml index a6ca5578..b9c31aef 100644 --- a/spark/meta.yml +++ b/spark/meta.yml @@ -1,8 +1,11 @@ -1.16.1-oe2203lts: +3.3.1-oe2203lts: spark/3.3.1/22.03-lts/Dockerfile -1.21.5-oe2203lts: +3.3.2-oe2203lts: spark/3.3.2/22.03-lts/Dockerfile -1.25.4-oe2203lts: - spark/3.4.0/22.03-lts/Dockerfile \ No newline at end of file +3.4.0-oe2203lts: + spark/3.4.0/22.03-lts/Dockerfile + +3.5.1-oe2203lts: + spark/3.5.1/22.03-lts/Dockerfile \ No newline at end of file -- Gitee From 80c558abb083b29281e65dcab9a19c0bb9944cbe Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Mon, 17 Jun 2024 20:17:10 +0800 Subject: [PATCH 04/14] mysql: submit readme for docker overview --- mlflow/README.md | 4 +-- mysql/README.md | 72 ++++++++++++++++++++++++++++++++++-------------- spark/README.md | 2 +- 3 files changed, 54 insertions(+), 24 deletions(-) diff --git a/mlflow/README.md b/mlflow/README.md index e218a1cb..e6d2a667 100644 --- a/mlflow/README.md +++ b/mlflow/README.md @@ -7,7 +7,7 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -# Redis | openEuler +# MLflow | openEuler Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. MLflow, at its core, provides a suite of tools aimed at simplifying the ML workflow. It is tailored to assist ML practitioners throughout the various stages of ML development and deployment. Despite its expansive offerings, MLflow’s functionalities are rooted in several foundational components: @@ -30,7 +30,7 @@ Learn more on [MLflow website](https://mlflow.org/docs/latest/introduction/index # Supported tags and respective Dockerfile links -The tag of each mlflow docker image is consist of the version of redis and the version of basic image. The details are as follows +The tag of each mlflow docker image is consist of the version of mlflow and the version of basic image. The details are as follows | Tags | Currently | Architectures| |--|--|--| |[2.11.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.1/22.03-lts-sp3/Dockerfile)| MLflow 2.11.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | diff --git a/mysql/README.md b/mysql/README.md index c4412d6a..3df51563 100644 --- a/mysql/README.md +++ b/mysql/README.md @@ -1,31 +1,61 @@ -# MySQL - # Quick reference -- The official mysql docker image. +- The official MySQL docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -# Build reference -1. Build images and push: -```shell -docker buildx build -t "openeuler/mysql:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# MySQL | openEuler +Current MySQL docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Learn more on [MySQL website](). -2. Run: -```shell -docker run -d --name my-mysql -p 30306:3306 -e MYSQL_ROOT_PASSWORD=openEuler:S3cr3t/ openeuler/mysql:{Tag} -``` -where `mysql` is the name you want to assign to your container, `openEuler:S3cr3t/` is the password to be set for the MySQL root user. # Supported tags and respective Dockerfile links - -- 8.3.0-oe2203sp3: mysql v8.3.0, openEuler 22.03 LTS SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each mlflow docker image is consist of the version of mysql and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[8.3.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mysql/8.3.0/22.03-lts-sp3/Dockerfile)| MySQL server 8.3.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/mysql` image from docker + ```bash + docker pull openeuler/mysql:{Tag} + ``` +- Start a mysql instance + + ```bash + docker run -d --name my-mysql -p 30306:3306 -e MYSQL_ROOT_PASSWORD=openEuler:S3cr3t/ openeuler/mysql:{Tag} + ``` + After the instance `my-mysql` is started, access the mysql service through `http://localhost:30306`. + +- Container startup options + | Option | Description | + |--|--| + | -p 30306:3306 | Expose MySQL server on `localhost:30306`. | + | -e MYSQL_ROOT_PASSWORD | Set the password for the `root` user. This option is **mandatory** and **must not be empty**. | + | -e MYSQL_USER | Create a new user with superuser privileges. This is used in conjunction with `MYSQL_PASSWORD`. | + | -e MYSQL_DATABASE | Set the name of the default database. | + | -e MYSQL_ALLOW_EMPTY_PASSWORD=yes | Set up a blank password for the root user. **This is not recommended to be used in production, make sure you know what you are doing**. | + | -e MYSQL_RANDOM_ROOT_PASSWORD=yes | Generate a random initial password for the `root` user using `pwgen`. It will be printed in the logs, search for `GENERATED ROOT PASSWORD`. | + | -e MYSQL_ONETIME_PASSWORD=yes | Set `root` user as experide once initialization is complete, forcing a password change on first login. | + | -v /path/to/data:/usr/local/mysql/data/ | Persist data instead of initializing a new database every time you launch a new container. | + | -v /path/to/config/files/:/usr/local/mysql/mysql.conf.d/ | Local [configuration files](https://dev.mysql.com/doc/refman/8.0/en/mysql-command-options.html). | + +- View container running logs + + ```bash + docker logs -f my-mysql + ``` +- To get an interactive shell + + ```bash + docker exec -it my-mysql/bin/bash + ``` +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/spark/README.md b/spark/README.md index ae4976c7..88881a2c 100644 --- a/spark/README.md +++ b/spark/README.md @@ -6,7 +6,7 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). # Spark | openEuler -Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. +Current spark docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. Apache Spark is a multi-language engine for executing data engineering, data science, and machine learning on single-node machines or clusters. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, pandas API on Spark for pandas workloads, MLlib for machine learning, GraphX for graph processing, and Structured Streaming for stream processing. -- Gitee From fd358f416a853eedeeea487f79d5d9bae831eb64 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 09:46:17 +0800 Subject: [PATCH 05/14] spark: not support R --- spark/3.5.1/24.03-lts/Dockerfile | 2 -- 1 file changed, 2 deletions(-) diff --git a/spark/3.5.1/24.03-lts/Dockerfile b/spark/3.5.1/24.03-lts/Dockerfile index 1da7e5ab..b2f1a64a 100644 --- a/spark/3.5.1/24.03-lts/Dockerfile +++ b/spark/3.5.1/24.03-lts/Dockerfile @@ -65,8 +65,6 @@ RUN set -ex; \ mv data /opt/spark/; \ mv python/pyspark /opt/spark/python/pyspark/; \ mv python/lib /opt/spark/python/lib/; \ - mv R /opt/spark/; \ - chmod a+x /opt/decom.sh; \ cd ..; \ rm -rf "$SPARK_TMP"; -- Gitee From 80a58e3e8ef59851b4e76f7fa5c596028a659633 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 09:49:34 +0800 Subject: [PATCH 06/14] spark: do not support run with R shell --- spark/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/spark/README.md b/spark/README.md index 88881a2c..f35d5965 100644 --- a/spark/README.md +++ b/spark/README.md @@ -48,12 +48,6 @@ The easiest way to start using PySpark is through the Python shell: ```bash >>> spark.range(1000 * 1000 * 1000).count() ``` -- Interactive R Shell -The easiest way to start using R on Spark is through the R shell: - - ```bash - docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/sparkR - ``` - Running Spark on Kubernetes [https://spark.apache.org/docs/latest/running-on-kubernetes.html⁠](https://spark.apache.org/docs/latest/running-on-kubernetes.html). -- Gitee From 95b017b78921bd7fa3e2187dee075322016214b6 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 10:07:55 +0800 Subject: [PATCH 07/14] spark: update openeuler version --- spark/3.5.1/24.03-lts/Dockerfile | 2 +- spark/meta.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spark/3.5.1/24.03-lts/Dockerfile b/spark/3.5.1/24.03-lts/Dockerfile index b2f1a64a..77de779b 100644 --- a/spark/3.5.1/24.03-lts/Dockerfile +++ b/spark/3.5.1/24.03-lts/Dockerfile @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -FROM openeuler/openeuler:22.03-lts +FROM openeuler/openeuler:24.03-lts ARG spark_uid=185 diff --git a/spark/meta.yml b/spark/meta.yml index b9c31aef..b4a950c8 100644 --- a/spark/meta.yml +++ b/spark/meta.yml @@ -7,5 +7,5 @@ 3.4.0-oe2203lts: spark/3.4.0/22.03-lts/Dockerfile -3.5.1-oe2203lts: - spark/3.5.1/22.03-lts/Dockerfile \ No newline at end of file +3.5.1-oe2403lts: + spark/3.5.1/24.03-lts/Dockerfile \ No newline at end of file -- Gitee From 1c992fcdb4263ca36434ca33380400cdd94555fb Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 14:51:31 +0800 Subject: [PATCH 08/14] kafka: submit readme --- kafka/README.md | 68 ++++++++++++++++++++++++++++++++++--------------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/kafka/README.md b/kafka/README.md index fb8d0b62..558c2600 100644 --- a/kafka/README.md +++ b/kafka/README.md @@ -1,30 +1,56 @@ -# Kafka - # Quick reference -- The official kafka docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Kafka docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Kafka | openEuler +Current Kafka docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -1. Build images and push: -```shell -docker buildx build -t "openeuler/kafka:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Learn more on [Kafka website](https://kafka.apache.org/). -2. Run: -```shell -docker run -d --name kafka -p 9092:9092 openeuler/kafka:{TAG} -``` # Supported tags and respective Dockerfile links - -- 3.7.0-oe2203sp3: kafka v3.7.0, openEuler 22.03 LTS SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each kafka docker image is consist of the version of kafka and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[3.7.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/kafka/3.7.0/22.03-lts-sp3/Dockerfile)| Apache Kafka server 3.7.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + + +# Usage +In this usage, users can select the corresponding `{Tag}` based on their requirements. + +- Pull the `openeuler/kafka` image from docker + ```bash + docker pull openeuler/kafka:{Tag} + ``` +- Start a kafka instance + + ```bash + docker run -d --name my-kafka -p 9092:9092 openeuler/kafka:{Tag} + ``` + After the instance `my-kafka` is started, access the kafka service through `http://localhost:9092`. + +- Container startup options + | Option | Description | + |--|--| + | `-p 9092:9092` | Expose Apache Kafka server on `localhost:9092`. | + | `-e ZOOKEEPER_HOST=` | Hostname for the related Zookeeper instance. | + | `-e ZOOKEEPER_PORT=2181` | Port for the related Zookeeper instance. | + | `-v /path/to/config/file:/etc/kafka/server.properties` | Local Kafka configuration file. | + | `-v kafkaData:/var/lib/kafka` | "Persist data in a docker volume named `kafkaData`. " "Make sure that the mount point is consistent with the configuration property `logs.dirs`. | + +- View container running logs + ```bash + docker logs -f my-kafka + ``` +- To get an interactive shell + ```bash + docker exec -it my-kafka /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee From c223b70799022753c5582eb37902102b0912ec21 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 15:13:46 +0800 Subject: [PATCH 09/14] readme: batch update docker image name --- kafka/README.md | 2 +- mysql/README.md | 2 +- spark/README.md | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/kafka/README.md b/kafka/README.md index 558c2600..20bf44f1 100644 --- a/kafka/README.md +++ b/kafka/README.md @@ -21,7 +21,7 @@ The tag of each kafka docker image is consist of the version of kafka and the ve # Usage -In this usage, users can select the corresponding `{Tag}` based on their requirements. +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/kafka` image from docker ```bash diff --git a/mysql/README.md b/mysql/README.md index 3df51563..b37f328f 100644 --- a/mysql/README.md +++ b/mysql/README.md @@ -14,7 +14,7 @@ Learn more on [MySQL website](). # Supported tags and respective Dockerfile links -The tag of each mlflow docker image is consist of the version of mysql and the version of basic image. The details are as follows +The tag of each mysql docker image is consist of the version of mysql and the version of basic image. The details are as follows | Tags | Currently | Architectures| |--|--|--| |[8.3.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mysql/8.3.0/22.03-lts-sp3/Dockerfile)| MySQL server 8.3.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | diff --git a/spark/README.md b/spark/README.md index f35d5965..f1917813 100644 --- a/spark/README.md +++ b/spark/README.md @@ -6,11 +6,13 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). # Spark | openEuler -Current spark docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. +Current Spark docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. Apache Spark is a multi-language engine for executing data engineering, data science, and machine learning on single-node machines or clusters. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, pandas API on Spark for pandas workloads, MLlib for machine learning, GraphX for graph processing, and Structured Streaming for stream processing. Learn more on [Spark website](https://spark.apache.org/). + + # Supported tags and respective Dockerfile links The tag of each spark docker image is consist of the version of spark and the version of basic image. The details are as follows | Tags | Currently | Architectures| -- Gitee From d1013782be1b79dcef498e164b2d81d8f0734ce1 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Tue, 18 Jun 2024 17:07:43 +0800 Subject: [PATCH 10/14] grafana:s submit readme --- grafana-agent/README.md | 66 +++++++++++++++++++++++++++------------ grafana/README.md | 68 +++++++++++++++++++++++++++-------------- 2 files changed, 92 insertions(+), 42 deletions(-) diff --git a/grafana-agent/README.md b/grafana-agent/README.md index 72e70549..3144b2cd 100644 --- a/grafana-agent/README.md +++ b/grafana-agent/README.md @@ -1,30 +1,58 @@ -# Grafana-agent - # Quick reference - The official Grafana-agent docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) - -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +# Grafana-agent | openEuler +Current Grafana-agent docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -1. Build images and push: -```shell -docker buildx build -t "openeuler/grafana-agent:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +Grafana Agent is an OpenTelemetry Collector distribution with configuration inspired by [Terraform](https://www.terraform.io/). It is designed to be flexible, performant, and compatible with multiple ecosystems such as Prometheus and OpenTelemetry. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Grafana Agent is based around **components**. Components are wired together to form programmable observability **pipelines** for telemetry collection, processing, and delivery. -2. Run: -```shell -docker run -d openeuler/grafana-agent:$TAG -``` +Grafana Agent can collect, transform, and send data to: -# Supported tags and respective Dockerfile links +- The [Prometheus](https://prometheus.io/) ecosystem +- The [OpenTelemetry](https://opentelemetry.io/) ecosystem +- The Grafana open source ecosystem ([Loki](https://github.com/grafana/loki), [Grafana](https://github.com/grafana/grafana), [Tempo](https://github.com/grafana/tempo), [Mimir](https://github.com/grafana/mimir), [Pyroscope](https://github.com/grafana/pyroscope)) -- 0.40.2-oe2203sp3: grafana-agent v0.40.2, openEuler 22.03-LTS-SP3 +Learn more on [Grafana-agent website](https://grafana.com/docs/agent/latest/). -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +# Supported tags and respective Dockerfile links +The tag of each grafana-agent docker image is consist of the version of grafana-agent and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[0.40.2-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/grafana-agent/0.40.2/22.03-lts-sp3/Dockerfile)| Grafana-agent 0.40.2 on openEuler 22.03-LTS-SP3 | amd64, arm64 | +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/grafana-agent` image from docker + ```bash + docker pull openeuler/grafana-agent:{Tag} + ``` +- Start a grafana-agent instance + + ```bash + docker run -d --name my-grafana-agent -p 12345:12345 openeuler/grafana-agent:{Tag} + ``` + After the instance `my-grafana-agent` is started, access the grafana-agent service through `http://localhost:12345`. + + +- Container startup options + | Option | Description | + |--|--| + | `-p 12345:12345` | Expose Grafana Agent on `localhost:12345`. | + | `-v /path/to/agent/config.yaml:/etc/agent/agent.yaml` | Local configuration file `agent.yml`. | + +- View container running logs + ```bash + docker logs -f my-grafana-agent + ``` +- To get an interactive shell + ```bash + docker exec -it my-grafana-agent /bin/bash + ``` +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/grafana/README.md b/grafana/README.md index 258e618f..0e6957b3 100644 --- a/grafana/README.md +++ b/grafana/README.md @@ -1,31 +1,53 @@ -# grafana - # Quick reference -- The official grafana docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) - -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- The official Grafana docker image. -# Build reference +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -1. Build images and push: -```shell -docker buildx build -t "openeuler/grafana:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). +- +# Grafana | openEuler +Current Grafana docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +[Grafana open source software](https://grafana.com/oss/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they are stored. Grafana OSS provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations. The Grafana OSS plugin framework also enables you to connect other data sources like NoSQL/SQL databases, ticketing tools like Jira or ServiceNow, and CI/CD tooling like GitLab. -# How to use this image -```shell -docker run --name my_grafana -d -p 3000:3000 openeuler/grafana:$VERSION -``` +Learn more on [Grafana website](https://grafana.com/docs/grafana/latest/introduction/). # Supported tags and respective Dockerfile links - -- 7.5.11-oe2203lts: grafana v7.5.11, openEuler 22.03 LTS -- 10.4.1-oe2203sp3: grafana v10.4.1, openEuler 22.03 LTS SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each grafana docker image is consist of the version of grafana and the version of basic image. The details are as follows +| Tags | Currently | Architectures| +|--|--|--| +|[7.5.11-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/grafana/7.5.1/22.03-lts/Dockerfile)| Grafana 7.5.1 on openEuler 22.03-LTS | amd64, arm64 | +|[10.4.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/grafana/10.4.1/22.03-lts-sp3/Dockerfile)| Grafana 10.4.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/grafana` image from docker + ```bash + docker pull openeuler/grafana:{Tag} + ``` +- Start a grafana instance + + ```bash + docker run -d --name my-grafana -p 3000:3000 openeuler/grafana:{Tag} + ``` + After the instance `my-grafana` is started, access the kafka service through `http://localhost:3000`. + + +- Container startup options + | Option | Description | + |--|--| + | `-p 3000:3000` | Expose Apache Kafka server on `localhost:3000`. | + | `-v /path/to/grafana/provisioning/files/:/etc/grafana/provisioning/` | Directory to provision Grafana (see [documentation](https://grafana.com/docs/grafana/latest/administration/provisioning/)⁠). | + | `-v /path/to/persisted/data:/var/lib/grafana` | Persist data with a volume instead of initializing a new database for each newly launched container. | + +- View container running logs + ```bash + docker logs -f my-grafana + ``` +- To get an interactive shell + ```bash + docker exec -it my-grafana /bin/bash + ``` +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee From f0dc2999c4b38a255b059f37372d5d899c082994 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 4 Jul 2024 11:33:27 +0800 Subject: [PATCH 11/14] readme: batch submit readme files --- prometheus-pushgateway/README.md | 64 +++++++++++++++++++++--------- squid/README.md | 67 +++++++++++++++++++++++--------- telegraf/README.md | 64 +++++++++++++++++++++--------- traefik/README.md | 66 +++++++++++++++++++++---------- zookeeper/README.md | 66 ++++++++++++++++++++++--------- 5 files changed, 231 insertions(+), 96 deletions(-) diff --git a/prometheus-pushgateway/README.md b/prometheus-pushgateway/README.md index 537c5756..72604dea 100644 --- a/prometheus-pushgateway/README.md +++ b/prometheus-pushgateway/README.md @@ -1,30 +1,56 @@ -# Prometheus-pushgateway - # Quick reference -- The official prometheus-pushgateway docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Prometheus-pushgateway docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/prometheus-pushgateway:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# Prometheus-pushgateway | openEuler +Current Prometheus-pushgateway docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +The Pushgateway is an intermediary service which allows you to push metrics from jobs which cannot be scraped. For details, see [Pushing metrics](https://prometheus.io/docs/instrumenting/pushing/). -2. Run: -```shell -docker run -d -p 9091:9091 openeuler/prometheus-pushgateway:$TAG -``` +Learn more about Prometheus-pushgateway on the [Prometheus-pushgateway Website](https://prometheus.io/docs/practices/pushing/). # Supported tags and respective Dockerfile links +The tag of each `prometheus-pushgateway` docker image is consist of the version of `prometheus-pushgateway` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[1.7.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/prometheus-pushgateway/1.7.0/22.03-lts-sp3/Dockerfile)| Prometheus-pushgateway 1.7.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/prometheus-pushgateway` image from docker + ```bash + docker pull openeuler/prometheus-pushgateway:{Tag} + ``` + +- Start a prometheus-pushgateway instance + + ```bash + docker run -d --name my-prometheus-pushgateway -p 9091:9091 openeuler/prometheus-pushgateway:{Tag} + ``` + After the instance `my-prometheus-pushgateway` is started, access the Prometheus-pushgateway service through `http://localhost:9091`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 9091:9091` | Expose Prometheus-pushgateway server on `localhost:9091`. | + +- View container running logs + + ```bash + docker logs -f my-prometheus-pushgateway + ``` + +- To get an interactive shell -- 1.7.0-oe2203sp3: prometheus-pushgateway v1.7.0, openEuler 22.03-LTS-SP3 + ```bash + docker exec -it my-prometheus-pushgateway /bin/bash + ``` -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/squid/README.md b/squid/README.md index 730b32e8..db33c7ef 100644 --- a/squid/README.md +++ b/squid/README.md @@ -1,30 +1,59 @@ -# squid - # Quick reference -- The official squid docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Squid docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/squid:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# Squid | openEuler +Current Squid docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. It runs on most available operating systems, including Windows and is licensed under the GNU GPL. -2. Run: -```shell -docker run -d --name squid -p 3128:3128 openeuler/squid:$TAG -``` +Learn more on [Squid website](https://www.squid-cache.org/). # Supported tags and respective Dockerfile links +The tag of each `squid` docker image is consist of the version of `squid` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[6.8-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/squid/6.8/22.03-lts-sp3/Dockerfile)| Squid 6.8 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/squid` image from docker + ```bash + docker pull openeuler/squid:{Tag} + ``` +- Start a squid instance + + ```bash + docker run -d --name my-squid -p 3128:3128 openeuler/squid:{Tag} + ``` + After the instance `my-squid` is started, access the Squid service through `http://localhost:3128`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 3128:3128` | Expose squid on `localhost:3128`. | + | `-v /path/to/logs:/var/log/squid` | Volume to store squid logs | + | `-v /path/to/data:/var/spool/squid` | Volume to store the squid cache | + | `-v /path/to/main/config:/usr/local/squid/etc/squid.conf` | Main squid configuration file | + | `-v /path/to/config/snippet:/usr/local/squid/etc/conf.d/snippet.conf` | Configuration snippets included by squid.conf | + +- View container running logs + + ```bash + docker logs -f my-squid + ``` + +- To get an interactive shell -- 6.8-oe2203sp3: squid v6.8, openEuler 22.03 LTS SP3 + ```bash + docker exec -it my-squid /bin/bash + ``` -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/telegraf/README.md b/telegraf/README.md index f35db0ed..99947184 100644 --- a/telegraf/README.md +++ b/telegraf/README.md @@ -1,31 +1,57 @@ -# Telegraf - # Quick reference -- The official telegraf docker image. +- The official Telegraf docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -# Build reference +# Telegraf | openEuler +Current Telegraf docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -1. Build images and push: -```shell -docker buildx build -t "openeuler/telegraf:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +Telegraf, a server-based agent, collects and sends metrics and events from databases, systems, and IoT sensors. Written in Go, Telegraf compiles into a single binary with no external dependencies–requiring very minimal memory. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Learn more on [Telegraf website](https://docs.influxdata.com/telegraf/v1/). -2. Run: +# Supported tags and respective Dockerfile links +The tag of each `telegraf` docker image is consist of the version of `telegraf` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[1.29.5-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/telegraf/1.29.5/22.03-lts-sp3/Dockerfile)| Telegraf 1.29.5 on openEuler 22.03-LTS-SP3 | amd64, arm64 | -```shell -docker run --name telegraf -d -v /your-path/telegraf.conf:/etc/telegraf/telegraf.conf openeuler/telegraf:{TAG} -``` +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. -# Supported tags and respective Dockerfile links +- Pull the `openeuler/telegraf` image from docker + ```bash + docker pull openeuler/telegraf:{Tag} + ``` + +- Start a telegraf instance + + ```bash + docker run -d --name my-telegraf -p 8094:8094 -v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf openeuler/telegraf:{Tag} + ``` + After the instance `my-telegraf` is started, access the Telegraf service through `http://localhost:8094`. + +- Container startup options + + | Option | Description | + |--|--| + | -p 8094:8094 | Expose telegraf on `localhost:8094`. | + | v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf | Local [configuration file](https://docs.influxdata.com/telegraf/v1/)⁠ `telegraf.conf`. | + +- View container running logs + + ```bash + docker logs -f my-telegraf + ``` -- 1.29.5-oe2203sp3: telegraf v1.29.5, openEuler 22.03 LTS SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker exec -it my-telegraf /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/traefik/README.md b/traefik/README.md index 73b1ed17..511a6aa5 100644 --- a/traefik/README.md +++ b/traefik/README.md @@ -1,30 +1,56 @@ -# Traefik - # Quick reference - The official Traefik docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) - -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/traefik:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# Traefik | openEuler +Current Traefik docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Traefik (pronounced traffic) is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. Traefik integrates with your existing infrastructure components and configures itself automatically and dynamically. Pointing Traefik at your orchestrator should be the only configuration step you need. -2. Run: -```shell -docker run -d -p 80:80 openeuler/traefik:{TAG} -``` +Learn more about Traefik on the [Traefik Website](https://doc.traefik.io/). # Supported tags and respective Dockerfile links - -- 2.11.0-oe2203sp3: traefik v2.11.0, openEuler 22.03-LTS-SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each `traefik` docker image is consist of the version of `traefik` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[2.11.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/traefik/2.11.0/22.03-lts-sp3/Dockerfile)| Traefik 2.11.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/traefik` image from docker + ```bash + docker pull openeuler/traefik:{Tag} + ``` + +- Start a traefik instance + ```bash + docker run -d --name my-traefik -p 80:80 openeuler/traefik:{Tag} + ``` + After the instance `my-traefik` is started, access the Traefik service through `http://localhost:80`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 80:80` | Expose Traefik server on `localhost:80`. | + | `-v /path/to/traefik.yml:/etc/traefik/traefik.yml` | Local Traefik configuration file. | + +- View container running logs + + ```bash + docker logs -f my-traefik + ``` + +- To get an interactive shell + + ```bash + docker exec -it my-traefik /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/zookeeper/README.md b/zookeeper/README.md index 21a8bf9a..dce9e88c 100644 --- a/zookeeper/README.md +++ b/zookeeper/README.md @@ -1,31 +1,59 @@ -# ZooKeeper - # Quick reference -- The official ZooKeeper docker image. +- The official Zookeeper docker image. -- Maintained by: [openEuler BigData SIG](https://gitee.com/openeuler/bigdata) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Where to get help: [openEuler BigData SIG](https://gitee.com/openeuler/bigdata), [openEuler](https://gitee.com/openeuler/community) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -# Build reference +# Zookeeper | openEuler +Current Zookeeper docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -1. Build images and push: -```shell -docker buildx build -t "openeuler/zookeeper:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. All of these kinds of services are used in some form or another by distributed applications. Each time they are implemented there is a lot of work that goes into fixing the bugs and race conditions that are inevitable. Because of the difficulty of implementing these kinds of services, applications initially usually skimp on them, which make them brittle in the presence of change and difficult to manage. Even when done correctly, different implementations of these services lead to management complexity when the applications are deployed. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Learn more about ZooKeeper on the [ZooKeeper Wiki](https://cwiki.apache.org/confluence/display/ZOOKEEPER/Index). -# How to use this image +# Supported tags and respective Dockerfile links +The tag of each `zookeeper` docker image is consist of the version of `zookeeper` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[3.8.3-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/zookeeper/3.8.3/22.03-lts-sp3/Dockerfile)| zookeeper 3.8.3 on openEuler 22.03-LTS-SP3 | amd64, arm64 | -```shell -docker run --name zookeeper --restart always -p 2181:2181 -d openeuler/zookeeper:{TAG} -``` +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. -# Supported tags and respective Dockerfile links +- Pull the `openeuler/zookeeper` image from docker + ```bash + docker pull openeuler/zookeeper:{Tag} + ``` + +- Start a zookeeper instance + + ```bash + docker run -d --name my-zookeeper -p 2181:2181 openeuler/zookeeper:{Tag} + ``` + After the instance `my-zookeeper` is started, access the Zookeeper service through `http://localhost:2181`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 2181:2181` | Expose ZooKeeper server on `localhost:2181`. | + | `-v /path/to/config/file:/etc/zookeeper/zoo.cfg` | Local ZooKeeper configuration file. | + | `-v zookeeperData:/var/lib/zookeeper/data` | Persist data in a docker volume named `zookeeperData`. Make sure that the mount point is consistent with the configuration property `dataDir`. | + | `-v zookeeperLogData:/var/lib/zookeeper/data-log` | Persist data in a docker volume named `zookeeperLogData`. Make sure that the mount point is consistent with the configuration property `dataLogDir`. | + +- View container running logs + + ```bash + docker logs -f my-zookeeper + ``` + +- To get an interactive shell -- 3.8.3-oe2203sp3: zookeeper v3.8.3, openEuler 22.03-LTS-SP3 + ```bash + docker exec -it my-zookeeper /bin/bash + ``` -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. \ No newline at end of file +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee From afcbf2a49e031a845c4849cc6123f4d7c95b1ddf Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 4 Jul 2024 15:00:11 +0800 Subject: [PATCH 12/14] readme: batch update readme files --- mlflow/README.md | 31 ++++++++-------- mysql/README.md | 22 ++++++------ nginx/README.md | 43 +++++++++++------------ openjdk/README.md | 61 +++++++++++++++++++++----------- postgres/README.md | 84 ++++++++++++++++++++++++++++---------------- prometheus/README.md | 67 ++++++++++++++++++++++++----------- redis/README.md | 79 +++++++++++++++++++++-------------------- telegraf/README.md | 4 +-- 8 files changed, 226 insertions(+), 165 deletions(-) diff --git a/mlflow/README.md b/mlflow/README.md index e6d2a667..3b72b659 100644 --- a/mlflow/README.md +++ b/mlflow/README.md @@ -6,7 +6,6 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). - # MLflow | openEuler Current MLflow docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -28,7 +27,6 @@ MLflow, at its core, provides a suite of tools aimed at simplifying the ML workf Learn more on [MLflow website](https://mlflow.org/docs/latest/introduction/index.html). - # Supported tags and respective Dockerfile links The tag of each mlflow docker image is consist of the version of mlflow and the version of basic image. The details are as follows | Tags | Currently | Architectures| @@ -36,32 +34,31 @@ The tag of each mlflow docker image is consist of the version of mlflow and the |[2.11.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.11.1/22.03-lts-sp3/Dockerfile)| MLflow 2.11.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | |[2.13.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mlflow/2.13.1/22.03-lts-sp3/Dockerfile)| MLflow 2.13.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | - # Usage In this usage, users can select the corresponding `{Tag}` based on their requirements. - Pull the `openeuler/mlflow` image from docker -```bash -docker pull openeuler/mlflow:{Tag} -``` + ```bash + docker pull openeuler/mlflow:{Tag} + ``` - Start a mlflow instance -```bash -docker run -d --name my-mlflow -p 5000:5000 openeuler/mlflow:{Tag} -``` -After the instance `my-mlflow` is started, access the mlflow service through `http://localhost:5000`. + ```bash + docker run -d --name my-mlflow -p 5000:5000 openeuler/mlflow:{Tag} + ``` + After the instance `my-mlflow` is started, access the mlflow service through `http://localhost:5000`. - View container running logs -```bash -docker logs -f my-mlflow -``` + ```bash + docker logs -f my-mlflow + ``` + - To get an interactive shell -```bash -docker exec -it my-mlflow /bin/bash -``` - + ```bash + docker exec -it my-mlflow /bin/bash + ``` # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/mysql/README.md b/mysql/README.md index b37f328f..9fa1e713 100644 --- a/mysql/README.md +++ b/mysql/README.md @@ -6,20 +6,17 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). - # MySQL | openEuler Current MySQL docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. Learn more on [MySQL website](). - # Supported tags and respective Dockerfile links The tag of each mysql docker image is consist of the version of mysql and the version of basic image. The details are as follows | Tags | Currently | Architectures| |--|--|--| |[8.3.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mysql/8.3.0/22.03-lts-sp3/Dockerfile)| MySQL server 8.3.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | - # Usage In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. @@ -37,15 +34,15 @@ In this usage, users can select the corresponding `{Tag}` and `container startup - Container startup options | Option | Description | |--|--| - | -p 30306:3306 | Expose MySQL server on `localhost:30306`. | - | -e MYSQL_ROOT_PASSWORD | Set the password for the `root` user. This option is **mandatory** and **must not be empty**. | - | -e MYSQL_USER | Create a new user with superuser privileges. This is used in conjunction with `MYSQL_PASSWORD`. | - | -e MYSQL_DATABASE | Set the name of the default database. | - | -e MYSQL_ALLOW_EMPTY_PASSWORD=yes | Set up a blank password for the root user. **This is not recommended to be used in production, make sure you know what you are doing**. | - | -e MYSQL_RANDOM_ROOT_PASSWORD=yes | Generate a random initial password for the `root` user using `pwgen`. It will be printed in the logs, search for `GENERATED ROOT PASSWORD`. | - | -e MYSQL_ONETIME_PASSWORD=yes | Set `root` user as experide once initialization is complete, forcing a password change on first login. | - | -v /path/to/data:/usr/local/mysql/data/ | Persist data instead of initializing a new database every time you launch a new container. | - | -v /path/to/config/files/:/usr/local/mysql/mysql.conf.d/ | Local [configuration files](https://dev.mysql.com/doc/refman/8.0/en/mysql-command-options.html). | + | `-p 30306:3306` | Expose MySQL server on `localhost:30306`. | + | `-e MYSQL_ROOT_PASSWORD` | Set the password for the `root` user. This option is **mandatory** and **must not be empty**. | + | `-e MYSQL_USER` | Create a new user with superuser privileges. This is used in conjunction with `MYSQL_PASSWORD`. | + | `-e MYSQL_DATABASE` | Set the name of the default database. | + | `-e MYSQL_ALLOW_EMPTY_PASSWORD=yes` | Set up a blank password for the root user. **This is not recommended to be used in production, make sure you know what you are doing**. | + | `-e MYSQL_RANDOM_ROOT_PASSWORD=yes` | Generate a random initial password for the `root` user using `pwgen`. It will be printed in the logs, search for `GENERATED ROOT PASSWORD`. | + | `-e MYSQL_ONETIME_PASSWORD=yes` | Set `root` user as experide once initialization is complete, forcing a password change on first login. | + | `-v /path/to/data:/usr/local/mysql/data/` | Persist data instead of initializing a new database every time you launch a new container. | + | `-v /path/to/config/files/:/usr/local/mysql/mysql.conf.d/` | Local [configuration files](https://dev.mysql.com/doc/refman/8.0/en/mysql-command-options.html). | - View container running logs @@ -57,5 +54,6 @@ In this usage, users can select the corresponding `{Tag}` and `container startup ```bash docker exec -it my-mysql/bin/bash ``` + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/nginx/README.md b/nginx/README.md index 02ca934e..61deeb4e 100644 --- a/nginx/README.md +++ b/nginx/README.md @@ -6,7 +6,6 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). - # Nginx | openEuler Current Nginx docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -19,7 +18,6 @@ Features: - Nginx uses an [asynchronous](https://en.wikipedia.org/wiki/Asynchronous_system) [event-driven](https://en.wikipedia.org/wiki/Event_%28computing%29) approach, rather than threads, to handle requests. Nginx's modular [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture) can provide predictable performance under high loads. - # Supported tags and respective Dockerfile links The tag of each `nginx` docker image is consist of the version of `nginx` and the version of basic image. The details are as follows | Tag | Currently | Architectures | @@ -33,38 +31,37 @@ The tag of each `nginx` docker image is consist of the version of `nginx` and th In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/nginx` image from docker -```bash -docker pull openeuler/nginx:{Tag} -``` + ```bash + docker pull openeuler/nginx:{Tag} + ``` - Start a nginx instance -```bash -docker run -d --name my-nginx -p 8080:80 openeuler/nginx:{Tag} -``` -After the instance `my-nginx` is started, access the Nginx service through `http://localhost:8080`. + ```bash + docker run -d --name my-nginx -p 8080:80 openeuler/nginx:{Tag} + ``` + After the instance `my-nginx` is started, access the Nginx service through `http://localhost:8080`. - Container startup options -| Option | Description | -|--|--| -| -p 8080:80 | Expose nginx on `localhost:8080`. | -| -v /local/path/to/website:/var/www/html | Mount and serve a local website. | -| -v /path/to/conf.template:/etc/nginx/templates/conf.template | Mount template files inside `/etc/nginx/templates`. They will be processed and the results will be placed at `/etc/nginx/conf.d`. (e.g. `listen ${NGINX_PORT}`; will generate `listen 80`;). | -| v /path/to/nginx.conf:/etc/nginx/nginx.conf | Local [configuration file](https://nginx.org/en/docs/)⁠ `nginx.conf`. | + | Option | Description | + |--|--| + | `-p 8080:80` | Expose nginx on `localhost:8080`. | + | `-v /local/path/to/website:/var/www/html` | Mount and serve a local website. | + | `-v /path/to/conf.template:/etc/nginx/templates/conf.template` | Mount template files inside `/etc/nginx/templates`. They will be processed and the results will be placed at `/etc/nginx/conf.d`. (e.g. `listen ${NGINX_PORT}`; will generate `listen 80`). | + | `-v /path/to/nginx.conf:/etc/nginx/nginx.conf` | Local [configuration file](https://nginx.org/en/docs/)⁠ `nginx.conf`. | - View container running logs -```bash -docker logs -f my-nginx -``` + ```bash + docker logs -f my-nginx + ``` - To get an interactive shell -```bash -docker exec -it my-nginx /bin/bash -``` - - + ```bash + docker exec -it my-nginx /bin/bash + ``` + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/openjdk/README.md b/openjdk/README.md index bf7c1190..b5177df9 100644 --- a/openjdk/README.md +++ b/openjdk/README.md @@ -1,30 +1,49 @@ -# OpenJdk - # Quick reference -- The official openjdk docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official OpenJDK docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/openjdk:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# OpenJDK | openEuler +Current OpenJDK docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +The place to collaborate on an open-source implementation of the Java Platform, Standard Edition, and related projects. -2. Run: -```shell -docker run -it --name openjdk openeuler/openjdk:{TAG} -``` +Learn more about OpenJDK on the [https://openjdk.org/). # Supported tags and respective Dockerfile links - -- 23+13-oe2203sp3: openjdk v23+13, openEuler 22.03 LTS SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each `openjdk` docker image is consist of the version of `openjdk` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[23_13-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/openjdk/23+13/22.03-lts-sp3/Dockerfile)| OpenJDK 23+13 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` based on their requirements. + +- Pull the `openeuler/openjdk` image from docker + ```bash + docker pull openeuler/openjdk:{Tag} + ``` + +- Start a openjdk instance + + ```bash + docker run -it --name my-openjdk openeuler/openjdk:{Tag} + ``` + +- View container running logs + + ```bash + docker logs -f my-openjdk + ``` + +- To get an interactive shell + + ```bash + docker exec -it my-openjdk /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/postgres/README.md b/postgres/README.md index 9419231e..831c905f 100644 --- a/postgres/README.md +++ b/postgres/README.md @@ -1,44 +1,66 @@ -# PostgreSQL - # Quick reference -- The official openGauss-lite docker image. +- The official PostgreSQL docker image. + +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +# PostgreSQL | openEuler +Current PostgreSQL docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -# Build reference +PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. -1. Build images and push: -```shell -docker buildx build -t "openeuler/postgres:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +Learn more about PostgreSQL on the [PostgreSQL Website](https://www.postgresql.org/). -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +# Supported tags and respective Dockerfile links +The tag of each `postgres` docker image is consist of the version of `postgres` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[13.3-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/postgres/13.3/22.03-lts/Dockerfile)| Postgres 13.3 on openEuler 22.03-LTS | amd64, arm64 | +|[16.2-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/postgres/1.25.4/22.03-lts-sp3/Dockerfile)| Postgres 16.2 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. -# How to use this image -## start a openGauss instance -```shell -docker run --name my_postgresql -d -e POSTGRES_PASSWORD=PostgreSQL@123 openeuler/postgres:13.3 -``` -The default postgres user and database are created in the entrypoint with initdb. +- Pull the `openeuler/postgres` image from docker + ```bash + docker pull openeuler/postgres:{Tag} + ``` -## connect database using gsql from os -```shell -docker run --name my_postgresql -d -e POSTGRES_PASSWORD=PostgreSQL@123 -p 5433:5432 openeuler/postgres:13.3 -psql -d postgres -U postgres -W 'PostgreSQL@123' -h host_ip -p 5433 -``` +- Start a postgres instance -## persist data to local storage -```shell -docker run --name my_postgresql -d -e POSTGRES_PASSWORD=PostgreSQL@123 -v /postgresql:/var/lib/pgsql/data openeuler/postgres:13.3 -``` + ```bash + docker run -d --name my-postgres -p 30432:5432 -e POSTGRES_PASSWORD=PostgreSQL@123 openeuler/postgres:{Tag} + ``` + After the instance `my-postgres` is started, access the PostgreSQL service through `http://localhost:30432`. -# Supported tags and respective Dockerfile links +- Container startup options + + | Option | Description | + |--|--| + | `-p 30432:5432` | Expose PostgreSQL server on `localhost:30432`. | + | `-e POSTGRES_PASSWORD=passwd` | Set the password for the superuser which is `postgres` by default. Bear in mind that to connect to the database in the same host the password is not needed but to access it via an external host (for instance another container) the password is needed. This option is **mandatory and must not be empty**. | + | `-e POSTGRES_USER=postgres` | Create a new user with superuser privileges. This is used in conjunction with `POSTGRES_PASSWORD`. | + | `-e POSTGRES_INITDB_ARGS="--data-checksums"` | Pass arguments to the `postgres initdb` call. | + | `-e POSTGRES_DB=postgres` | Set the name of the default database. | + | `-e POSTGRES_INITDB_WALDIR` | Set the location of the Postgres transaction log. By default it is stored in a subdirectory of the main Postgres data folder (`PGDATA`). | + | `-e POSTGRES_HOST_AUTH_METHOD=trust` | Set the auth-method for `host` connections for `all` databases, `all` users, and `all` addresses. The following will be added to the `pg_hba.conf` if this option is passed: `host all all all $POSTGRES_HOST_AUTH_METHOD`. | + | `-e PGDATA=/path/to/location` | Set the location of the database files. The default is `/var/lib/postgresql/data`. | + | `-v /path/to/postgresql.conf:/etc/postgresql/postgresql.conf` | Local configuration file `postgresql.conf`. | + | `-v /path/to/persisted/data:/var/lib/postgresql/data` | Persist data instead of initializing a new database every time you launch a new container. | + +- View container running logs + + ```bash + docker logs -f my-postgres + ``` -- 13.3-oe2203lts: postgres v13.3, openEuler 22.03 LTS -- 16.2-oe2203sp3: postgres v16.2, openEuler 22.03 LTS SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker exec -it my-postgres /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/prometheus/README.md b/prometheus/README.md index 3e4d3411..c131efcb 100644 --- a/prometheus/README.md +++ b/prometheus/README.md @@ -1,31 +1,58 @@ -# prometheus - # Quick reference -- The official prometheus docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Prometheus docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/prometheus:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +# Prometheus | openEuler +Current Prometheus docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Prometheus is an open-source systems monitoring and alerting toolkit originally built at SoundCloud. Since its inception in 2012, many companies and organizations have adopted Prometheus, and the project has a very active developer and user community. It is now a standalone open source project and maintained independently of any company. To emphasize this, and to clarify the project's governance structure, Prometheus joined the Cloud Native Computing Foundation in 2016 as the second hosted project, after Kubernetes. -# How to use this image -```shell -docker run --name my_prometheus -d -p 9090:9090 openeuler/prometheus:$VERSION -``` +Learn more about Prometheus on the [Prometheus Website](https://prometheus.io/docs/introduction/overview/). # Supported tags and respective Dockerfile links +The tag of each `prometheus` docker image is consist of the version of `prometheus` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| + |[2.20.0-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/prometheus/2.20.0/22.03-lts/Dockerfile)| Prometheus server 2.20.0 on openEuler 22.03-LTS | amd64, arm64 | + |[2.50.1-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/prometheus/2.50.1/22.03-lts-sp3/Dockerfile)| Prometheus server 2.50.1 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/prometheus` image from docker + ```bash + docker pull openeuler/prometheus:{Tag} + ``` + +- Start a prometheus instance + + ```bash + docker run -d --name my-prometheus -p 9090:9090 openeuler/prometheus:{Tag} + ``` + After the instance `my-prometheus` is started, access the Prometheus service through `http://localhost:9090`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 9090:9090` | Expose Prometheus server on `localhost:9090`. | + | `-v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml` | Local configuration file `prometheus.yml`. | + | `-v /path/to/alerts.yml:/etc/prometheus/alerts.yml` | Local alerts configuration file `alerts.yml`. | + +- View container running logs + + ```bash + docker logs -f my-prometheus + ``` -- 2.20.0-oe2203lts: prometheus v2.20.0, openEuler 22.03 LTS -- 2.50.1-oe2203sp3: prometheus v2.50.1, openEuler 22.03 LTS SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker exec -it my-prometheus /bin/bash + ``` +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/redis/README.md b/redis/README.md index aa78d373..abd595a1 100644 --- a/redis/README.md +++ b/redis/README.md @@ -6,7 +6,6 @@ - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). - # Redis | openEuler Current Redis docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -34,7 +33,6 @@ Please also view the ⁠[Redis License Overview](https://redis.io/legal/licenses - [dumping the dataset to disk](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#snapshotting) - [appending each command to a disk-based log](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/#append-only-file) - # Supported tags and respective Dockerfile links The tag of each redis docker image is consist of the version of redis and the version of basic image. The details are as follows | Tags | Currently | Architectures| @@ -42,61 +40,64 @@ The tag of each redis docker image is consist of the version of redis and the ve |[6.2.7-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/6.2.7/22.03-lts/Dockerfile)| Redis 6.2.7 on openEuler 22.03-LTS | amd64, arm64 | |[7.2.4-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/redis/7.2.4/22.03-lts-sp3/Dockerfile)| Redis 7.2.4 on openEuler 22.03-LTS-SP3 | amd64, arm64 | - # Usage In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/redis` image from docker -```bash -docker pull openeuler/redis:{Tag} -``` + ```bash + docker pull openeuler/redis:{Tag} + ``` + - Start a redis instance -```bash -docker run -d --name my-redis -p 6379:6379 openeuler/redis:{Tag} -``` + ```bash + docker run -d --name my-redis -p 6379:6379 openeuler/redis:{Tag} + ``` + - Start with persistent storage -As follows, this will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed. -```shell -docker run --name my-redis -d openeuler/redis:{Tag} redis-server --save 60 1 --loglevel warning -``` + + As follows, this will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed. + ```shell + docker run --name my-redis -d openeuler/redis:{Tag} redis-server --save 60 1 --loglevel warning + ``` - Connect to a redis instance -Connect to a local redis instance using loopback address -```shell -docker run --name my-redis -d -p 6379:6379 openeuler/redis:{Tag} -redis-cli -h 127.0.0.1 -p 6379 -``` -If you want connect the redis instance using hostip, you should connect to the instance using loopback, -and then configure as belows + Connect to a local redis instance using loopback address + ```shell + docker run --name my-redis -d -p 6379:6379 openeuler/redis:{Tag} + redis-cli -h 127.0.0.1 -p 6379 + ``` + If you want connect the redis instance using hostip, you should connect to the instance using loopback, + and then configure as belows -```bash -config set protected-mode no -``` + ```bash + config set protected-mode no + ``` - Container startup options -| Option | Description | -|--|--| -| `-p 6379:6379` | Expose Redis server on `localhost:6379`. | -| `-e ALLOW_EMPTY_PASSWORD=yes` | Set to `yes` to allow connections to redis-server without a password. **This setting is not recommended in production environments**. | -| `-e REDIS_PASSWORD` | Set the desired password to be used. | -| `-e REDIS_RANDOM_PASSWORD=1` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`). | -| `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only). | -| `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it. | -| `-v /path/to/redis.conf:/etc/redis/redis.conf` | Local [configuration file](https://redis.io/docs/latest/operate/oss_and_stack/management/config/) `redis.conf`. **To enable TLS** mode, comment the `port 6379` line and uncomment the `# port 0` and `# tls-port 6379` lines. | + | Option | Description | + |--|--| + | `-p 6379:6379` | Expose Redis server on `localhost:6379`. | + | `-e ALLOW_EMPTY_PASSWORD=yes` | Set to `yes` to allow connections to redis-server without a password. **This setting is not recommended in production environments**. | + | `-e REDIS_PASSWORD` | Set the desired password to be used. | + | `-e REDIS_RANDOM_PASSWORD=1` | Set this variable to `1` if you would like the entrypoint script to generate a random password for you. You will be able to see the generated password in the logs (`docker logs`). | + | `-e REDIS_ALLOW_REMOTE_CONNECTIONS=yes` | Set to `no` to disallow remote connections to `redis-server` (i.e., make `redis-server` listen to `127.0.0.1` only). | + | `-e REDIS_EXTRA_FLAGS` | Specify extra flags to be passed to `redis-server` when initializing it. | + | `-v /path/to/redis.conf:/etc/redis/redis.conf` | Local [configuration file](https://redis.io/docs/latest/operate/oss_and_stack/management/config/) `redis.conf`. **To enable TLS** mode, comment the `port 6379` line and uncomment the `# port 0` and `# tls-port 6379` lines. | - View container running logs -```bash -docker logs -f my-redis -``` + ```bash + docker logs -f my-redis + ``` + - To get an interactive shell -```bash -docker exec -it my-redis /bin/bash -``` - + ```bash + docker exec -it my-redis /bin/bash + ``` + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/telegraf/README.md b/telegraf/README.md index 99947184..e3ed1da0 100644 --- a/telegraf/README.md +++ b/telegraf/README.md @@ -38,8 +38,8 @@ In this usage, users can select the corresponding `{Tag}` and `container startup | Option | Description | |--|--| - | -p 8094:8094 | Expose telegraf on `localhost:8094`. | - | v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf | Local [configuration file](https://docs.influxdata.com/telegraf/v1/)⁠ `telegraf.conf`. | + | `-p 8094:8094` | Expose telegraf on `localhost:8094`. | + | `-v /path/to/telegraf.conf:/etc/telegraf/telegraf.conf` | Local [configuration file](https://docs.influxdata.com/telegraf/v1/)⁠ `telegraf.conf`. | - View container running logs -- Gitee From a54fe30040c9b8dcc99a4d82608c3103af2b8adb Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 4 Jul 2024 15:08:59 +0800 Subject: [PATCH 13/14] readme: batch update readme files --- mlflow/README.md | 2 ++ mysql/README.md | 3 +++ nginx/README.md | 1 + openjdk/README.md | 1 + postgres/README.md | 1 + prometheus-pushgateway/README.md | 1 + prometheus/README.md | 2 ++ redis/README.md | 3 ++- spark/README.md | 19 ++++++++++++++----- squid/README.md | 2 ++ telegraf/README.md | 1 + traefik/README.md | 2 ++ zookeeper/README.md | 1 + 13 files changed, 33 insertions(+), 6 deletions(-) diff --git a/mlflow/README.md b/mlflow/README.md index 3b72b659..e40ca700 100644 --- a/mlflow/README.md +++ b/mlflow/README.md @@ -38,9 +38,11 @@ The tag of each mlflow docker image is consist of the version of mlflow and the In this usage, users can select the corresponding `{Tag}` based on their requirements. - Pull the `openeuler/mlflow` image from docker + ```bash docker pull openeuler/mlflow:{Tag} ``` + - Start a mlflow instance ```bash diff --git a/mysql/README.md b/mysql/README.md index 9fa1e713..ff631d8d 100644 --- a/mysql/README.md +++ b/mysql/README.md @@ -21,9 +21,11 @@ The tag of each mysql docker image is consist of the version of mysql and the ve In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/mysql` image from docker + ```bash docker pull openeuler/mysql:{Tag} ``` + - Start a mysql instance ```bash @@ -49,6 +51,7 @@ In this usage, users can select the corresponding `{Tag}` and `container startup ```bash docker logs -f my-mysql ``` + - To get an interactive shell ```bash diff --git a/nginx/README.md b/nginx/README.md index 61deeb4e..7641e41d 100644 --- a/nginx/README.md +++ b/nginx/README.md @@ -31,6 +31,7 @@ The tag of each `nginx` docker image is consist of the version of `nginx` and th In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/nginx` image from docker + ```bash docker pull openeuler/nginx:{Tag} ``` diff --git a/openjdk/README.md b/openjdk/README.md index b5177df9..d322263a 100644 --- a/openjdk/README.md +++ b/openjdk/README.md @@ -23,6 +23,7 @@ The tag of each `openjdk` docker image is consist of the version of `openjdk` an In this usage, users can select the corresponding `{Tag}` based on their requirements. - Pull the `openeuler/openjdk` image from docker + ```bash docker pull openeuler/openjdk:{Tag} ``` diff --git a/postgres/README.md b/postgres/README.md index 831c905f..5fedb9b9 100644 --- a/postgres/README.md +++ b/postgres/README.md @@ -24,6 +24,7 @@ The tag of each `postgres` docker image is consist of the version of `postgres` In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/postgres` image from docker + ```bash docker pull openeuler/postgres:{Tag} ``` diff --git a/prometheus-pushgateway/README.md b/prometheus-pushgateway/README.md index 72604dea..f91bc35f 100644 --- a/prometheus-pushgateway/README.md +++ b/prometheus-pushgateway/README.md @@ -23,6 +23,7 @@ The tag of each `prometheus-pushgateway` docker image is consist of the version In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/prometheus-pushgateway` image from docker + ```bash docker pull openeuler/prometheus-pushgateway:{Tag} ``` diff --git a/prometheus/README.md b/prometheus/README.md index c131efcb..235f41e8 100644 --- a/prometheus/README.md +++ b/prometheus/README.md @@ -24,6 +24,7 @@ The tag of each `prometheus` docker image is consist of the version of `promethe In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/prometheus` image from docker + ```bash docker pull openeuler/prometheus:{Tag} ``` @@ -54,5 +55,6 @@ In this usage, users can select the corresponding `{Tag}` and `container startup ```bash docker exec -it my-prometheus /bin/bash ``` + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/redis/README.md b/redis/README.md index abd595a1..e74cb27a 100644 --- a/redis/README.md +++ b/redis/README.md @@ -44,6 +44,7 @@ The tag of each redis docker image is consist of the version of redis and the ve In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/redis` image from docker + ```bash docker pull openeuler/redis:{Tag} ``` @@ -98,6 +99,6 @@ In this usage, users can select the corresponding `{Tag}` and `container startup ```bash docker exec -it my-redis /bin/bash ``` - + # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/spark/README.md b/spark/README.md index f1917813..d5f24297 100644 --- a/spark/README.md +++ b/spark/README.md @@ -5,6 +5,7 @@ - Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). - Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). + # Spark | openEuler Current Spark docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. @@ -12,7 +13,6 @@ Apache Spark is a multi-language engine for executing data engineering, data sci Learn more on [Spark website](https://spark.apache.org/). - # Supported tags and respective Dockerfile links The tag of each spark docker image is consist of the version of spark and the version of basic image. The details are as follows | Tags | Currently | Architectures| @@ -24,14 +24,20 @@ The tag of each spark docker image is consist of the version of spark and the ve # Usage In this usage, users can select the corresponding `{Tag}` based on their requirements. + - Online Documentation -You can find the latest Spark documentation, including a programming guide, on the [project web page](https://spark.apache.org/documentation.html). This README file only contains basic setup instructions. + + You can find the latest Spark documentation, including a programming guide, on the [project web page](https://spark.apache.org/documentation.html). This README file only contains basic setup instructions. + - Pull the `openeuler/spark` image from docker + ```bash docker pull openeuler/spark:{Tag} ``` + - Interactive Scala Shell -The easiest way to start using Spark is through the Scala shell: + + The easiest way to start using Spark is through the Scala shell: ```bash docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/spark-shell ``` @@ -40,8 +46,10 @@ The easiest way to start using Spark is through the Scala shell: ```bash scala> spark.range(1000 * 1000 * 1000).count() ``` + - Interactive Python Shell -The easiest way to start using PySpark is through the Python shell: + + The easiest way to start using PySpark is through the Python shell: ```bash docker run -it --name spark openeuler/spark:{Tag} /opt/spark/bin/pyspark ``` @@ -50,13 +58,14 @@ The easiest way to start using PySpark is through the Python shell: ```bash >>> spark.range(1000 * 1000 * 1000).count() ``` + - Running Spark on Kubernetes [https://spark.apache.org/docs/latest/running-on-kubernetes.html⁠](https://spark.apache.org/docs/latest/running-on-kubernetes.html). + - Configuration and environment variables See more in [https://github.com/apache/spark-docker/blob/master/OVERVIEW.md#environment-variable](https://github.com/apache/spark-docker/blob/master/OVERVIEW.md#environment-variable). - # Question and answering If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/squid/README.md b/squid/README.md index db33c7ef..5136f0b7 100644 --- a/squid/README.md +++ b/squid/README.md @@ -23,9 +23,11 @@ The tag of each `squid` docker image is consist of the version of `squid` and th In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/squid` image from docker + ```bash docker pull openeuler/squid:{Tag} ``` + - Start a squid instance ```bash diff --git a/telegraf/README.md b/telegraf/README.md index e3ed1da0..e9937412 100644 --- a/telegraf/README.md +++ b/telegraf/README.md @@ -23,6 +23,7 @@ The tag of each `telegraf` docker image is consist of the version of `telegraf` In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/telegraf` image from docker + ```bash docker pull openeuler/telegraf:{Tag} ``` diff --git a/traefik/README.md b/traefik/README.md index 511a6aa5..83ea8b13 100644 --- a/traefik/README.md +++ b/traefik/README.md @@ -23,11 +23,13 @@ The tag of each `traefik` docker image is consist of the version of `traefik` an In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/traefik` image from docker + ```bash docker pull openeuler/traefik:{Tag} ``` - Start a traefik instance + ```bash docker run -d --name my-traefik -p 80:80 openeuler/traefik:{Tag} ``` diff --git a/zookeeper/README.md b/zookeeper/README.md index dce9e88c..eef8a931 100644 --- a/zookeeper/README.md +++ b/zookeeper/README.md @@ -23,6 +23,7 @@ The tag of each `zookeeper` docker image is consist of the version of `zookeeper In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. - Pull the `openeuler/zookeeper` image from docker + ```bash docker pull openeuler/zookeeper:{Tag} ``` -- Gitee From 80eace45e5761debee88861adece40ef4211a8d6 Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Thu, 4 Jul 2024 17:40:44 +0800 Subject: [PATCH 14/14] readme: batch update readme files --- memcached/README.md | 76 ++++++++++++++++++++++++++++++++------------- mimir/README.md | 70 ++++++++++++++++++++++++++++++----------- 2 files changed, 106 insertions(+), 40 deletions(-) diff --git a/memcached/README.md b/memcached/README.md index bd01735b..d8e82a92 100644 --- a/memcached/README.md +++ b/memcached/README.md @@ -1,31 +1,63 @@ -# memcached - # Quick reference -- The official memcached docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Memcached docker image. -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -# Build reference +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -1. Build images and push: -```shell -docker buildx build -t "openeuler/memcached:$VERSION" --platform linux/amd64,linux/arm64 . --push -``` +# Memcached | openEuler +Current Memcached docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +Memcached is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering. Free & open source, high-performance, distributed memory object caching system, generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load. Memcached is simple yet powerful. Its simple design promotes quick deployment, ease of development, and solves many problems facing large data caches. Its API is available for most popular languages. -# How to use this image -```shell -docker run --name my_memcached -d -p 11211:11211 openeuler/memcached:$VERSION -``` +Learn more about Memcached on the [https://memcached.org/). # Supported tags and respective Dockerfile links - -- 1.6.12-oe2203lts: memcached v1.6.12, openEuler 22.03 LTS -- 1.6.24-oe2203sp3: memcached v1.6.24, openEuler 22.03 LTS SP3 - -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. +The tag of each `memcached` docker image is consist of the version of `memcached` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[1.6.12-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/memcached/1.6.12/22.03-lts-sp3/Dockerfile)| Memcached 1.6.12 on openEuler 22.03-LTS | amd64, arm64 | +|[1.6.24-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/memcached/1.6.24/22.03-lts-sp3/Dockerfile)| Memcached 1.6.24 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/memcached` image from docker + + ```bash + docker pull openeuler/memcached:{Tag} + ``` + +- Start a memcached instance + + ```bash + docker run -d --name my-memcached -p 11211:11211 openeuler/memcached:{Tag} + ``` + After the instance `my-memcached` is started, access the Memcached service through `http://localhost:11211`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 11211:11211` | Expose Memcached server on `localhost:11211`. | + | `-e MEMCACHED_CACHE_SIZE=64MB` | Determines the size of the cache. | + | `-e MEMCACHED_MAX_CONNECTIONS=1024` | Determines the maximum number of concurrent connections. | + | `-e MEMCACHED_THREADS=4` | Determines the number of threads to process requests. | + | `-e MEMCACHED_PASSWORD` | Define the password for the `root` user if another username is provided. By default the authentication is disabled but if this option is passed it becomes enabled. | + | `-e MEMCACHED_USERNAME` | Define a new user. If this option is passed a password is needed to authenticate the new user. | + +- View container running logs + + ```bash + docker logs -f my-memcached + ``` + +- To get an interactive shell + + ```bash + docker exec -it my-memcached /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/mimir/README.md b/mimir/README.md index 3be485d3..a10668bc 100644 --- a/mimir/README.md +++ b/mimir/README.md @@ -1,30 +1,64 @@ -# Mimir - # Quick reference -- The official mimir docker image. +- The official Grafana Mimir docker image. -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community) +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). -# Build reference +# Grafana Mimir | openEuler +Current Grafana Mimir docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. -1. Build images and push: -```shell -docker buildx build -t "openeuler/mimir:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +Grafana Mimir is an open source software project that provides a scalable long-term storage for Prometheus. Some of the core strengths of Grafana Mimir include: -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +* Easy to install and maintain: Grafana Mimir’s extensive documentation, tutorials, and deployment tooling make it quick to get started. Using its monolithic mode, you can get Grafana Mimir up and running with just one binary and no additional dependencies. Once deployed, the best-practice dashboards, alerts, and runbooks packaged with Grafana Mimir make it easy to monitor the health of the system. +* Massive scalability: You can run Grafana Mimir’s horizontally-scalable architecture across multiple machines, resulting in the ability to process orders of magnitude more time series than a single Prometheus instance. Internal testing shows that Grafana Mimir handles up to 1 billion active time series. +* Global view of metrics: Grafana Mimir enables you to run queries that aggregate series from multiple Prometheus instances, giving you a global view of your systems. Its query engine extensively parallelizes query execution, so that even the highest-cardinality queries complete with blazing speed. +* Cheap, durable metric storage: Grafana Mimir uses object storage for long-term data storage, allowing it to take advantage of this ubiquitous, cost-effective, high-durability technology. It is compatible with multiple object store implementations, including AWS S3, Google Cloud Storage, Azure Blob Storage, OpenStack Swift, as well as any S3-compatible object storage. +* High availability: Grafana Mimir replicates incoming metrics, ensuring that no data is lost in the event of machine failure. Its horizontally scalable architecture also means that it can be restarted, upgraded, or downgraded with zero downtime, which means no interruptions to metrics ingestion or querying. +* Natively multi-tenant: Grafana Mimir’s multi-tenant architecture enables you to isolate data and queries from independent teams or business units, making it possible for these groups to share the same cluster. Advanced limits and quality-of-service controls ensure that capacity is shared fairly among tenants. -2. Run: -```shell -docker run -d -p 8080:8080 openeuler/mimir:$TAG -``` +Learn more about Grafana Mimir on the [https://grafana.com/docs/mimir/latest/). # Supported tags and respective Dockerfile links +The tag of each `mimir` docker image is consist of the version of `mimir` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[2.11.0-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/mimir/2.11.0/22.03-lts-sp3/Dockerfile)| Grafana mimir 2.11.0 on openEuler 22.03-LTS-SP3 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` and `container startup options` based on their requirements. + +- Pull the `openeuler/mimir` image from docker + + ```bash + docker pull openeuler/mimir:{Tag} + ``` + +- Start a mimir instance + + ```bash + docker run -d --name my-mimir -p 8080:8080 openeuler/mimir:{Tag} + ``` + After the instance `my-mimir` is started, access the Grafana Mimir service through `http://localhost:8080`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 8080:8080` | Expose Mimir server on `localhost:8080`. | + +- View container running logs + + ```bash + docker logs -f my-mimir + ``` -- 2.11.0-oe2203sp3: mimir v2.11.0, openEuler 22.03-LTS-SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker exec -it my-mimir /bin/bash + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file -- Gitee