From 60e0fee2115b16d66607ac9467edc78ecd86613e Mon Sep 17 00:00:00 2001 From: GuangJie1 Date: Wed, 10 Jul 2024 17:38:27 +0800 Subject: [PATCH] readme: batch modify readme files --- dotnet-runtime/README.md | 81 +++++++++++++++++++++++++++++--------- httpd/README.md | 68 ++++++++++++++++++++++---------- loki/README.md | 64 +++++++++++++++++++++--------- traefik/doc/image-info.yml | 2 +- 4 files changed, 156 insertions(+), 59 deletions(-) diff --git a/dotnet-runtime/README.md b/dotnet-runtime/README.md index 6bb97c75..abe99081 100644 --- a/dotnet-runtime/README.md +++ b/dotnet-runtime/README.md @@ -1,30 +1,73 @@ -# Dotnet-runtime - # Quick reference -- The official dotnet-runtime docker image. - -- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative) +- The official Dotnet Runtime (.NET Runtime) 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/dotnet-runtime:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# Dotnet Runtime (.NET Runtime) | openEuler +Current Dotnet Runtime (.NET Runtime) 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/) +.NET is a free, cross-platform, open-source developer platform for building many kinds of applications. It can run programs written in multiple languages, with C# being the most popular. It relies on a high-performance runtime that is used in production by many high-scale apps. -2. Run: -```shell -docker run -it --rm -name dotnet-runtime openeuler/dotnet-runtime:$TAG -``` +Learn more about Dotnet Runtime on [learn.microsoft.com](https://learn.microsoft.com/en-us/dotnet/core/introduction)⁠. # Supported tags and respective Dockerfile links +The tag of each `dotnet-runtime` docker image is consist of the version of `dotnet-runtime` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[8.0.3-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/dotnet-runtime/8.0.3/22.03-lts-sp3/Dockerfile)| Dotnet-runtime 8.0.3 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/dotnet-runtime` image from docker + + ```bash + docker pull openeuler/dotnet-runtime:{Tag} + ``` + +- Start a dotnet-runtime instance + + ```bash + docker run -d --name my-dotnet-runtime openeuler/dotnet-runtime:{Tag} + ``` +- An example with HelloWorld application example + + 1. Create a HelloWorld.csproj file with the following content + + + + Exe + net8.0 + enable + enable + + + + 2. Create a Program.cs file with the following code + + Console.WriteLine("Hello, World!"); + + 3. Publish the .NET application (you need the "dotnet8" package) + + dotnet publish -c Release -o app + + 4. Run the app with "openeuler/dotnet-runtime:8.0.3-oe2203sp3" + + docker run --rm -v $PWD/app:/app openeuler/dotnet-runtime:8.0.3-oe2203sp3 /app/HelloWorld.dll + Hello, World! + +- View container running logs + + ```bash + docker logs -f my-dotnet-runtime + ``` -- 8.0.3-oe2203sp3: dotnet-runtime v8.0.3, openEuler 22.03 LTS SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker run -it --entrypoint /bin/bash --name my-dotnet-runtime openeuler/dotnet-runtime:{Tag} + ``` +# 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/httpd/README.md b/httpd/README.md index 4867117b..a1df19c3 100644 --- a/httpd/README.md +++ b/httpd/README.md @@ -1,33 +1,59 @@ -# httpd +# Quick reference +- The official Httpd docker image. -# Quick reference +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). -- The official redis 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) +# Httpd | openEuler +Current Httpd 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) +The Apache HTTP Server, colloquially called Apache, is a Web server application notable for playing a key role in the initial growth of the World Wide Web. Originally based on the NCSA HTTPd server, development of Apache began in early 1995 after work on the NCSA code stalled. Apache quickly overtook NCSA HTTPd as the dominant HTTP server, and has remained the most popular HTTP server in use since April 1996. -# Build reference +Learn more on [Httpd Website](https://httpd.apache.org/)⁠. -Build images and push: -```shell -docker buildx build -t "openeuler/httpd:{TAG}" --platform linux/amd64,linux/arm64 . --push -``` +# Supported tags and respective Dockerfile links +The tag of each `httpd` docker image is consist of the version of `httpd` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[2.4.51-oe2203lts](https://gitee.com/openeuler/openeuler-docker-images/blob/master/httpd/2.4.51/22.03-lts/Dockerfile)| Apache HTTP Server 2.4.51 on openEuler 22.03-LTS | amd64, arm64 | +|[2.4.58-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/httpd/2.4.58/22.03-lts-sp3/Dockerfile)| Apache HTTP Server 2.4.58 on openEuler 22.03-LTS-SP3 | amd64, arm64 | -We are using `buildx` in here to generate multi-arch images, see more in [Docker Buildx](https://docs.docker.com/buildx/working-with-buildx/) +# 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 httpd instance -```shell -docker run --name my-httpd -d -p 80:80 openeuler/httpd:{TAG} -``` +- Pull the `openeuler/httpd` image from docker -# Supported tags and respective Dockerfile links + ```bash + docker pull openeuler/httpd:{Tag} + ``` + +- Start a httpd instance + + ```bash + docker run -d --name my-httpd -p 80:80 openeuler/httpd:{Tag} + ``` + After the instance `my-httpd` is started, access the httpd service through `http://localhost:80`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 80:80` | Expose httpd on `localhost:8080`. | + | `-v /local/path/to/website:/var/www/html` | Mount the local website path `/var/www/html`. | + | `-v /path/to/httpd.conf:/usr/local/apache2/conf/httpd.conf` | Local configuration file `httpd.conf`. | + +- View container running logs + + ```bash + docker logs -f my-httpd + ``` -- 2.4.51-oe2203lts: httpd v2.4.51, openEuler 22.03 LTS -- 2.4.58-oe2203sp3: httpd v2.4.58, openEuler 22.03 LTS SP3 +- To get an interactive shell -## Operating System -Linux/Unix, ARM64 or x86-64 architecture. + ```bash + docker exec -it my-httpd /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/loki/README.md b/loki/README.md index 8ab69503..07c80156 100644 --- a/loki/README.md +++ b/loki/README.md @@ -1,30 +1,58 @@ -# Loki - # Quick reference - The official Loki 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/loki:$TAG" --platform linux/amd64,linux/arm64 . --push -``` +# Loki | openEuler +Current Loki 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/) +Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate. It does not index the contents of the logs, but rather a set of labels for each log stream. -2. Run: -```shell -docker run -d -p 3100:3100 openeuler/loki:$TAG -``` +Learn more on [Loki Website](https://grafana.com/oss/loki/)⁠. # Supported tags and respective Dockerfile links +The tag of each `loki` docker image is consist of the version of `loki` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[2.9.5-oe2203sp3](https://gitee.com/openeuler/openeuler-docker-images/blob/master/loki/2.9.5/22.03-lts-sp3/Dockerfile)| Grafana Loki 2.9.5 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/loki` image from docker + + ```bash + docker pull openeuler/loki:{Tag} + ``` + +- Start a loki instance + + ```bash + docker run -d --name my-loki -p 3100:3100 openeuler/loki:{Tag} + ``` + After the instance `my-loki` is started, access the Loki service through `http://localhost:3100`. + +- Container startup options + + | Option | Description | + |--|--| + | `-p 3100:3100` | Expose loki on `localhost:8080`. | + | `-v lokidata:/loki` | Persist data in a docker volume named `lokidata`. | + | `-v /path/to/config/file:/etc/loki/local-config.yaml` | Local configuration file `local-config.yml`. | + +- View container running logs + + ```bash + docker logs -f my-loki + ``` -- 2.9.5-oe2203sp3: loki v2.9.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-loki /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/doc/image-info.yml b/traefik/doc/image-info.yml index 1aacb376..2ce6cebc 100644 --- a/traefik/doc/image-info.yml +++ b/traefik/doc/image-info.yml @@ -25,7 +25,7 @@ usage: | docker run -d --name my-traefik -p 80:80 openeuler/traefik:{Tag} ``` 用户可根据自身需求选择对应版本的{Tag}、容器启动的选项。 - `my-traefik`启动之后，通过`localhost:80`访问traefik反向代理服务。 + `my-traefik`启动之后，通过`http://localhost:80`访问traefik反向代理服务。 - 启动参数 -- Gitee