DBZ-5048 Rename GH repo with containes

Besides updating links to renamed GH repo, update also documentation and
replace 'Docker' with 'containers' when possible.
This commit is contained in:
Vojtech Juranek 2022-06-30 09:51:57 +02:00 committed by Jiri Pechanec
parent 35e3eae52f
commit 5573bb51ed
17 changed files with 44 additions and 44 deletions

View File

@ -204,27 +204,27 @@ Before continuing, using this lower frame of the window to collect the following
#### Validating the staged artifacts
At this time, the best way to verify the staged artifacts are valid is to locally update the [Debezium Docker images](https://github.com/debezium/docker-images) used in the [Debezium tutorial](https://debezium.io/docs/tutorial) to use the latest connector plugins, and then to run through the tutorial using those locally-built Docker images.
At this time, the best way to verify the staged artifacts are valid is to locally update the [Debezium container images](https://github.com/debezium/container-images) used in the [Debezium tutorial](https://debezium.io/docs/tutorial) to use the latest connector plugins, and then to run through the tutorial using those locally-built container images.
This [GitHub repository](https://github.com/debezium/docker-images) containing the Docker images contains separate Dockerfiles for each major and minor release of Debezium. Start by checking out and getting the latest commits from the [Debezium Docker images](https://github.com/debezium/docker-images) repository and creating a topic branch (using an appropriate branch name):
This [GitHub repository](https://github.com/debezium/container-images) with the container images contains separate Dockerfiles for each major and minor release of Debezium. Start by checking out and getting the latest commits from the [Debezium container images](https://github.com/debezium/container-images) repository and creating a topic branch (using an appropriate branch name):
$ git checkout master
$ git pull upstream master
$ git checkout -b <branch-name>
For Debezium patch releases, we simply update the Dockerfiles that correspond to the minor release's parent. For example, when 0.2 was released, we created new Docker images by copying and updating the images from 0.1. However, when 0.2.1 was released, we simply updated the 0.2 Docker images.
For Debezium patch releases, we simply update the Dockerfiles that correspond to the minor release's parent. For example, when 0.2 was released, we created new container images by copying and updating the images from 0.1. However, when 0.2.1 was released, we simply updated the 0.2 container images.
Currently, the only Docker image that contains Debezium code is the [Connect service image](https://github.com/debezium/docker-images/connect), which means this is the only Dockerfile that you will need to change to point to the Maven staging repository. To do this, edit the Dockerfile for the Connect service, and:
Currently, the only container image that contains Debezium code is the [Connect service image](https://github.com/debezium/container-images/connect), which means this is the only Dockerfile that you will need to change to point to the Maven staging repository. To do this, edit the Dockerfile for the Connect service, and:
* change the `DEBEZIUM_VERSION` environment variable value to match the _major.minor.patch_ version number for the release (e.g., `0.2.1`)
* temporarily replace the Maven Central repository URL with that URL of the staging repository created in [Perform the Release](#perform-the-release), which again looks something like `https://oss.sonatype.org/content/repositories/iodebezium-1002`.
* update the MD5 literal string used to check the `...-plugin.tar.gz` file
After all of the Docker files have been created or updated, go to the top of your local Git repository and run the following command to build the Docker images:
After all of the Docker files have been created or updated, go to the top of your local Git repository and run the following command to build the container images:
$ ./build-debezium.sh 0.2
or using the correct Debezium version. After this successfully builds the images, run through the tutorial, being sure to use the same Docker image label (e.g., `0.2`) that you just built.
or using the correct Debezium version. After this successfully builds the images, run through the tutorial, being sure to use the same container image label (e.g., `0.2`) that you just built.
When the tutorial can be successfully run with the new version, edit the Dockerfile for the Connect service to again use the official Maven Central repository URL.
@ -232,21 +232,21 @@ It is also necessary to update the Connect snapshot(nightly) image with a new de
Now you can commit the changes locally
$ git commit -m "Updated Docker images for release 0.2.1" .
$ git commit -m "Updated container images for release 0.2.1" .
$ git push origin <branch-name>
and create a new pull request (or if rerunning the release process update your existing pull request), but do not merge the pull request yet.
If you discover any problems, log issues for the problems and fix them in the code base. Then start this process over from the beginning (though you can force-update the changes to your still-unmerged pull request for the Docker images.
If you discover any problems, log issues for the problems and fix them in the code base. Then start this process over from the beginning (though you can force-update the changes to your still-unmerged pull request for the container images.
#### Updating the Java version
If you need to update the base Docker image for the JDK to use a different JDK version, then:
If you need to update the base container image for the JDK to use a different JDK version, then:
1. create a new folder under `jdk8` for the new Java versoin by copying the folder for the most recent existing JDK version,
2. edit the Dockerfile to use the specific version of the JDK and save the file,
3. run the `./build-java.sh` script to locally build the new `debezium/jdk:<version>` Docker image,
4. update all of the Docker images for Zookeeper, Kafka, and Debezium services to use the new base image,
3. run the `./build-java.sh` script to locally build the new `debezium/jdk:<version>` container image,
4. update all of the container images for Zookeeper, Kafka, and Debezium services to use the new base image,
5. re-run the `./build-debezium.sh <version>` command to make sure everything builds,
6. commit the changes locally and add to your still-unmerged pull request.
@ -260,23 +260,23 @@ Select the staging repository (by checking the box) and press the "Release" butt
It may take some time for the artifacts to actually be [visible in Maven Central search](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.debezium%22) or [directly in Maven Central](https://repo1.maven.org/maven2/io/debezium/debezium-core/).
### Merge your pull request to update the Docker images
### Merge your pull request to update the container images
Only after the artifacts are available on Maven Central can you merge the pull request for the Debezium Docker images. As soon as your changes are merged, Docker Hub will automatically build and deploy the Docker images that were previously configured. If you've just released a patch release and only updated existing Docker images, then you can proceed to [updating the documentation and blog](#update-the-documentation-and-blog).
Only after the artifacts are available on Maven Central can you merge the pull request for the Debezium container images. As soon as your changes are merged, Docker Hub will automatically build and deploy the container images that were previously configured. If you've just released a patch release and only updated existing container images, then you can proceed to [updating the documentation and blog](#update-the-documentation-and-blog).
Otherwise, for major and minor releases your pull request should have added new Docker images, and you need to log into [Debezium's Docker Hub organization](https://hub.docker.com/r/debezium/) and add/update the build settings for each of the affected images.
Otherwise, for major and minor releases your pull request should have added new container images, and you need to log into [Debezium's Docker Hub organization](https://hub.docker.com/r/debezium/) and add/update the build settings for each of the affected images.
With every release the Docker image for PostgreSQL needs to be updated as well.
With every release the container image for PostgreSQL needs to be updated as well.
First create a tag in the [postgres-decoderbufs](https://github.com/debezium/postgres-decoderbufs) repository:
$ git tag v<%version%> && git push upstream v<%version%>
Then update the Debezium version referenced in the [Postgres Docker file](https://github.com/debezium/docker-images/blob/main/postgres/9.6/Dockerfile#L22)
Then update the Debezium version referenced in the [Postgres Docker file](https://github.com/debezium/container-images/blob/main/postgres/9.6/Dockerfile#L22)
and push that commit which will cause the image to be re-published on Docker Hub automatically.
### Reconfigure Docker Hub builds
If a new version of Docker images is going to be added it is necessary in Docker Hub build settings to
If a new version of container images is going to be added it is necessary in Docker Hub build settings to
* add a new build for each image with new version
* remove builds for obsolete versions

View File

@ -1,4 +1,4 @@
This module uses the [debezium/postgres:9.6](https://github.com/debezium/docker-images/tree/main/postgres/9.6) Docker image maintained by the Debezium team. This image uses a default PostgreSQL 9.6 image on top of which it installs the [Debezium Logical Decoding plugin](https://github.com/debezium/postgres-decoderbufs) which is required in order to be able to receive database events.
This module uses the [debezium/postgres:9.6](https://github.com/debezium/container-images/tree/main/postgres/9.6) Docker image maintained by the Debezium team. This image uses a default PostgreSQL 9.6 image on top of which it installs the [Debezium Logical Decoding plugin](https://github.com/debezium/postgres-decoderbufs) which is required in order to be able to receive database events.
## Using the PostgreSQL Server
@ -18,4 +18,4 @@ Although using the Maven command is far simpler, the Maven command really just r
$ docker run -it -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres debezium/postgres:9.6 postgres
This will use the `debezium/postgres:9.6` image to start a new container where the PostgreSQL instance uses the settings from [the docker image](https://github.com/debezium/docker-images/blob/main/postgres/9.6/postgresql.conf.sample)
This will use the `debezium/postgres:9.6` image to start a new container where the PostgreSQL instance uses the settings from [the docker image](https://github.com/debezium/container-images/blob/main/postgres/9.6/postgresql.conf.sample)

View File

@ -19,7 +19,7 @@ This module contains both unit tests and integration tests.
A *unit test* is a JUnit test class named `*Test.java` or `Test*.java` that never requires or uses external services, though it can use the file system and can run any components within the same JVM process. They should run very quickly, be independent of each other, and clean up after itself.
An *integration test* is a JUnit test class named `*IT.java` or `IT*.java` that uses a PostgreSQL database server running in a custom Docker container based upon the [debezium/postgres:9.6](https://github.com/debezium/docker-images/tree/main/postgres/9.6) Docker image maintained by the Debezium team.
An *integration test* is a JUnit test class named `*IT.java` or `IT*.java` that uses a PostgreSQL database server running in a custom Docker container based upon the [debezium/postgres:9.6](https://github.com/debezium/container-images/tree/main/postgres/9.6) Docker image maintained by the Debezium team.
This docker image uses a default PostgreSQL 9.6 image on top of which it installs the [Debezium Logical Decoding plugin](https://github.com/debezium/postgres-decoderbufs) which is required in order to be able to receive database events.
The build will automatically start the PostgreSQL container before the integration tests are run and automatically stop and remove it after all of the integration tests complete (regardless of whether they succeed or fail).

View File

@ -2054,7 +2054,7 @@ The PostgreSQL connector works with one of {prodname}'s supported logical decodi
The `pgoutput` plugin comes out-of-the-box with the PostgreSQL database.
For more details on using Protobuf via the `decoderbufs` plug-in, see the plug-in link:https://github.com/debezium/postgres-decoderbufs/blob/main/README.md[`documentation`] which discusses its requirements, limitations, and how to compile it.
For simplicity, {prodname} also provides a container image based on the upstream PostgreSQL server image, on top of which it compiles and installs the plug-ins. You can link:https://github.com/debezium/docker-images/tree/main/postgres/13[use this image] as an example of the detailed steps required for the installation.
For simplicity, {prodname} also provides a container image based on the upstream PostgreSQL server image, on top of which it compiles and installs the plug-ins. You can link:https://github.com/debezium/container-images/tree/main/postgres/13[use this image] as an example of the detailed steps required for the installation.
[WARNING]
====

View File

@ -47,7 +47,7 @@ to encode the changes in either https://github.com/google/protobuf[Protobuf] for
[TIP]
====
For simplicity, {prodname} also provides a container image based on a vanilla https://github.com/debezium/docker-images/tree/main/postgres/14[PostgreSQL server image]
For simplicity, {prodname} also provides a container image based on a vanilla https://github.com/debezium/container-images/tree/main/postgres/14[PostgreSQL server image]
on top of which it compiles and installs the plug-ins.
====
@ -76,7 +76,7 @@ At the current installation example, the https://github.com/debezium/postgres-de
The decoderbufs output plug-in produces a Protobuf message per database change.
Each message contains new/old tuples for an updated table row..
The plug-in *compilation and installation* is performed by executing the related commands extracted from the
https://github.com/debezium/docker-images/blob/main/postgres/14/Dockerfile[{prodname} Dockerfile].
https://github.com/debezium/container-images/blob/main/postgres/14/Dockerfile[{prodname} Dockerfile].
Before executing the commands, make sure that the user has the privileges to write the `decoderbufs` library at the PostgreSQL `_lib_`
directory (at the test environment, the directory is: `/usr/lib64/pgsql/`).
@ -153,7 +153,7 @@ Once the *decoderbufs* plug-in has been installed, the database server should be
Add the following lines at the end of the `postgresql.conf` PostgreSQL configuration file in order to include the plug-in
at the shared libraries and to adjust some https://www.postgresql.org/docs/14/runtime-config-wal.html[WAL]
and https://www.postgresql.org/docs/14/runtime-config-replication.html[streaming replication] settings.
The configuration is extracted from https://github.com/debezium/docker-images/blob/main/postgres/14/postgresql.conf.sample[postgresql.conf.sample].
The configuration is extracted from https://github.com/debezium/container-images/blob/main/postgres/14/postgresql.conf.sample[postgresql.conf.sample].
You may need to modify it, if for example you have additionally installed `shared_preload_libraries`.
.*_postgresql.conf_* _, configuration file parameters settings_

View File

@ -36,5 +36,5 @@ By means of xref:transformations/applying-transformations-selectively.adoc[SMT P
[NOTE]
====
Most of the above SMTs are available by default with the {prodname} container image, but you need to opt-in for the scripting-based ones (Message Filtering or Content-based Routing). See the link:https://github.com/debezium/docker-images/tree/main/connect/1.7#enable_debezium_scripting[README] file of the container image for more details.
Most of the above SMTs are available by default with the {prodname} container image, but you need to opt-in for the scripting-based ones (Message Filtering or Content-based Routing). See the link:https://github.com/debezium/container-images/tree/main/connect/1.7#enable_debezium_scripting[README] file of the container image for more details.
====

View File

@ -15,7 +15,7 @@ In this procedure, you will start a MySQL server with an example database.
. Open a new terminal, and use it to start a new container that runs a MySQL database server preconfigured with an `inventory` database.
+
--
This command runs a new container using version {debezium-docker-label} of the `quay.io/debezium/example-mysql` image, which is https://github.com/debezium/docker-images/blob/main/examples/mysql/{debezium-docker-label}/Dockerfile[based on] the https://hub.docker.com/r/_/mysql/[mysql:8.0] image.
This command runs a new container using version {debezium-docker-label} of the `quay.io/debezium/example-mysql` image, which is https://github.com/debezium/container-images/blob/main/examples/mysql/{debezium-docker-label}/Dockerfile[based on] the https://hub.docker.com/r/_/mysql/[mysql:8.0] image.
It also defines and populates a sample `inventory` database:
[source,shell,options="nowrap",subs="attributes"]

View File

@ -20,7 +20,7 @@ CONTRIBUTORS_FILTERS="$DIR/FilteredNames.txt"
cp $ALIASES $FILTERS $DIR && cd $DIR
declare -a DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "docker-images")
declare -a DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "container-images")
for REPO in "${DEBEZIUM_REPOS[@]}";
do

View File

@ -60,7 +60,7 @@ function handleGitHistoryCommitMessageIssueKeys {
}
# Repositories to check for existence of commits
declare -a DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "docker-images")
declare -a DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "container-images")
# Obtain all issue keys that are part of the fixed version
echo "Getting issues from Jira for project $PROJECT_NAME and version $FIX_VERSION"

View File

@ -73,8 +73,8 @@ COPY metrics.yaml $KAFKA_HOME/config
# Download kafka and kafka-connect start scripts
#
RUN mkdir /scripts
RUN curl -L https://raw.githubusercontent.com/debezium/docker-images/main/kafka/${DEBEZIUM_VERSION}/docker-entrypoint.sh -o /scripts/kafka-start.sh
RUN curl -L https://raw.githubusercontent.com/debezium/docker-images/main/connect-base/${DEBEZIUM_VERSION}/docker-entrypoint.sh -o /scripts/kafka-connect-start.sh
RUN curl -L https://raw.githubusercontent.com/debezium/container-images/main/kafka/${DEBEZIUM_VERSION}/docker-entrypoint.sh -o /scripts/kafka-start.sh
RUN curl -L https://raw.githubusercontent.com/debezium/container-images/main/connect-base/${DEBEZIUM_VERSION}/docker-entrypoint.sh -o /scripts/kafka-connect-start.sh
#

View File

@ -3,7 +3,7 @@ pipelineJob('release-deploy-debezium-tool-images') {
description('Build and deploy debezium tool images to the registry')
properties {
githubProjectUrl('https://github.com/debezium/docker-images')
githubProjectUrl('https://github.com/debezium/container-images')
}
logRotator {
@ -17,7 +17,7 @@ pipelineJob('release-deploy-debezium-tool-images') {
parameters {
stringParam('MAIL_TO', 'jpechane@redhat.com')
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/docker-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/container-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_BRANCH', 'main', 'Branch used for images repository')
stringParam('TAG', 'latest', 'Tag used for building images')
}

View File

@ -1,9 +1,9 @@
pipelineJob('release-deploy-docker-images') {
displayName('Debezium Deploy Docker Images')
description('Build and deploy Docker images to the registry')
pipelineJob('release-deploy-container-images') {
displayName('Debezium Deploy Container Images')
description('Build and deploy Container images to the registry')
properties {
githubProjectUrl('https://github.com/debezium/docker-images')
githubProjectUrl('https://github.com/debezium/container-images')
}
logRotator {
@ -18,7 +18,7 @@ pipelineJob('release-deploy-docker-images') {
parameters {
stringParam('MAIL_TO', 'jpechane@redhat.com')
stringParam('DEBEZIUM_REPOSITORY', 'debezium/debezium', 'Repository from which Debezium is built')
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/docker-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/container-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_BRANCH', 'main', 'Branch used for images repository')
stringParam('STREAMS_TO_BUILD_COUNT', '2', 'How many most recent streams should be built')
stringParam('TAGS_PER_STREAM_COUNT', '1', 'How any most recent tags per stream should be built')

View File

@ -7,7 +7,7 @@ freeStyleJob('release-debezium-nightly-image') {
label('Slave')
properties {
githubProjectUrl('https://github.com/debezium/docker-images')
githubProjectUrl('https://github.com/debezium/container-images')
}
logRotator {
@ -38,7 +38,7 @@ freeStyleJob('release-debezium-nightly-image') {
parameters {
stringParam('DEBEZIUM_REPOSITORY', 'debezium/debezium', 'Repository from which Debezium is built')
stringParam('DEBEZIUM_BRANCH', 'main', 'Branch used to build Debezium')
stringParam('IMAGES_REPOSITORY', 'https://github.com/debezium/docker-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_REPOSITORY', 'https://github.com/debezium/container-images.git', 'Repository with Debezium Dockerfiles')
stringParam('IMAGES_BRANCH', 'main', 'Branch used for images repository')
}

View File

@ -21,7 +21,7 @@ pipelineJob('release-debezium-upstream') {
'db2#github.com/debezium/debezium-connector-db2.git#main vitess#github.com/debezium/debezium-connector-vitess.git#main cassandra#github.com/debezium/debezium-connector-cassandra.git#main',
'A space separated list of additional repositories from which Debezium incubating components are built (id#repo#branch)'
)
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/docker-images.git', 'Repository from which Debezium images are built')
stringParam('IMAGES_REPOSITORY', 'github.com/debezium/container-images.git', 'Repository from which Debezium images are built')
stringParam('IMAGES_BRANCH', 'main', 'A branch from which Debezium images are built')
stringParam('POSTGRES_DECODER_REPOSITORY', 'github.com/debezium/postgres-decoderbufs.git', 'Repository from which PostgreSQL decoder plugin is built')
stringParam('POSTGRES_DECODER_BRANCH', 'main', 'A branch from which Debezium images are built PostgreSQL decoder plugin is built')

View File

@ -677,7 +677,7 @@ node('Slave') {
if (!DRY_RUN) {
withCredentials([usernamePassword(credentialsId: GIT_CREDENTIALS_ID, passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME')]) {
sh """
git commit -a -m "Updated Docker images for release $RELEASE_VERSION" && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${
git commit -a -m "Updated container images for release $RELEASE_VERSION" && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${
IMAGES_REPOSITORY
} HEAD:$IMAGES_BRANCH
git tag $VERSION_TAG && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${IMAGES_REPOSITORY} $VERSION_TAG

View File

@ -10,7 +10,7 @@ ALIASES="jenkins-jobs/scripts/config/Aliases.txt"
declare -a DEBEZIUM_REPOS
if [ $# -eq 0 ];then
DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "docker-images")
DEBEZIUM_REPOS=("debezium" "debezium-connector-db2" "debezium-connector-cassandra" "debezium-connector-vitess" "container-images")
else
DEBEZIUM_REPOS=( "$@" )
fi

View File

@ -560,7 +560,7 @@ node('Slave') {
if (!DRY_RUN) {
withCredentials([usernamePassword(credentialsId: GIT_CREDENTIALS_ID, passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME')]) {
sh """
git commit -a -m "Updated Docker images for release $RELEASE_VERSION" && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${IMAGES_REPOSITORY} HEAD:$IMAGES_BRANCH
git commit -a -m "Updated container images for release $RELEASE_VERSION" && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${IMAGES_REPOSITORY} HEAD:$IMAGES_BRANCH
git tag $VERSION_TAG && git push https://\${GIT_USERNAME}:\${GIT_PASSWORD}@${IMAGES_REPOSITORY} $VERSION_TAG
"""
}