From 878ff9e2bd3eaca421ee296c3d05cd1a786c3773 Mon Sep 17 00:00:00 2001 From: Jiri Pechanec Date: Wed, 16 Oct 2024 13:14:46 +0200 Subject: [PATCH] DBZ-8327 Stop publishing to Docker Hub --- CONTRIBUTING.md | 6 +++--- README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a5057b4116..336bf027720 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,13 +74,13 @@ To build the source code locally, checkout and update the `develop` branch: Then use Docker to run a container that initializes the Jekyll tooling. Start a new terminal, configure it with the Docker environment (if required), and run the following command: - $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site debezium/website-builder setup + $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site quay.io/debezium/website-builder setup *Note:* Some times you may wish to use the `root` user of your linux machine to run docker (as docker needs elevated privileges to run). It's probably a better idea to run docker containers while [running as a user other than root and using sudo](http://www.projectatomic.io/blog/2015/08/why-we-dont-let-non-root-users-run-docker-in-centos-fedora-or-rhel/) or adding the [user to the group that has privileges](https://developer.fedoraproject.org/tools/docker/docker-installation.html) to run docker. When you checkout the code for this project don't clone the source code and try running this command as the `root` user. When you do this, all of the code (and the entire folder) then gets owned by the `root` user. The reason why this is undesirable is when we run `docker run -v $(pwd):/site` we are actually mounting the local file system where the source code lives _into_ the docker container. If this directory is owned by `root`, the image cannot create the necessary directories for running `rake` and `bundle`. This should download all of the Ruby Gems the tooling uses, as defined in the `Gemfile` file. After it completes, run a container using the same image but with a different command: - $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site debezium/website-builder bash + $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site quay.io/debezium/website-builder bash This command will start a container using the `debezium/jekyll` Docker image, first downloading the image if necessary. It also mounts the current directory (where the website code is located) into the container's `/site` directory. @@ -94,7 +94,7 @@ Note: With documentation maintained in the main Debezium code repository you may 1. The docker container must have an additional volume mapped that points to the main Debezium repository that you've checked out locally. In this example, we've checked out the https://github.com/debezium/debezium repository to `~/github/debezium`. So in order to map that directory as a volume on the docker container, you will additionally need to provide the argument `-v ~/github/debezium:/debezium` when starting the container. Below is an example of how it should look: - $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site -v ~/github/debezium:/debezium debezium/website-builder bash + $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site -v ~/github/debezium:/debezium quay.io/debezium/website-builder bash When inside the docker container, you should notice a `/debezium` directory now exists and its contents is that of the checked out repository. In the event you do not see a `/debezium` directory or that its contents are empty or incorrect, please review how you mapped the volume above. diff --git a/README.md b/README.md index c9062baa0dd..20003ca2d67 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ The latter is a bit quicker, but requires Ruby/Jekyll to be set up correctly, wh In a new terminal initialized with the Docker host environment, start a Docker container that has the build environment for our website: - $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site --name website-builder debezium/website-builder bash + $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site --name website-builder quay.io/debezium/website-builder bash -This command tells Docker to start a container using the `debezium/website-builder` image (downloading it if necessary) with an interactive terminal (via `-it` flag) to the container so that you will see the output of the process running in the container. The `--rm` flag will remove the container when it stops, while the `-p 4000` flag maps the container's 4000 port to the same port on the Docker host (which is the local machine on Linux or the virtual machine if running Boot2Docker or Docker Machine on OS X and Windows). The `-v $(pwd):/site` option mounts your current working directory (where the website's code is located) into the `/site` directory within the container. +This command tells Docker to start a container using the `quay.io/debezium/website-builder` image (downloading it if necessary) with an interactive terminal (via `-it` flag) to the container so that you will see the output of the process running in the container. The `--rm` flag will remove the container when it stops, while the `-p 4000` flag maps the container's 4000 port to the same port on the Docker host (which is the local machine on Linux or the virtual machine if running Boot2Docker or Docker Machine on OS X and Windows). The `-v $(pwd):/site` option mounts your current working directory (where the website's code is located) into the `/site` directory within the container. Next, in the shell in the container, run the following commands to update and then (re)install all of the Ruby libraries required by the website: @@ -68,7 +68,7 @@ First, you must have a local clone of the [Debezium repository](https://github.c Then start the Docker container: - $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site -v ~//debezium:/debezium --name website-builder debezium/website-builder bash + $ docker run --privileged -it --rm -p 4000:4000 -e LC_ALL=C.UTF-8 -e LANG=C.UTF-8 -v $(pwd):/site -v ~//debezium:/debezium --name website-builder quay.io/debezium/website-builder bash **Note** the addition of the volume mapping **-v ~//debezium:/debezium** - ( replace with the actual location on your system ).