From 4bef948cbef970f6864273afe7233cd45e972af9 Mon Sep 17 00:00:00 2001 From: Suyash Singh Date: Sat, 16 May 2026 23:10:34 +0530 Subject: [PATCH] Update some spelling mistakes Signed-off-by: Suyash Singh --- docker/README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docker/README.md b/docker/README.md index c155b26bc5..b321d87ed1 100644 --- a/docker/README.md +++ b/docker/README.md @@ -7,21 +7,21 @@ Introduction This directory contains: - Scripts to build, test, push and promote docker images for apache kafka - both `jvm` based and graalvm based `native` kafka - Scripts to build, test the JVM-based Docker Official Image, and generate a PR template for the same to be raised under the Docker official images repo. - All of the steps can be either performed locally or by using Github Actions. + All of the steps can be either performed locally or by using Actions. -Github Actions + Actions -------------- -- Github Actions can be accessed in Actions tab of the repository. -- Please ensure that whichever Github Action Workflow you are triggering, you are doing it for the correct `branch`. -- For all Github Actions Workflows for docker images, you'll get the option to select the branch as a dropdown box. +- Actions can be accessed in Actions tab of the repository. +- Please ensure that whichever Action Workflow you are triggering, you are doing it for the correct `branch`. +- For all Actions Workflows for docker images, you'll get the option to select the branch as a dropdown box. Repository Setup ---------------- -Make sure the `DOCKERHUB_USER` and `DOCKERHUB_TOKEN` secrets are added and made available to Github Actions in Github Repository settings. This is required for pushing the docker image. +Make sure the `DOCKERHUB_USER` and `DOCKERHUB_TOKEN` secrets are added and made available to Actions in Repository settings. This is required for pushing the docker image. -Building image and running tests using github actions +Building image and running tests using actions ---------------------------------------------------- - This is the recommended way to build, test and get a CVE report for the docker image. @@ -34,43 +34,43 @@ Building image and running tests using github actions - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming) - Example(jvm):- -To build and test a jvm image type ensuring kafka to be containerised should be https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz (it is recommended to use scala 2.13 binary tarball), following inputs in github actions workflow are recommended. +To build and test a jvm image type ensuring kafka to be containerised should be https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz (it is recommended to use scala 2.13 binary tarball), following inputs in actions workflow are recommended. ``` image_type: jvm kafka_url: https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz ``` - Example(native):- - To build and test a native image type ensuring kafka to be containerised should be https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz (it is recommended to use scala 2.13 binary tarball), following inputs in github actions workflow are recommended. + To build and test a native image type ensuring kafka to be containerised should be https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz (it is recommended to use scala 2.13 binary tarball), following inputs in actions workflow are recommended. ``` image_type: native kafka_url: https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz ``` -Creating a Release Candidate using github actions +Creating a Release Candidate using actions ------------------------------------------------- - This is the recommended way to push an RC docker image. -- Go to `Build and Push Release Candidate Docker Image` Github Actions Workflow. -- Choose the `image_type` and provide `kafka_url` that needs to be containerised in the `rc_docker_image` that will be pushed to github. +- Go to `Build and Push Release Candidate Docker Image` Actions Workflow. +- Choose the `image_type` and provide `kafka_url` that needs to be containerised in the `rc_docker_image` that will be pushed to . - Example(jvm):- -If you want to push a jvm image which contains kafka from https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz to dockerhub under the namespace apache, repo name as kafka and image tag as 3.6.0-rc1 then following values need to be added in Github Actions Workflow:- +If you want to push a jvm image which contains kafka from https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz to dockerhub under the namespace apache, repo name as kafka and image tag as 3.6.0-rc1 then following values need to be added in Actions Workflow:- ``` image_type: jvm kafka_url: https://archive.apache.org/dist/kafka/3.6.0/kafka_2.13-3.6.0.tgz rc_docker_image: apache/kafka:3.6.0-rc0 ``` - Example(native):- - If you want to push a native image which contains kafka from https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz to dockerhub under the namespace apache, repo name as kafka-native and image tag as 3.8.0-rc0 then following values need to be added in Github Actions Workflow:- + If you want to push a native image which contains kafka from https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz to dockerhub under the namespace apache, repo name as kafka-native and image tag as 3.8.0-rc0 then following values need to be added in Actions Workflow:- ``` image_type: native kafka_url: https://archive.apache.org/dist/kafka/3.8.0/kafka_2.13-3.8.0.tgz rc_docker_image: apache/kafka-native:3.8.0-rc0 ``` -Promoting a Release Candidate using github actions +Promoting a Release Candidate using actions -------------------------------------------------- - This is the recommended way to promote an RC docker image. -- Go to `Promote Release Candidate Docker Image` Github Actions Workflow. +- Go to `Promote Release Candidate Docker Image` Actions Workflow. - Choose the RC docker image (`rc_docker_image`) that you want to promote and where it needs to be pushed to (`promoted_docker_image`), i.e. the final docker image release. - Example(jvm):- If you want to promote apache/kafka:3.6.0-rc0 RC docker image to apache/kafka:3.6.0 then following parameters can be provided to the workflow. @@ -88,7 +88,7 @@ promoted_docker_image: apache/kafka-native:3.8.0 Cron job for checking CVEs in supported docker images ----------------------------------------------------- -- `Docker Image CVE Scanner` Github Action Workflow (present in `.github/workflows/docker_scan.yml`) will run nightly CVE scans and generate reports for docker image tags mentioned in the `supported_image_tag` array. +- `Docker Image CVE Scanner` Action Workflow (present in `./workflows/docker_scan.yml`) will run nightly CVE scans and generate reports for docker image tags mentioned in the `supported_image_tag` array. - This workflow is branch independent. Only the workflow in trunk, i.e. the default branch will be considered. - In case a Critical or High CVE is detected, the workflow will fail. - It will generate the scan reports that can be checked by the community. @@ -178,7 +178,7 @@ python docker_release.py kafka-native/test:3.8.0 --kafka-url --image-type=native Promoting a Release Candidate ----------------------------- -- It's not recommended to promote the docker image locally, as we have github actions doing it in a convenient way, but if needed following command can be used to promote a Release Candidate image. +- It's not recommended to promote the docker image locally, as we have actions doing it in a convenient way, but if needed following command can be used to promote a Release Candidate image. - Example(jvm):- If you want to promote RC image apache/kafka:3.6.0-rc0 to apache/kafka:3.6.0, following command can be used ``` @@ -226,7 +226,7 @@ image_type: jvm kafka_version: 3.7.0 ``` -- Run the `docker/generate_kafka_pr_template.py` script from trunk, by providing it the image type. Update the existing entry, and raise a new PR in [Docker Hub's Docker Official Repo](https://github.com/docker-library/official-images/tree/master/library/kafka) by using this new PR template. +- Run the `docker/generate_kafka_pr_template.py` script from trunk, by providing it the image type. Update the existing entry, and raise a new PR in [Docker Hub's Docker Official Repo](https://.com/docker-library/official-images/tree/master/library/kafka) by using this new PR template. ``` python generate_kafka_pr_template.py --image-type=jvm