split Docker resources for Cassandra to v3 and v4 (#359)

* added default config into examples

* bump commons to 1.2.1 and backup to 1.5.1 in sidecar

* modified cassandra docker scripts to be able to handle installation of any Cassandra deb

Author: smiklosovic

.gitignore

@@ -26,3 +26,7 @@ vendor/
 /helm/cassandra-*.tgz
 /helm/cassandra-operator-*.tgz
 /helm/index.yaml
+/docker/cassandra/cassandra-3/debs/*
+/docker/cassandra/cassandra-4/debs/*
+/docker/cassandra/cassandra-3/jars/*
+/docker/cassandra/cassandra-4/jars/*

README.md

@@ -33,7 +33,7 @@ We are currently building images for Cassandra 3.11.6 and 4.0-alpha3.
 ## Requirements
 
 - Kubernetes 1.13+
-- Helm 2 (if you want to use the included helm charts)
+- Helm 3 (if you want to use the included helm charts)
 
 ## Limitations
 

docker/Makefile

@@ -1,4 +1,4 @@
-IMAGES = base-openjre base-openjre-11 cassandra cassandra-4 cassandra-sidecar cassandra-operator
+IMAGES = base-openjre base-openjre-11 cassandra-3 cassandra-4 cassandra-sidecar cassandra-operator
 BUILD_IMAGES = circle-build-env
 
 C_IMAGE_VERSION := $(if $(C_IMAGE_VERSION),$(C_IMAGE_VERSION),"1.0.0")
@@ -21,12 +21,16 @@ $(BUILD_IMAGES):
 base-openjre-11:
 	DEBIAN_RELEASE=buster OPENJRE_BASE_IMAGE=debian:buster OPENJRE_VERSION=11.0.6+10-1~deb10u1 OPENJRE_IMAGE_TAG=buster-11.0.6-10-1-deb10u1 OPENJDK_PACKAGE=openjdk-11-jre-headless CASSANDRA_IMAGE_VERSION=${C_IMAGE_VERSION} $(MAKE) -C base-openjre
 
+.PHONY: cassandra-3
+cassandra-3:
+	$(MAKE) -C cassandra cassandra-3
+
 .PHONY: cassandra-4
 cassandra-4:
-	INSTALL_CASSANDRA_EXPORTER=false CASSANDRA_VERSION=4.0~alpha3 OPENJRE_IMAGE=base-openjre:buster-11.0.6-10-1-deb10u1 CASSANDRA_K8S_ADDONS_VERSION=1.0.1 CASSANDRA_K8S_ADDONS_ARTIFACT=cassandra-4-k8s-addons CASSANDRA_IMAGE_VERSION=${C_IMAGE_VERSION} $(MAKE) -C cassandra
+	$(MAKE) -C cassandra cassandra-4
 
 cassandra-4: base-openjre-11
 
-cassandra cassandra-sidecar cassandra-operator: base-openjre
+cassandra-3 cassandra-sidecar cassandra-operator: base-openjre
 
 .DEFAULT_GOAL := all

docker/cassandra-sidecar/Makefile

@@ -1,6 +1,6 @@
 include ../base-openjre/Makefile
 
-CASSANDRA_SIDECAR_VERSION := 1.4.0
+CASSANDRA_SIDECAR_VERSION := 1.5.0
 CASSANDRA_SIDECAR_JAR := cassandra-k8s-sidecar-$(CASSANDRA_SIDECAR_VERSION).jar
 
 ifeq ($(CASSANDRA_SIDECAR_VERSION:%-SNAPSHOT=SNAPSHOT),SNAPSHOT)

docker/cassandra/Dockerfile

@@ -2,18 +2,20 @@ ARG openjre_image
 
 FROM ${openjre_image}
 
+ARG cassandra_major_version=3
 ARG cassandra_version=3.11.6
 ARG cassandra_exporter_version=0.9.10
 ARG cassandra_k8s_addons_jar
 ARG cassandra_k8s_addons_core_jar
 ARG apache_mirror_url=https://dl.bintray.com/apache/cassandra/pool/main/c/cassandra
 ARG install_cassandra_exporter=true
 
-COPY install-cassandra /tmp/install-cassandra
+COPY cassandra-${cassandra_major_version}/install-cassandra.sh /tmp/install-cassandra.sh
+COPY cassandra-${cassandra_major_version}/debs /tmp
 
 RUN C_APACHE_MIRROR_URL=${apache_mirror_url} \
     INSTALL_CASSANDRA_EXPORTER=${install_cassandra_exporter} \
-    /tmp/install-cassandra ${cassandra_version} ${cassandra_exporter_version}
+    /tmp/install-cassandra.sh ${cassandra_version} ${cassandra_exporter_version}
 
 COPY entry-point /usr/bin/entry-point
 COPY wrapper /usr/bin/wrapper
@@ -24,15 +26,13 @@ RUN cp /bin/bash /bin/bash-mod \
     && setcap cap_ipc_lock=+ep /bin/bash-mod \
     && setcap cap_sys_resource=+ep /bin/bash-mod
 
-COPY cassandra /usr/sbin/cassandra
-COPY nodetool /usr/bin/nodetool
-COPY cassandra.in.sh /usr/share/cassandra/
-COPY cql-readiness-probe /usr/bin/cql-readiness-probe
+COPY cassandra-${cassandra_major_version}/cassandra /usr/sbin/cassandra
+COPY cassandra-${cassandra_major_version}/nodetool /usr/bin/nodetool
+COPY cassandra-${cassandra_major_version}/cassandra.in.sh /usr/share/cassandra/
+COPY cassandra-${cassandra_major_version}/cql-readiness-probe /usr/bin/cql-readiness-probe
+COPY cassandra-${cassandra_major_version}/jars /usr/share/cassandra/lib
 
-COPY ${cassandra_k8s_addons_jar} /usr/share/cassandra/lib
-COPY ${cassandra_k8s_addons_core_jar} /usr/share/cassandra/lib
-
-ADD default-config /etc/cassandra
+ADD cassandra-${cassandra_major_version}/default-config /etc/cassandra
 RUN chown -R cassandra:cassandra /etc/cassandra
 
 VOLUME /var/lib/cassandra
@@ -48,7 +48,7 @@ EXPOSE 7000 7001 7199 9042 9160
 # Run as user 'cassandra'
 # A numeric UID is used for PSP support:
 # https://kubernetes.io/docs/concepts/policy/pod-security-policy/#users-and-groups
-# The user is created in ./install-cassandra
+# The user is created in ./install-cassandra.sh
 USER 999
 
 ENTRYPOINT ["/usr/bin/wrapper"]

docker/cassandra/Makefile

@@ -1,47 +1,49 @@
-OPENJRE_IMAGE := $(if $(OPENJRE_IMAGE),$(OPENJRE_IMAGE),"base-openjre:stretch-8u232-b09-1-deb9u1")
-CASSANDRA_IMAGE_VERSION := $(if $(CASSANDRA_IMAGE_VERSION),$(CASSANDRA_IMAGE_VERSION),"1.0.0")
-CASSANDRA_VERSION := $(if $(CASSANDRA_VERSION),$(CASSANDRA_VERSION),"3.11.6")
-CASSANDRA_VERSION_IMAGE_TAG := $(if $(CASSANDRA_VERSION),$(subst ~,-,$(CASSANDRA_VERSION)),"3.11.6")
-CASSANDRA_EXPORTER_VERSION := $(if $(CASSANDRA_EXPORTER_VERSION),$(CASSANDRA_EXPORTER_VERSION),"0.9.10")
-CASSANDRA_K8S_ADDONS_VERSION := $(if $(CASSANDRA_K8S_ADDONS_VERSION),$(CASSANDRA_K8S_ADDONS_VERSION),"1.0.2")
-CASSANDRA_K8S_ADDONS_CORE_VERSION := 1.0.1
-CASSANDRA_ADDONS := $(if $(CASSANDRA_K8S_ADDONS_ARTIFACT),$(CASSANDRA_K8S_ADDONS_ARTIFACT),"cassandra-3-k8s-addons")
-CASSANDRA_K8S_ADDONS_JAR := $(CASSANDRA_ADDONS)-$(CASSANDRA_K8S_ADDONS_VERSION).jar
-CASSANDRA_K8S_ADDONS_CORE_JAR := cassandra-k8s-addons-$(CASSANDRA_K8S_ADDONS_CORE_VERSION).jar
+CASSANDRA_3_OPENJRE_IMAGE := $(if $(OPENJRE_IMAGE),$(OPENJRE_IMAGE),"base-openjre:stretch-8u232-b09-1-deb9u1")
+CASSANDRA_3_VERSION := $(if $(CASSANDRA_VERSION),$(CASSANDRA_VERSION),"3.11.6")
+CASSANDRA_3_VERSION_IMAGE_TAG := $(if $(CASSANDRA_VERSION),$(subst ~,-,$(CASSANDRA_VERSION)),"3.11.6")
 
-ifeq ($(CASSANDRA_K8S_ADDONS_VERSION:%-SNAPSHOT=SNAPSHOT),SNAPSHOT)
-$(info SNAPSHOT version specified. Marking JAR target as .PHONY)
-.PHONY: $(CASSANDRA_K8S_ADDONS_JAR)
-endif
+CASSANDRA_4_OPENJRE_IMAGE := $(if $(CASSANDRA_4_OPENJRE_IMAGE),$(CASSANDRA_4_OPENJRE_IMAGE),"base-openjre:buster-11.0.6-10-1-deb10u1")
+CASSANDRA_4_VERSION=$(if $(CASSANDRA_VERSION),$(CASSANDRA_VERSION),"4.0~alpha3")
+CASSANDRA_4_VERSION_IMAGE_TAG := $(if $(CASSANDRA_4_VERSION),$(subst ~,-,$(CASSANDRA_4_VERSION)),"4.0~alpha3")
 
-$(CASSANDRA_K8S_ADDONS_JAR):
-	rm -rf $(CASSANDRA_K8S_ADDONS_JAR)
-	mvn dependency:copy -Dartifact=com.instaclustr:$(CASSANDRA_ADDONS):$(CASSANDRA_K8S_ADDONS_VERSION) -DoutputDirectory=. -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
+CASSANDRA_EXPORTER_VERSION := $(if $(CASSANDRA_EXPORTER_VERSION),$(CASSANDRA_EXPORTER_VERSION),"0.9.10")
+CASSANDRA_K8S_ADDONS_VERSION := $(if $(CASSANDRA_K8S_ADDONS_VERSION),$(CASSANDRA_K8S_ADDONS_VERSION),"1.0.2")
 
-$(CASSANDRA_K8S_ADDONS_CORE_JAR):
-	rm -rf $(CASSANDRA_K8S_ADDONS_CORE_JAR)
-	mvn dependency:copy -Dartifact=com.instaclustr:cassandra-k8s-addons:$(CASSANDRA_K8S_ADDONS_CORE_VERSION) -DoutputDirectory=. -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
+CASSANDRA_IMAGE_VERSION := $(if $(CASSANDRA_IMAGE_VERSION),$(CASSANDRA_IMAGE_VERSION),"1.0.0")
 
 C_APACHE_MIRROR_URL := $(if $(C_APACHE_MIRROR_URL),$(C_APACHE_MIRROR_URL),"https://dl.bintray.com/apache/cassandra/pool/main/c/cassandra")
-INSTALL_CASSANDRA_EXPORTER := $(if $(INSTALL_CASSANDRA_EXPORTER),$(INSTALL_CASSANDRA_EXPORTER),"true")
 
-.PHONY: cassandra
-cassandra: $(CASSANDRA_K8S_ADDONS_JAR) $(CASSANDRA_K8S_ADDONS_CORE_JAR)
-	@echo \"$(OPENJRE_IMAGE)\"
+.PHONY: cassandra-3
+cassandra-3:
+	rm -rf cassandra-3/jars
+	mvn dependency:copy -Dartifact=com.instaclustr:cassandra-3-k8s-addons:1.0.2 -DoutputDirectory=cassandra-3/jars -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
+	mvn dependency:copy -Dartifact=com.instaclustr:cassandra-k8s-addons:1.0.1 -DoutputDirectory=cassandra-3/jars -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
 	docker build \
-		--build-arg cassandra_version=$(CASSANDRA_VERSION) \
+        --build-arg cassandra_major_version=3 \
+		--build-arg cassandra_version=$(CASSANDRA_3_VERSION) \
+		--build-arg openjre_image="$(CASSANDRA_3_OPENJRE_IMAGE)" \
+		--build-arg apache_mirror_url="$(C_APACHE_MIRROR_URL)" \
+		--build-arg install_cassandra_exporter=true \
 		--build-arg cassandra_exporter_version=$(CASSANDRA_EXPORTER_VERSION) \
-		--build-arg cassandra_k8s_addons_core_jar=$(CASSANDRA_K8S_ADDONS_CORE_JAR) \
-		--build-arg cassandra_k8s_addons_jar=$(CASSANDRA_K8S_ADDONS_JAR) \
-		--build-arg openjre_image="$(OPENJRE_IMAGE)" \
+		-t $(DOCKER_REGISTRY)cassandra-${CASSANDRA_3_VERSION_IMAGE_TAG} \
+		-t $(DOCKER_REGISTRY)cassandra-${CASSANDRA_3_VERSION_IMAGE_TAG}:$(CASSANDRA_IMAGE_VERSION) \
+		.
+
+.PHONY: cassandra-4
+cassandra-4:
+	rm -rf cassandra-4/jars
+	mvn dependency:copy -Dartifact=com.instaclustr:cassandra-4-k8s-addons:1.0.1 -DoutputDirectory=cassandra-4/jars -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
+	mvn dependency:copy -Dartifact=com.instaclustr:cassandra-k8s-addons:1.0.1 -DoutputDirectory=cassandra-4/jars -Dmdep.stripClassifier=true -Dmdep.overIfNewer=true
+	docker build \
+	    --build-arg cassandra_major_version=4 \
+		--build-arg cassandra_version=${CASSANDRA_4_VERSION} \
+		--build-arg openjre_image="$(CASSANDRA_4_OPENJRE_IMAGE)" \
 		--build-arg apache_mirror_url="$(C_APACHE_MIRROR_URL)" \
-		--build-arg install_cassandra_exporter="$(INSTALL_CASSANDRA_EXPORTER)" \
-		-t $(DOCKER_REGISTRY)cassandra-$(CASSANDRA_VERSION_IMAGE_TAG) \
-		-t $(DOCKER_REGISTRY)cassandra-$(CASSANDRA_VERSION_IMAGE_TAG):$(CASSANDRA_IMAGE_VERSION) \
+		--build-arg install_cassandra_exporter=false \
+		-t $(DOCKER_REGISTRY)cassandra-${CASSANDRA_4_VERSION_IMAGE_TAG} \
+		-t $(DOCKER_REGISTRY)cassandra-${CASSANDRA_4_VERSION_IMAGE_TAG}:$(CASSANDRA_IMAGE_VERSION) \
 		.
 
 .PHONY: clean
 clean:
 	rm $(CASSANDRA_K8S_ADDONS_JAR)
-
-.DEFAULT_GOAL := cassandra

docker/cassandra/cassandra docker/cassandra/cassandra-3/cassandra

@@ -20,19 +20,12 @@ JVM_OPTS="${JVM_OPTS} -Djava.library.path=${CASSANDRA_HOME}/lib/sigar-bin"
 # heap dumps to tmp
 JVM_OPTS="${JVM_OPTS} -XX:HeapDumpPath=/var/tmp/cassandra-`date +%s`-pid$$.hprof"
 
-# determine Java version, the assumption here is that C* 4.x runs with Java 11 and C* 3.11.x runs wih Java 8
-
 # read additional JVM options from jvm.options files
 for options_file in "${CASSANDRA_CONF}/jvm-operator.options" "${CASSANDRA_CONF}/jvm-jmx.options" "${CASSANDRA_CONF}/jvm.options" "${CASSANDRA_CONF}/jvm.options.d"/*.options
 do
     JVM_OPTS="${JVM_OPTS} "$((sed -ne "/^-/p" | tr '\n' ' ') < "${options_file}")
 done
 
-# Cassandra 4 runs on Java 11 so we need to add specific flags to JVM
-if [ "$(grep -c "^4" /usr/share/cassandra/cassandra_version)" = "1" ]; then
-  JVM_OPTS="${JVM_OPTS} "$((sed -ne "/^-/p" | tr '\n' ' ') < "${CASSANDRA_CONF}/jvm11-server.options")
-fi
-
 # source additional environment settings
 for env_file in "${CASSANDRA_CONF}/cassandra-env.sh" "${CASSANDRA_CONF}/cassandra-env.sh.d"/*.sh
 do

docker/cassandra/cassandra.in.sh docker/cassandra/cassandra-3/cassandra.in.sh

@@ -1,3 +1,4 @@
 CASSANDRA_CONF=/etc/cassandra
 CASSANDRA_HOME=/usr/share/cassandra
-CASSANDRA_CLASSPATH="${CASSANDRA_CONF}:${CASSANDRA_HOME}/*:${CASSANDRA_HOME}/lib/*"
+CASSANDRA_CLASSPATH="${CASSANDRA_CONF}:${CASSANDRA_HOME}/*:${CASSANDRA_HOME}/lib/*"
+CLASSPATH=${CASSANDRA_CLASSPATH}

docker/cassandra/cql-readiness-probe docker/cassandra/cassandra-3/cql-readiness-probe

@@ -0,0 +1,34 @@
+<!--
+ 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.
+-->
+
+<configuration>
+    <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
+        <target>System.err</target>
+        <encoder>
+            <pattern>%-5level %date{"HH:mm:ss,SSS"} %msg%n</pattern>
+        </encoder>
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>WARN</level>
+        </filter>
+    </appender>
+
+    <root level="WARN">
+        <appender-ref ref="STDERR" />
+    </root>
+</configuration>

docker/cassandra/default-config/cassandra-env.sh.d/.gitkeep docker/cassandra/cassandra-3/debs/empty

@@ -14,15 +14,20 @@ arch_pkg_dir="${pkg_dir}/${arch}" && mkdir "${arch_pkg_dir}"
 C_APACHE_MIRROR_URL="${C_APACHE_MIRROR_URL:-https://dl.bintray.com/apache/cassandra/pool/main/c/cassandra}"
 INSTALL_CASSANDRA_EXPORTER="${INSTALL_CASSANDRA_EXPORTER:-true}"
 
-# download the C* packages
-(cd "${arch_pkg_dir}" &&
-    curl -SLO "${C_APACHE_MIRROR_URL}/cassandra_${cassandra_version}_all.deb" &&
-    curl -SLO "${C_APACHE_MIRROR_URL}/cassandra-tools_${cassandra_version}_all.deb")
+if [ "$(find /tmp -type f -name '*.deb' | wc -l)" != "0" ]; then
+  mv /tmp/cassandra*.deb ${arch_pkg_dir}
+else
+  # download the C* packages
+  (cd "${arch_pkg_dir}" &&
+      curl -SLO "${C_APACHE_MIRROR_URL}/cassandra_${cassandra_version}_all.deb" &&
+      curl -SLO "${C_APACHE_MIRROR_URL}/cassandra-tools_${cassandra_version}_all.deb")
+fi
 
 dagi dpkg-dev cpio libcap2-bin dnsutils
 
 APT_GET_OPTS="--allow-unauthenticated" dagi file ${arch_pkg_dir}/cassandra_${cassandra_version}_all.deb
 APT_GET_OPTS="--allow-unauthenticated" dagi file ${arch_pkg_dir}/cassandra-tools_${cassandra_version}_all.deb
+APT_GET_OPTS="--allow-unauthenticated" dagi vim
 
 # package "cleanup"
 mkdir /usr/share/cassandra/agents
@@ -31,9 +36,6 @@ mv /usr/share/cassandra/lib/jamm-*.jar /usr/share/cassandra/agents/jamm.jar
 cp /etc/cassandra/hotspot_compiler /usr/share/cassandra/
 cp /etc/cassandra/cassandra.yaml /usr/share/cassandra/
 
-# save Cassandra version, handy for further configuration which is version specific
-echo ${cassandra_version} > /usr/share/cassandra/cassandra_version
-
 # nuke contents of /etc/cassandra and /var/lib/cassandra since they're injected by volume mounts
 rm -rf /etc/cassandra/* /var/lib/cassandra/*